Use a configuration file (beyond ENV-variables)

[elwinschmitz]

To simplify the configuration of multiple regions (and multiple properties per Region), it would be nice to be able to use something more convenient then ENV-variables.

For example:

regions: [
  {
    slug: "test",
    label: "Testing",
    sheetID: "abc...xyz",
    propertyX: ""
  },
  {
    slug: "example",
    label: "For Example",
    sheetID: "zyx...cba",
    propertyY: ""
  }
]

Preferably using a commonly used 'default'. (Like dotenv)

Option: "as JS"

• Using .config.js or [.?]helpful-information.config.js
• with module.exports = ...
• Would allow for comments, extra formatting, etc
• Choose between CJS or ESM format?

Things to consider:

• How to easily override per environment? (Or at least in local development?)

  • Maybe with:

    • .defaults.config.js (always present, with comments)
    • .env.config.js (optional, ignored by git)
    • .local.config.js (optional, only for local development, ignored by git)
      All 3 files could be checked for, and then 'merged on top of' the defaults during a build/run.

  • Or there might be an existing practice/package for this?

• How to define (safe) defaults? (And then override only when needed)
• How to ignore in git (and keep override/defaults features)?

Examples / Inspiration / Related

• https://github.com/chihab/ngx-env
• https://www.npmjs.com/package/cosmiconfig
• https://www.npmjs.com/package/dotenv-flow / https://www.npmjs.com/package/dotenv-defaults
• https://dev.to/jakobjingleheimer/configuring-commonjs-es-modules-for-nodejs-12ed

To Do

• Decide (file) format / technical implementation
• Update documentation/examples/demos
• Refactor existing uses
• Refactor/migrate existing deployments (only after Refactor instance-repo(s) to use their own package.json-files, with helpful-information not as submodule #547 ?)

[elwinschmitz]

See: https://codingsans.com/blog/node-config-best-practices

Use https://github.com/mozilla/node-convict ?

Or https://github.com/indexzero/nconf ?