fix: allow the usage of environment variables

[paul-vd]

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch locize-cli@7.13.2 for the project I'm working on.

In the documentation it states that if environment variables are set, they will be used if no arguments are passed or no locize config.

Additionally if these environment variables are set:

• LOCIZE_PROJECTID or LOCIZE_PID
• LOCIZE_API_KEY or LOCIZE_KEY
• LOCIZE_VERSION or LOCIZE_VER
• LOCIZE_LANGUAGE or LOCIZE_LANG or LOCIZE_LNG

But they seem to have been missing when running the CLI, I received: error: missing required argument 'apiKey'

Here is the diff that solved my problem:

diff --git a/node_modules/locize-cli/bin/locize b/node_modules/locize-cli/bin/locize
index 7facb5c..04be9fc 100755
--- a/node_modules/locize-cli/bin/locize
+++ b/node_modules/locize-cli/bin/locize
@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+require('dotenv').config();
 
 const program = require('commander');
 const colors = require('colors');

Checklist

• only relevant code is changed (make a diff before you submit the PR)
• run tests npm run test
• tests are included

Related issue : #69

[adrai]

Just tested on my local machine... reading from the environment variables works as expected.
You can also see this in the code:

locize-cli/bin/locize

Line 398 in 66349dd

const apiKey = options.apiKey || config.apiKey || process.env.LOCIZE_API_KEY || process.env.LOCIZE_KEY;

LOCIZE_API_KEY=my-key LOCIZE_PROJECTID=my-project-id locize sync

works as intended....

The dotenv module should not be needed for that. It is required to read from .env files.

So please if you have issues with the cli to read your environment variables, create a minimal reproducible example so we can investigate.

[paul-vd]

I'm not sure how a minimal reproduction would look for this issue? here are my scripts

    "i18n:download": "locize download --clean=true --path=./public/locales",
    "i18n:sync": "locize sync --path=./public/locales --dry=true"

and my env

LOCIZE_PROJECTID="my-project-id"
LOCIZE_API_KEY="my-api-key"
LOCIZE_LANGUAGE="en-GB"
LOCIZE_VERSION="latest"

I think this is really specific to a developers local environment (machine), and the dotenv ensures that it will retrieve the environment variables, kind of same reason why a lot of people use https://www.npmjs.com/package/cross-env to support dev across multiple platforms, and it's good if packages have the same mentality.

Anyhow, I patched it for our environments to include the dotenv, feel free to close this if you feel that it "should" work, although does not in every instance 😆 #PEBKAC?

[adrai]

If you could provide an example repository or a Docker image or similar that would be awesome.
I like to understand where the problem is, before "fixing" it.

[paul-vd]

@adrai here is a reproduction with a docker example, it does the same in the docker,

git clone https://github.com/paul-vd/locize-cli-reproduction &&
cd locize-cli-reproduction &&
docker build .

Here is the result

After adding the patch that I have done, it works correctly, you can test this by uncommenting the line 12 in the Docker file and running docker build . again, you should then see Project with id "my-project-id" not found! which means it reads the environment variables correctly.

[adrai]

@paul-vd We've just published v7.14.0 that should also respect the default .env file, but we've implemented it in a different way. Can you check if that's ok for you?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[paul-vd]

@paul-vd We've just published v7.14.0 that should also respect the default .env file, but we've implemented it in a different way. Can you check if that's ok for you?

Looks good to me! I will close this one, thanks!