@jil/config

@jil/config

Powerful convention based finder, loader, and manager of both configuration and ignore files.

import {Blueprint, Schemas} from '@jil/common/optimal';
import {Configuration} from '@jil/config';

interface ConfigFile {
  debug: boolean;
  sourceMaps: boolean;
}

class ConfigManager extends Configuration<ConfigFile> {
  blueprint({bool}: Schemas): Blueprint<ConfigFile> {
    return {
      debug: bool(),
      sourceMaps: bool(),
    };
  }
}

const configManager = new ConfigManager('jil');

// Load `.config/jil.js`, `jil.production.json`, `.jil.yaml`, etc
const {config} = await configManager.loadConfigFromRoot('.');

// Load `.jilignore` files
const ignore = await configManager.loadIgnoreFromBranchToRoot('./some/deep/path');

Features

• Loads root configs (.config/<name>.js) and branch configs (.<name>.js).
• Loads ignore files (.<name>ignore).
• Supports multiple config types: js, cjs, mjs, json, yaml
• Supports environment and root-level based overrides.
• Supports extending from other config files.
• Find files within each branch folder while traversing up the tree.
• Caches finder results for increased efficiency.
• Custom key-value setting processors.

Installation

npm i @jil/config

Documentation

• https://boostlib.dev/docs/config
• https://boostlib.dev/api/config