diff options
Diffstat (limited to 'doc/files/npmrc.md')
| -rw-r--r-- | doc/files/npmrc.md | 90 |
1 files changed, 0 insertions, 90 deletions
diff --git a/doc/files/npmrc.md b/doc/files/npmrc.md deleted file mode 100644 index 0980c1090..000000000 --- a/doc/files/npmrc.md +++ /dev/null @@ -1,90 +0,0 @@ -npmrc(5) -- The npm config files -================================ - -## DESCRIPTION - -npm gets its config settings from the command line, environment -variables, and `npmrc` files. - -The `npm config` command can be used to update and edit the contents -of the user and global npmrc files. - -For a list of available configuration options, see npm-config(7). - -## FILES - -The four relevant files are: - -* per-project config file (/path/to/my/project/.npmrc) -* per-user config file (~/.npmrc) -* global config file ($PREFIX/etc/npmrc) -* npm builtin config file (/path/to/npm/npmrc) - -All npm config files are an ini-formatted list of `key = value` -parameters. Environment variables can be replaced using -`${VARIABLE_NAME}`. For example: - - prefix = ${HOME}/.npm-packages - -Each of these files is loaded, and config options are resolved in -priority order. For example, a setting in the userconfig file would -override the setting in the globalconfig file. - -Array values are specified by adding "[]" after the key name. For -example: - - key[] = "first value" - key[] = "second value" - -#### Comments - -Lines in `.npmrc` files are interpreted as comments when they begin with a `;` or `#` character. `.npmrc` files are parsed by [npm/ini](https://github.com/npm/ini), which specifies this comment syntax. - -For example: - - # last modified: 01 Jan 2016 - ; Set a new registry for a scoped package - @myscope:registry=https://mycustomregistry.example.org - -### Per-project config file - -When working locally in a project, a `.npmrc` file in the root of the -project (ie, a sibling of `node_modules` and `package.json`) will set -config values specific to this project. - -Note that this only applies to the root of the project that you're -running npm in. It has no effect when your module is published. For -example, you can't publish a module that forces itself to install -globally, or in a different location. - -Additionally, this file is not read in global mode, such as when running -`npm install -g`. - -### Per-user config file - -`$HOME/.npmrc` (or the `userconfig` param, if set in the environment -or on the command line) - -### Global config file - -`$PREFIX/etc/npmrc` (or the `globalconfig` param, if set above): -This file is an ini-file formatted list of `key = value` parameters. -Environment variables can be replaced as above. - -### Built-in config file - -`path/to/npm/itself/npmrc` - -This is an unchangeable "builtin" configuration file that npm keeps -consistent across updates. Set fields in here using the `./configure` -script that comes with npm. This is primarily for distribution -maintainers to override default configs in a standard and consistent -manner. - -## SEE ALSO - -* npm-folders(5) -* npm-config(1) -* npm-config(7) -* package.json(5) -* npm(1) |