5.0.0 • Published 2 months ago
@boost/config v5.0.0
Configuration - Boost
Powerful convention based finder, loader, and manager of both configuration and ignore files.
import { Blueprint, Schemas } from '@boost/common';
import { Configuration } from '@boost/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('boost');
// Load `.config/boost.js`, `boost.production.json`, `.boost.yaml`, etc
const { config } = await configManager.loadConfigFromRoot('.');
// Load `.boostignore` 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.
- Finds files within each branch folder while traversing up the tree.
- Caches finder results for increased efficiency.
- Custom key-value setting processors.
Installation
yarn add @boost/config
Documentation
5.0.0
2 months ago
5.0.0-alpha.2
2 months ago
5.0.0-alpha.1
3 months ago
4.0.1
1 year ago
4.0.0
2 years ago
4.0.0-alpha.1
2 years ago
3.0.4
2 years ago
3.0.3
2 years ago
3.2.0
2 years ago
3.1.0
2 years ago
3.0.2
2 years ago
3.0.1
3 years ago
3.0.0
3 years ago
2.5.2
3 years ago
2.5.1
3 years ago
2.5.0
3 years ago
2.4.2
3 years ago
2.4.1
3 years ago
2.4.0
3 years ago
2.3.3
3 years ago
2.3.2
3 years ago
2.3.1
3 years ago
2.3.0
3 years ago
2.2.8
3 years ago
2.2.7
3 years ago
2.2.6
3 years ago
2.2.5
3 years ago
2.2.4
4 years ago
2.2.3
4 years ago
2.2.2
4 years ago
2.2.1
4 years ago
2.2.0
4 years ago
2.1.0
4 years ago
2.0.0-alpha.4
4 years ago
2.0.0
4 years ago
2.0.0-alpha.3
4 years ago
2.0.0-alpha.2
4 years ago
2.0.0-alpha.1
4 years ago
1.0.0
4 years ago