@npmcli/config
Advanced tools
@npmcli/config is a configuration management library for Node.js applications, particularly designed to handle npm's configuration needs. It allows you to load, manage, and manipulate configuration settings from various sources such as environment variables, command-line arguments, and configuration files.
Loading Configuration
This feature allows you to load configuration settings from various sources. The `load` method initializes the configuration by reading from environment variables, command-line arguments, and configuration files.
const { Config } = require('@npmcli/config');
const config = new Config();
config.load().then(() => {
console.log(config.get('someKey'));
});Setting Configuration
This feature allows you to set configuration values programmatically. The `set` method is used to assign a value to a specific configuration key.
const { Config } = require('@npmcli/config');
const config = new Config();
config.set('someKey', 'someValue');
console.log(config.get('someKey'));Saving Configuration
This feature allows you to save the current configuration state back to the configuration file. The `save` method writes the current configuration settings to the appropriate file.
const { Config } = require('@npmcli/config');
const config = new Config();
config.set('someKey', 'someValue');
config.save().then(() => {
console.log('Configuration saved!');
});The `config` package is a popular configuration management library for Node.js applications. It allows you to define configuration settings for different deployment environments and load them easily. Compared to @npmcli/config, it is more general-purpose and not specifically tailored for npm's configuration needs.
The `dotenv` package loads environment variables from a `.env` file into `process.env`. It is simpler and more lightweight compared to @npmcli/config, focusing solely on environment variable management rather than a comprehensive configuration management solution.
The `rc` package is a non-opinionated configuration loader for Node.js. It supports loading configuration from various sources like environment variables, command-line arguments, and configuration files. It is similar to @npmcli/config but is more general-purpose and not specifically designed for npm.
@npmcli/configConfiguration management for the npm cli.
This module is the spiritual decendant of
npmconf, and the code that once lived in npm's
lib/config/ folder.
It does the management of configuration files that npm uses, but importantly, does not define all the configuration defaults or types, as those parts make more sense to live within npm itself.
The only exceptions:
prefix config value has some special semantics, setting the local
prefix if specified on the CLI options and not in global mode, or the
global prefix otherwise.project config file is loaded based on the local prefix (which can
only be set by the CLI config options, and otherwise defaults to a walk
up the folder tree to the first parent containing a node_modules
folder, package.json file, or package-lock.json file.)userconfig value, as set by the environment and CLI (defaulting to
~/.npmrc, is used to load user configs.globalconfig value, as set by the environment, CLI, and
userconfig file (defaulting to $PREFIX/etc/npmrc) is used to load
global configs.builtin config, read from a npmrc file in the root of the npm
project itself, overrides all defaults.The resulting heirarchy of configs:
--some-key=some-value on the command line.npm_config_some_key=some_value in the
environment.some-key = some-value in ./.npmrcsome-key = some-value in ~/.npmrcsome-key = some-value in
/usr/local/etc/npmrcsome-key = some-value in
/usr/local/lib/node_modules/npm/npmrc.const Config = require('@npmcli/config')
// the types of all the configs we know about
const types = require('./config/types.js')
// nopt type config definitions
const typeDefs = require('./config/type-defs.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, define it here
const shorthands = require('./config/shorthands.js')
const conf = new Config({
npmPath: resolve(__dirname, '..'),
types,
typeDefs,
shorthands,
defaults,
// optional, defaults to process.argv
argv: process.argv,
// optional, defaults to process.env
env: process.env,
// optional, defaults to process.execPath
execPath: process.execPath,
// optional, defaults to process.platform
platform: process.platform,
// optional, defaults to process.cwd()
cwd: process.cwd(),
// optional, defaults to emitting 'log' events on process object
log: require('npmlog')
})
conf.load().then(() => {
console.log('loaded ok! some-key = ' + conf.get('some-key'))
}).catch(er => {
console.error('error loading configs!', er)
})
10.0.0-pre.1 (2023-08-31)
b34ee65 #6706 set objectMode for search filter stream (@lukekarrys)6b251b1 #6706 drop node 16.13.x support (@lukekarrys)d857c4a #6706 drop node14 support (@lukekarrys)37a99eb #6706 drop node14 support (@lukekarrys)ee7292e #6706 drop node14 support (@lukekarrys)8b0e755 #6706 drop node14 support (@lukekarrys)5c8c6cc #6706 drop node14 support (@lukekarrys)d431647 #6706 drop node14 support (@lukekarrys)b6f2205 #6706 drop node14 support (@lukekarrys)4caedd0 #6706 drop node14 support (@lukekarrys)355bac8 #6706 drop node14 support (@lukekarrys)e3a377d #6706 drop node14 support (@lukekarrys)f916d33 #6715 allow searching packages with no description (@lukekarrys)c736b62 #6686 add missing bugs key in package-json.md (#6686) (@airscripts)c1e01d9 #6680 Update package-json.md (#6680) (@p-chan, @ljharb)5ab3f7e #6706 @npmcli/git@5.0.3eb41977 #6706 @npmcli/run-script@7.0.1f30c9e3 #6706 @npmcli/git@5.0.2f334466 #6706 pacote@17.0.4bb63bf9 #6706 @npmcli/run-script@7.0.075642c6 #6706 @npmcli/promise-spawn@7.0.0dbb18f4 #6706 @npmcli/agent@2.1.0812aa6d #6706 sigstore@2.1.07fab9d3 #6706 @sigstore/tuf@2.1.012337cc #6706 which@4.0.0b1ad3ad #6706 npm-packlist@8.0.043831d0 #6706 pacote@17.0.344e8fec #6706 pacote@17.0.20d2e2c9 #6706 bump sigstore from 1.7.0 to 2.0.0dbd5885 #6706 npm-profile@9.0.02ee0fb3 #6706 npm-registry-fetch@16.0.081ff4df #6706 pacote@17.0.12b23d44 #6706 hoist read-package-json@7.0.0325ed05 #6706 hoist normalize-package-data@6.0.0c3a1a02 #6706 @npmcli/metavuln-calculator@7.0.0f1dd130 #6706 @npmcli/git@5.0.110792ea #6706 init-package-json@6.0.0cac0725 #6706 pacote@17.0.0fd8beaf #6706 npm-pick-manifest@9.0.065f435e #6706 hoist lru-cache@10.0.1c784b57 #6706 npm-package-arg@11.0.0d6b1790 #6706 normalize-package-data@6.0.02f03fb9 #6706 make-fetch-happen@13.0.0729e893 #6706 hosted-git-info@7.0.07af81c7 #6706 cacache@18.0.0b0849ab #6706 @npmcli/package-json@5.0.0c9587d7 #6706 @npmcli/git@5.0.0e28d426 #6706 minipass-fetch@3.0.461e9b00 #6706 @npmcli/metavuln-calculator@6.0.12c5542d #6706 minipass@7.0.3ede7f5e #6706 glob@10.3.34c9eb17 #6706 npm-install-checks@6.2.088ece81 #6706 npm-pick-manifest@8.0.29117a4f #6706 ssri@10.0.545f8d6f #6706 make-fetch-happen@12.0.0f6f6a18 #6706 fs-minipass@3.0.35eea975 #6706 cacache@17.1.4ca33c98 #6706 @npmcli/metavuln-calculator@6.0.07be541a #6706 npm-profile@8.0.0edbc25a #6706 pacote@16.0.05d0d859 #6706 npm-registry-fetch@15.0.0@npmcli/arborist@7.0.0-pre.0@npmcli/config@7.0.1libnpmaccess@8.0.0-pre.0libnpmdiff@6.0.0-pre.0libnpmexec@7.0.0-pre.0libnpmfund@4.0.20libnpmhook@10.0.0-pre.0libnpmorg@6.0.0-pre.0libnpmpack@6.0.0-pre.0libnpmpublish@9.0.0-pre.0libnpmsearch@7.0.0-pre.0libnpmteam@6.0.0-pre.0libnpmversion@5.0.0-pre.0FAQs
Configuration management for the npm cli
The npm package @npmcli/config receives a total of 786,194 weekly downloads. As such, @npmcli/config popularity was classified as popular.
We found that @npmcli/config demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.