Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Config factory #6912

Closed
wants to merge 2 commits into from
Closed

Config factory #6912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4d96cc
chore(docs): updated config docs
wesleytodd Oct 17, 2023
25ef904
feat: added withDefaultOptions helper method
wesleytodd Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions workspaces/config/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,14 @@ The resulting hierarchy of configs:

```js
const Config = require('@npmcli/config')
// the types of all the configs we know about
const types = require('./config/types.js')
// default values for all the configs we know about
const defaults = require('./config/defaults.js')
// if you want -c to be short for --call and so on, define it here
const shorthands = require('./config/shorthands.js')
const { shorthands, definitions, flatten } = require('@npmcli/config/lib/definitions')

const conf = new Config({
// path to the npm module being run
npmPath: resolve(__dirname, '..'),
types,
definitions,
shorthands,
defaults,
flatten,
// optional, defaults to process.argv
argv: process.argv,
// optional, defaults to process.env
Expand Down
10 changes: 10 additions & 0 deletions workspaces/config/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ const envReplace = require('./env-replace.js')
const parseField = require('./parse-field.js')
const typeDescription = require('./type-description.js')
const setEnvs = require('./set-envs.js')
const { shorthands, definitions, flatten } = require('./definitions');

const {
ErrInvalidAuth,
Expand Down Expand Up @@ -82,6 +83,15 @@ class Config {
return typeDefs
}

static withDefaultOptions (opts = {}) {
return new Config({
definitions,
flatten,
shorthands,
...opts
});
}

constructor ({
definitions,
shorthands,
Expand Down