Notoriously Psychedelic Modules
    Have ideas to improve npm?Join in the discussion! »

    @smpx/cfg
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.1 • Public • Published

    cfg

    Configuration management for node.js.

    Example config:

    // config.js
    module.exports = {
        db: {
            password: 'abcde',
            host: '127.0.0.1',
        },
        port: 3000,
        hosts: ['127.0.0.1'],
        logsDir: `${__dirname}/logs`,
     
        $env_production: {
            port: 80,
            logsDir: '/home/app/logs',
        },
     
        $env_test: {
            port: 5000,
        },
     
        $env_CI: {
            db: {
                // Docker image hostname
                host: 'postgresql',
            },
        },
    };

    Usage:

    const cfg = require('@smpx/cfg');
     
    const dbConf = cfg('db'); // { password: 'abcde', host: '127.0.0.1' }
    const dbPassword = cfg('db.password');
     

    Docs

    It reads values from config.js file from project directory, but they can be overwritten with another config.js in the private folder in the project directory. Or through env vars in this format:

    # Overwriting password (db.password): 
    CFG__DB__PASSWORD='password' yarn start
    # Adding host to posiition 1 (hosts.1): 
    CFG__HOSTS__1='new-host.region.rds.amazonaws.com' yarn start
    # Override all hosts 
    CFG__HOSTS='@JSON:["a.b", "c.d"]' yarn start

    NOTE: ENV VARS override might only work with camelCase keys

    It basically uses lodash.set internally. The path is generated by removing the CFG__ prefix and replacing __ with . and converting each word in between to camelCase (also through lodash). If the value starts with @JSON:, it will be parsed as JSON (after removing @JSON:), so you can use it to set arrays, objects and numbers.

    NODE_ENV & CI overrides

    cfg also allows overriding config according to NODE_ENV or CI environment variables. For example if NODE_ENV="production", then if a $env_production key exists it's value gets merged over existing conf (this happens before merging any private/config.js file).

    Similarly in CI environments, the value in $env_CI is merged.

    API

    Please check out the typescript definition file: index.d.ts for an overview of all the functions provided.

    Typescript

    For getting types of the output types, you can define a typedef in your config.js file like:

    //config.js
     
    const config = {
        db: {
            password: 'abcde',
            host: '127.0.0.1',
        },
    };
     
    /** @typedef {typeof config} ConfigType */
     
    module.exports = config;

    And in a global typings file in your project, like global.d.ts, import it and set this as the BaseConfig:

    // global.d.ts
    import { ConfigType } from './config';
     
    declare global {
      interface BaseConfig extends ConfigType {}
    }

    This will be automatically picked by cfg. You can also modify this type with some custom keys available only through env vars:

    // global.d.ts
    import { ConfigType } from './config';
     
    declare global {
        interface BaseConfig extends ConfigType {
           envVarOnlyKey?: string;
        }
    }

    CLI

    Get a value from cfg.js

    # Installed globally 
    cfg get redis.port
    cfg get logsDir
     
    # See how ENV_VAR will override config 
    CFG__DB__PASSWORD='password' cfg get "db.password"
     
    # Through npx or yarn (when installed locally) 
    npx cfg get redis.port
    yarn cfg get logsDir
     

    Install

    npm i @smpx/cfg

    DownloadsWeekly Downloads

    64

    Version

    1.4.1

    License

    MIT

    Unpacked Size

    21 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar