doctor-env
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

doctor-env

Vital utility for describing and checking environment variables.
Let's start describing environment variables together 👬

👉 The envConfig.json file with the description of variables can also be imported into your typescript code 👈

Installing

For the latest stable version:

npm install -g doctor-env

Usage

cd path/to/my/project
doctor-env ./mainProjectModule
# or
doctor-env ./mainProjectModule/envConfig.json
Hint for Windows users If the command is not found - add %USERPROFILE%\AppData\Roaming\npm to the PATH environment variable

 

Config example

Files are located like this:
📁 project

├─ 📁 nodejs
│    └─ 📄 envConfig.json

├─ 📁 couch_db
│    └─ 📄 envConfig.json

├─ 📁 postgres_db
│    └─ 📄 envConfig.json

│     outputFiles:
├─ 📄 _couchdb.env
├─ 📄 _postgres.env
└─ 📄 _my-nodejs-server.env

Main module config nodejs/envConfig.json:

{
  "module": {
    "name": "my-nodejs-server",
    "dependencies": {
      "couch": "../couch_db",
      "pg": "../postgres_db"
    },
    "comment": "There may be a description of your module with variables here. Script does not use this information."
    // C-style comments are also supported
  },
  "config": {
    "MY_MAGIC_VAR": {
      "desc": [
        "Multiline description example.",
        "British scientists have found that",
        "describing environment variables in one file",
        "is pretty damn convenient thing."
      ],
      "value": "Forced value 1.618034"
    },
    "POSTGRES_PORT": {
      "value": "5432"
    },
    "POSTGRES_PASSWORD": {
      "refTo": "pg.POSTGRES_PASSWORD"
    },
    "COUCHDB_PASSWORD": {
      "refTo": "couch.COUCHDB_PASSWORD"
    }
  }
}

Child module postgres_db/envConfig.json:

{
  "module": {
    "name": "postgres",
    "comment": [
      "PostgreSQL docker container environment description.",
      "Read more about environment variables here: https://hub.docker.com/_/postgres"
    ]
  },
  "config": {
    "POSTGRES_USER": {
      "desc": "This variable will create the specified user with superuser power and a database with the same name",
      "default": "postgres"
    },
    "POSTGRES_PASSWORD": {
      "secret": true,
      "desc": "Admin password"
    }
  }
}

Child module couch_db/envConfig.json:

{
  "module": {
    "name": "couchdb"
  },
  "config": {
    "COUCHDB_USER": {
      "desc": "Will create an admin user with the given username",
      "default": "BilboBaggins"
    },
    "COUCHDB_PASSWORD": {
      "secret": true,
      "desc": "Admin password"
    }
  }
}

Enter the missing variables

console

Output files:

📄 _couchdb.env

COUCHDB_USER=BilboBaggins
COUCHDB_PASSWORD=mama

📄 _postgres.env

POSTGRES_USER=postgres
POSTGRES_PASSWORD=papa

📄 _my-nodejs-server.env

MY_MAGIC_VAR=Forced value 1.618034
POSTGRES_PORT=5432
PROJECT_NAME=Falcon_9
POSTGRES_PASSWORD=papa
COUCHDB_PASSWORD=mama

Specification of envConfig.json

module: {} block

  • "name" - Required. Module name. The output .env file name is generated from the module name as follows: _<module_name>.env. Example: module name database1, output file _database1.env.
  • "dependencies: { ... }" - Optional. List of links to related modules. Parent modules can use variable configs from child modules (description, default value). Variable values are synchronized between parent and child modules.

config: {} block

  • "desc" - Optional. Variable description, very useful if you are not psychic.

  • "default" - Optional. Default value of variable. It is used if user enters nothing (i.e. empty line "").
    ⚠️ Not recommended to use this field for private/secret data.

  • "value" - Optional. Forced value of variable. The user will not enter it. The value is immediately assigned to the corresponding variable.
    ⚠️ Not recommended to use this field for private/secret data.

  • "refTo" - Optional. The config of this variable refers to the variable from dependencies list. Template: <moduleAlias>.<externalVarName>. Example: myDatabase.DB_PASSWORD. If the variable is not found in the child module, an error will be thrown.

  • "secret" - Optional. If true - value of the variable will not be displayed on the screen when typing it from the keyboard. Also warnings will be displayed if you mistakenly set the "value" or "default" fields.

  • "optional" - Optional. If true - and if the value of the variable is empty string, this variable will not be saved in the .env file.

  • "clearBefore" - Optional. If true - value of the variable in the corresponding .env file will be CLEARED before running the check algorithm.

Priority

If "value" field is set, field "default" will be ignored.

License

MIT

Package Sidebar

Install

npm i doctor-env

Weekly Downloads

3

Version

1.1.1

License

MIT

Unpacked Size

44.2 kB

Total Files

10

Last publish

Collaborators

  • mrstark375