@trop/seed

• Define, load and validate JSON configuration file.
• Development version has even number, for example 0.3.0, 2.1.0.
• Production version has odd major version, for example 1.0.0, 3.0.1.

Install

npm install @trop/seed

API References

const {load, LoadingError} = require('@trop/seed')

/**
 * Load and validate configuration file.
 *
 * @param {Options} [options={}] - Options for loading.
 * @returns {any} Valid configuration from file.
 * @throws {LoadingError}
 */
function load(options={}) {}

/**
 * Pattern: `/^[a-zA-Z0-9]+$/`.
 *
 * @typedef {string} ConfigurationIdentity
 */

/**
 * @typedef {number} FilePermission
 *
 * Unsigned integer, less than or equal 0o7777.
 */

/**
 * @typedef {object} Options
 * @property {ConfigurationIdentity} identity - Identity of configuration.
 * It is use for detecting path to configuration file. There are files to
 * load by order:
 * * ./config.json
 * * ~/config/{identity}/config.json
 * * /etc/{identity}/config.json
 * @property {string} [filePath=undefined] - Override path to configuration
 * file, ignore attribute `identity`.
 * @property {object} [schema={}] - JSON schema that specifies configuration.
 * @property {object} [defaultValues={}] - Key-value pairs for default values,
 * it is the same as argument `path` from `lodash.set()`.
 * @property {FilePermission} [filePermission=0o0600] - If file permission is
 * greater than this one then throws error.
 */

/**
 * @typedef {Error} LoadingError
 * @property {string} message - Short description.
 * @property {string | undefined} filePath - Path to configuration file.
 * @property {object} labels - Additional information.
 */

Example

read_config.js

const seed = require('@trop/seed')

let schema = {
    type: 'object',
    additionalProperties: false,
    required: ['name', 'age'],
    properties: {
        name: {
            type: 'string'
        },
        age: {
            type: 'integer',
            minimum: 0
        },
        address: {
            type: 'object',
            properties: {
                country: {
                    type: 'string'
                },
                city: {
                    type: 'string'
                }
            }
        }
    }
}
let defaultValues = {
    'age': 18,
    'address.country': 'country.foo',
    'address.city': 'country.bar'
}
let config = seed.load({
    identity: 'foo',
    filePath: 'config_file.json',
    schema: schema,
    defaultValues: defaultValues,
    filePermission: 0o700
})

console.log(config)

config_file.json

// This comment is not standard JSON but does not cause errors.
// Below configuration is parse as normal.

{
    "name": "foo",
    "age": 18,
    "address": {
        "country": "country.foo",
        "city": "city.bar"
    }
}

References

• Contribution
• Changelog