diff --git a/.eslintrc.js b/.eslintrc.js index a7034be024c..fe1498ff075 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -37,7 +37,7 @@ module.exports = { parserOptions: { sourceType: 'module', }, - globals: getGlobals(['Index', 'Note', 'Prompt', 'PromptReply', 'Screenshot', 'Link', 'YouTube']), + globals: getGlobals(['Index', 'Note', 'Prompt', 'Screenshot', 'Link', 'YouTube']), settings: { 'import/resolver': 'webpack', }, diff --git a/.github/workflows/ci-cli.yml b/.github/workflows/ci-cli.yml index bc63398a9d1..769976343af 100644 --- a/.github/workflows/ci-cli.yml +++ b/.github/workflows/ci-cli.yml @@ -90,6 +90,8 @@ jobs: run: npm run lint --ignore-scripts -w cli - name: Post Lint run: npm run postlint --ignore-scripts -w cli + - name: Check Format + run: npm run format:check --ignore-scripts --if-present -w cli test: name: Test - ${{ matrix.platform.name }} - ${{ matrix.node-version }} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 849612835f3..2f34ca5f512 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -90,6 +90,8 @@ jobs: run: npm run lint --ignore-scripts - name: Post Lint run: npm run postlint --ignore-scripts + - name: Check Format + run: npm run format:check --ignore-scripts --if-present test: name: Test - ${{ matrix.platform.name }} - ${{ matrix.node-version }} diff --git a/.prettierignore b/.prettierignore index 617cf97e1ee..ae8d4c86b8c 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,6 +1,5 @@ **/template-oss/*.json **/template-oss/*.yml -/content/ /.github/ /package-lock.json /SECURITY.md diff --git a/.prettierrc.js b/.prettierrc.js index 6debca1c437..96cac388c56 100644 --- a/.prettierrc.js +++ b/.prettierrc.js @@ -3,4 +3,11 @@ const config = require('@github/prettier-config') module.exports = { ...config, proseWrap: 'never', + embeddedLanguageFormatting: 'off', + overrides: [ + { + files: ['content/**/*.mdx'], + printWidth: 99999, + }, + ], } diff --git a/cli/lib/transform.js b/cli/lib/transform.js index 3403f2eb163..69edb830ca3 100644 --- a/cli/lib/transform.js +++ b/cli/lib/transform.js @@ -7,6 +7,12 @@ const gh = require('./gh') const prettier = require('@prettier/sync') const rawRedirects = require('./redirects') +const prettierFormat = str => + prettier.format(str, { + parser: 'markdown', + proseWrap: 'never', + }) + const getPathParts = path => { const abs = isAbsolute(path) const paths = path.replace(/\.mdx?$/, '').split(sep) @@ -101,7 +107,8 @@ const transform = (data, {release, path, frontmatter, format = s => s}) => { // first format with prettier, this helps so other replacements don't have to // worry about newlines vs spaces - body = prettier.format(body, {parser: 'markdown', proseWrap: 'never'}) + body = prettierFormat(body) + // then do replacements for all cli makdown files body = body // some legacy versions of the docs did not get this replaced @@ -121,6 +128,9 @@ const transform = (data, {release, path, frontmatter, format = s => s}) => { // then do any transformer specific replacements body = format(body) + // prettier again now that we've altered the contents + body = prettierFormat(body) + return `---\n${yaml.stringify(attributes).trim()}\n---\n\n${body}` } diff --git a/content/about-npm/index.mdx b/content/about-npm/index.mdx index 73988ec30b5..075a33abb77 100644 --- a/content/about-npm/index.mdx +++ b/content/about-npm/index.mdx @@ -8,30 +8,29 @@ npm is the world's largest software registry. Open source developers from every npm consists of three distinct components: -* the website -* the Command Line Interface (CLI) -* the registry +- the website +- the Command Line Interface (CLI) +- the registry -Use the [*website*](https://npmjs.com) to discover packages, set up profiles, and manage other aspects of your npm experience. For example, you can set up [organizations](https://www.npmjs.com/features) to manage access to public or private packages. +Use the [_website_](https://npmjs.com) to discover packages, set up profiles, and manage other aspects of your npm experience. For example, you can set up [organizations](https://www.npmjs.com/features) to manage access to public or private packages. -The [*CLI*](https://docs.npmjs.com/cli/npm) runs from a terminal, and is how most developers interact with npm. - -The [*registry*](https://docs.npmjs.com/misc/registry) is a large public database of JavaScript software and the meta-information surrounding it. +The [_CLI_](https://docs.npmjs.com/cli/npm) runs from a terminal, and is how most developers interact with npm. +The [_registry_](https://docs.npmjs.com/misc/registry) is a large public database of JavaScript software and the meta-information surrounding it. ## Use npm to . . . -* Adapt packages of code for your apps, or incorporate packages as they are. -* Download standalone tools you can use right away. -* Run packages without downloading using [npx](https://docs.npmjs.com/cli/commands/npx). -* Share code with any npm user, anywhere. -* Restrict code to specific developers. -* Create organizations to coordinate package maintenance, coding, and developers. -* Form virtual teams by using organizations. -* Manage multiple versions of code and code dependencies. -* Update applications easily when underlying code is updated. -* Discover multiple ways to solve the same puzzle. -* Find other developers who are working on similar problems and projects. +- Adapt packages of code for your apps, or incorporate packages as they are. +- Download standalone tools you can use right away. +- Run packages without downloading using [npx](https://docs.npmjs.com/cli/commands/npx). +- Share code with any npm user, anywhere. +- Restrict code to specific developers. +- Create organizations to coordinate package maintenance, coding, and developers. +- Form virtual teams by using organizations. +- Manage multiple versions of code and code dependencies. +- Update applications easily when underlying code is updated. +- Discover multiple ways to solve the same puzzle. +- Find other developers who are working on similar problems and projects. ## Getting started @@ -41,9 +40,9 @@ After you set up an npm account, the next step is to use the command line interf ## Sharing packages and collaborating with others -If you choose to share your packages publicly, there is no cost. To use and share private packages, you need to upgrade your account. To share with others, create organizations, called **[npm organizations][orgs-docs]**, and invite others to work with you, privately (for a fee) or publicly (for free). +If you choose to share your packages publicly, there is no cost. To use and share private packages, you need to upgrade your account. To share with others, create organizations, called **[npm organizations][orgs-docs]**, and invite others to work with you, privately (for a fee) or publicly (for free). -You can also use a private npm package registry like [GitHub Packages](https://github.com/features/packages) or the open source [Verdaccio](https://verdaccio.org) project. This lets you develop packages internally that are not shared publicly. +You can also use a private npm package registry like [GitHub Packages](https://github.com/features/packages) or the open source [Verdaccio](https://verdaccio.org) project. This lets you develop packages internally that are not shared publicly. ## Learn more @@ -55,7 +54,6 @@ For mentoring, tutorials, and learning, visit [node school](https://nodeschool.i While relevant CLI commands are covered throughout this user documentation, the CLI includes command line help, its own [documentation section, and instant help (man pages)][cli-docs]. - [orgs-docs]: /organizations [install-npm]: /downloading-and-installing-node-js-and-npm [cli-docs]: /cli-documentation diff --git a/content/cli/v7/commands/npm-access.mdx b/content/cli/v7/commands/npm-access.mdx index a14e11ee306..6bb68d6862b 100644 --- a/content/cli/v7/commands/npm-access.mdx +++ b/content/cli/v7/commands/npm-access.mdx @@ -76,7 +76,6 @@ Management of teams and team memberships is done with the `npm team` command. ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -84,7 +83,6 @@ Management of teams and team memberships is done with the `npm team` command. The base URL of the npm registry. - #### `otp` - Default: null @@ -94,8 +92,6 @@ This is a one-time password from a two-factor authenticator. It's needed when pu If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. - - ### See Also - [`libnpmaccess`](https://npm.im/libnpmaccess) diff --git a/content/cli/v7/commands/npm-adduser.mdx b/content/cli/v7/commands/npm-adduser.mdx index f9028cc8e53..6b1e2acf1d8 100644 --- a/content/cli/v7/commands/npm-adduser.mdx +++ b/content/cli/v7/commands/npm-adduser.mdx @@ -45,7 +45,6 @@ You may use this command multiple times with the same user account to authorize ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -53,7 +52,6 @@ You may use this command multiple times with the same user account to authorize The base URL of the npm registry. - #### `scope` - Default: the scope of the current project, if any, or "" @@ -81,8 +79,6 @@ This will also cause `npm init` to create a scoped package. npm init --scope=@foo --yes ``` - - ### See Also - [npm registry](/cli/v7/using-npm/registry) diff --git a/content/cli/v7/commands/npm-audit.mdx b/content/cli/v7/commands/npm-audit.mdx index 9db46356295..2c191e3804f 100644 --- a/content/cli/v7/commands/npm-audit.mdx +++ b/content/cli/v7/commands/npm-audit.mdx @@ -146,7 +146,6 @@ $ npm audit --audit-level=moderate ### Configuration - #### `audit-level` - Default: null @@ -154,7 +153,6 @@ $ npm audit --audit-level=moderate The minimum level of vulnerability for `npm audit` to exit with a non-zero exit code. - #### `dry-run` - Default: false @@ -164,7 +162,6 @@ Indicates that you don't want npm to make any changes and that it should only re Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. - #### `force` - Default: false @@ -185,7 +182,6 @@ Removes various protections against unfortunate side effects, common mistakes, u If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! - #### `json` - Default: false @@ -197,7 +193,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `package-lock-only` - Default: false @@ -209,7 +204,6 @@ For `update` this means only the `package-lock.json` will be updated, instead of For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`. - #### `omit` - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty. @@ -223,7 +217,6 @@ If a package type appears in both the `--include` and `--omit` lists, then it wi If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. - #### `workspace` - Default: @@ -241,7 +234,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -251,8 +243,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm install](/cli/v7/commands/npm-install) diff --git a/content/cli/v7/commands/npm-bin.mdx b/content/cli/v7/commands/npm-bin.mdx index f1466660207..be7cc1003d9 100644 --- a/content/cli/v7/commands/npm-bin.mdx +++ b/content/cli/v7/commands/npm-bin.mdx @@ -33,7 +33,6 @@ Print the folder where npm will install executables. ### Configuration - #### `global` - Default: false @@ -45,8 +44,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - - ### See Also - [npm prefix](/cli/v7/commands/npm-prefix) diff --git a/content/cli/v7/commands/npm-bugs.mdx b/content/cli/v7/commands/npm-bugs.mdx index 708a3ac99e8..1247dfbd6fe 100644 --- a/content/cli/v7/commands/npm-bugs.mdx +++ b/content/cli/v7/commands/npm-bugs.mdx @@ -33,7 +33,6 @@ This command tries to guess at the likely location of a package's bug tracker UR ### Configuration - #### `browser` - Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -45,7 +44,6 @@ Set to `false` to suppress browser behavior and instead print urls to terminal. Set to `true` to use default system URL opener. - #### `registry` - Default: "https://registry.npmjs.org/" @@ -53,8 +51,6 @@ Set to `true` to use default system URL opener. The base URL of the npm registry. - - ### See Also - [npm docs](/cli/v7/commands/npm-docs) diff --git a/content/cli/v7/commands/npm-cache.mdx b/content/cli/v7/commands/npm-cache.mdx index f2275d9e595..082a48002bd 100644 --- a/content/cli/v7/commands/npm-cache.mdx +++ b/content/cli/v7/commands/npm-cache.mdx @@ -63,7 +63,6 @@ To run an offline verification of existing cache contents, use `npm cache verify ### Configuration - #### `cache` - Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm` @@ -71,8 +70,6 @@ To run an offline verification of existing cache contents, use `npm cache verify The location of npm's cache directory. See [`npm cache`](/cli/v7/commands/npm-cache) - - ### See Also - [npm folders](/cli/v7/configuring-npm/folders) diff --git a/content/cli/v7/commands/npm-ci.mdx b/content/cli/v7/commands/npm-ci.mdx index 3db77e909c8..f99d3aec8bd 100644 --- a/content/cli/v7/commands/npm-ci.mdx +++ b/content/cli/v7/commands/npm-ci.mdx @@ -74,7 +74,6 @@ cache: ### Configuration - #### `audit` - Default: true @@ -82,7 +81,6 @@ cache: When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v7/commands/npm-audit) for details on what is submitted. - #### `ignore-scripts` - Default: false @@ -92,7 +90,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `script-shell` - Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -100,8 +97,6 @@ Note that commands explicitly intended to run a particular script, such as `npm The shell to use for scripts run with the `npm exec`, `npm run` and `npm init ` commands. - - ### See Also - [npm install](/cli/v7/commands/npm-install) diff --git a/content/cli/v7/commands/npm-config.mdx b/content/cli/v7/commands/npm-config.mdx index 46b749e30a7..a12c8db92a9 100644 --- a/content/cli/v7/commands/npm-config.mdx +++ b/content/cli/v7/commands/npm-config.mdx @@ -101,7 +101,6 @@ Opens the config file in an editor. Use the `--global` flag to edit the global c ### Configuration - #### `json` - Default: false @@ -113,7 +112,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `global` - Default: false @@ -125,7 +123,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - #### `editor` - Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on Windows, or 'vim' on Unix systems @@ -133,7 +130,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold The command to run for `npm edit` and `npm config edit`. - #### `location` - Default: "user" unless `--global` is passed, which will also set this value to "global" @@ -141,7 +137,6 @@ The command to run for `npm edit` and `npm config edit`. When passed to `npm config` this refers to which config file to use. - #### `long` - Default: false @@ -149,8 +144,6 @@ When passed to `npm config` this refers to which config file to use. Show extended information in `ls`, `search`, and `help-search`. - - ### See Also - [npm folders](/cli/v7/configuring-npm/folders) diff --git a/content/cli/v7/commands/npm-dedupe.mdx b/content/cli/v7/commands/npm-dedupe.mdx index 0128905273b..94cd8656616 100644 --- a/content/cli/v7/commands/npm-dedupe.mdx +++ b/content/cli/v7/commands/npm-dedupe.mdx @@ -77,7 +77,6 @@ Using `npm find-dupes` will run the command in `--dry-run` mode. ### Configuration - #### `global-style` - Default: false @@ -85,7 +84,6 @@ Using `npm find-dupes` will run the command in `--dry-run` mode. Causes npm to install the package into your local `node_modules` folder with the same layout it uses with the global `node_modules` folder. Only your direct dependencies will show in `node_modules` and everything they depend on will be flattened in their `node_modules` folders. This obviously will eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be preferred. - #### `legacy-bundling` - Default: false @@ -93,7 +91,6 @@ Causes npm to install the package into your local `node_modules` folder with the Causes npm to install the package such that versions of npm prior to 1.4, such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with `global-style` this option will be preferred. - #### `strict-peer-deps` - Default: false @@ -105,7 +102,6 @@ By default, conflicting `peerDependencies` deep in the dependency graph will be When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure. - #### `package-lock` - Default: true @@ -115,7 +111,6 @@ If set to false, then ignore `package-lock.json` files when installing. This wil When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. - #### `omit` - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty. @@ -129,7 +124,6 @@ If a package type appears in both the `--include` and `--omit` lists, then it wi If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. - #### `ignore-scripts` - Default: false @@ -139,7 +133,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `audit` - Default: true @@ -147,7 +140,6 @@ Note that commands explicitly intended to run a particular script, such as `npm When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v7/commands/npm-audit) for details on what is submitted. - #### `bin-links` - Default: true @@ -157,7 +149,6 @@ Tells npm to create symlinks (or `.cmd` shims on Windows) for package executable Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems. - #### `fund` - Default: true @@ -165,7 +156,6 @@ Set to false to have it not do this. This can be used to work around the fact th When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v7/commands/npm-fund) for details. - #### `dry-run` - Default: false @@ -175,7 +165,6 @@ Indicates that you don't want npm to make any changes and that it should only re Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. - #### `workspace` - Default: @@ -193,7 +182,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -203,8 +191,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm find-dupes](/cli/v7/commands/npm-find-dupes) diff --git a/content/cli/v7/commands/npm-deprecate.mdx b/content/cli/v7/commands/npm-deprecate.mdx index 49f641ac286..9adbf8b4053 100644 --- a/content/cli/v7/commands/npm-deprecate.mdx +++ b/content/cli/v7/commands/npm-deprecate.mdx @@ -51,7 +51,6 @@ To un-deprecate a package, specify an empty string (`""`) for the `message` argu ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -59,7 +58,6 @@ To un-deprecate a package, specify an empty string (`""`) for the `message` argu The base URL of the npm registry. - #### `otp` - Default: null @@ -69,8 +67,6 @@ This is a one-time password from a two-factor authenticator. It's needed when pu If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. - - ### See Also - [npm publish](/cli/v7/commands/npm-publish) diff --git a/content/cli/v7/commands/npm-diff.mdx b/content/cli/v7/commands/npm-diff.mdx index deff153550f..bb63ebc3b9d 100644 --- a/content/cli/v7/commands/npm-diff.mdx +++ b/content/cli/v7/commands/npm-diff.mdx @@ -128,7 +128,6 @@ In the example above the diff output is only going to print contents of files lo ### Configuration - #### `diff` - Default: @@ -136,7 +135,6 @@ In the example above the diff output is only going to print contents of files lo Define arguments to compare in `npm diff`. - #### `diff-name-only` - Default: false @@ -144,7 +142,6 @@ Define arguments to compare in `npm diff`. Prints only filenames when using `npm diff`. - #### `diff-unified` - Default: 3 @@ -152,7 +149,6 @@ Prints only filenames when using `npm diff`. The number of lines of context to print in `npm diff`. - #### `diff-ignore-all-space` - Default: false @@ -160,7 +156,6 @@ The number of lines of context to print in `npm diff`. Ignore whitespace when comparing lines in `npm diff`. - #### `diff-no-prefix` - Default: false @@ -170,7 +165,6 @@ Do not show any source or destination prefix in `npm diff` output. Note: this causes `npm diff` to ignore the `--diff-src-prefix` and `--diff-dst-prefix` configs. - #### `diff-src-prefix` - Default: "a/" @@ -178,7 +172,6 @@ Note: this causes `npm diff` to ignore the `--diff-src-prefix` and `--diff-dst-p Source prefix to be used in `npm diff` output. - #### `diff-dst-prefix` - Default: "b/" @@ -186,7 +179,6 @@ Source prefix to be used in `npm diff` output. Destination prefix to be used in `npm diff` output. - #### `diff-text` - Default: false @@ -194,7 +186,6 @@ Destination prefix to be used in `npm diff` output. Treat all files as text in `npm diff`. - #### `global` - Default: false @@ -206,7 +197,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - #### `tag` - Default: "latest" @@ -218,7 +208,6 @@ Also the tag that is added to the package@version specified by the `npm tag` com When used by the `npm diff` command, this is the tag used to fetch the tarball that will be compared with the local files by default. - #### `workspace` - Default: @@ -236,7 +225,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -246,8 +234,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ## See Also - [npm outdated](/cli/v7/commands/npm-outdated) diff --git a/content/cli/v7/commands/npm-dist-tag.mdx b/content/cli/v7/commands/npm-dist-tag.mdx index 9abe6774c78..5462fd77e85 100644 --- a/content/cli/v7/commands/npm-dist-tag.mdx +++ b/content/cli/v7/commands/npm-dist-tag.mdx @@ -81,7 +81,6 @@ The simplest way to avoid semver problems with tags is to use tags that do not b ### Configuration - #### `workspace` - Default: @@ -99,7 +98,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -109,8 +107,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm publish](/cli/v7/commands/npm-publish) diff --git a/content/cli/v7/commands/npm-docs.mdx b/content/cli/v7/commands/npm-docs.mdx index 5229bb559bf..ec4f09cdf77 100644 --- a/content/cli/v7/commands/npm-docs.mdx +++ b/content/cli/v7/commands/npm-docs.mdx @@ -33,7 +33,6 @@ This command tries to guess at the likely location of a package's documentation ### Configuration - #### `browser` - Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -45,7 +44,6 @@ Set to `false` to suppress browser behavior and instead print urls to terminal. Set to `true` to use default system URL opener. - #### `registry` - Default: "https://registry.npmjs.org/" @@ -53,7 +51,6 @@ Set to `true` to use default system URL opener. The base URL of the npm registry. - #### `workspace` - Default: @@ -71,7 +68,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -81,8 +77,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm view](/cli/v7/commands/npm-view) diff --git a/content/cli/v7/commands/npm-doctor.mdx b/content/cli/v7/commands/npm-doctor.mdx index 5b9bd404f89..372026a89d4 100644 --- a/content/cli/v7/commands/npm-doctor.mdx +++ b/content/cli/v7/commands/npm-doctor.mdx @@ -76,7 +76,6 @@ When an npm package is published, the publishing process generates a checksum th ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -84,8 +83,6 @@ When an npm package is published, the publishing process generates a checksum th The base URL of the npm registry. - - ### See Also - [npm bugs](/cli/v7/commands/npm-bugs) diff --git a/content/cli/v7/commands/npm-edit.mdx b/content/cli/v7/commands/npm-edit.mdx index aa5a85159d3..99787cfa03a 100644 --- a/content/cli/v7/commands/npm-edit.mdx +++ b/content/cli/v7/commands/npm-edit.mdx @@ -37,7 +37,6 @@ For instance, you can do `npm install connect` to install connect into your pack ### Configuration - #### `editor` - Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on Windows, or 'vim' on Unix systems @@ -45,8 +44,6 @@ For instance, you can do `npm install connect` to install connect into your pack The command to run for `npm edit` and `npm config edit`. - - ### See Also - [npm folders](/cli/v7/configuring-npm/folders) diff --git a/content/cli/v7/commands/npm-exec.mdx b/content/cli/v7/commands/npm-exec.mdx index 19afb4b1061..d2b3770be14 100644 --- a/content/cli/v7/commands/npm-exec.mdx +++ b/content/cli/v7/commands/npm-exec.mdx @@ -100,7 +100,6 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo ### Configuration - #### `package` - Default: @@ -108,7 +107,6 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo The package to install for [`npm exec`](/cli/v7/commands/npm-exec) - #### `call` - Default: "" @@ -120,7 +118,6 @@ Optional companion option for `npm exec`, `npx` that allows for specifying a cus npm exec --package yo --package generator-node --call "yo node" ``` - #### `workspace` - Default: @@ -138,7 +135,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -148,8 +144,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### Examples Run the version of `tap` in the local dependencies, with the provided arguments: diff --git a/content/cli/v7/commands/npm-explain.mdx b/content/cli/v7/commands/npm-explain.mdx index 4b06f147f66..58a680fe2a6 100644 --- a/content/cli/v7/commands/npm-explain.mdx +++ b/content/cli/v7/commands/npm-explain.mdx @@ -64,7 +64,6 @@ node_modules/nyc/node_modules/find-up ### Configuration - #### `json` - Default: false @@ -76,7 +75,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `workspace` - Default: @@ -94,8 +92,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - - ### See Also - [npm config](/cli/v7/commands/npm-config) diff --git a/content/cli/v7/commands/npm-explore.mdx b/content/cli/v7/commands/npm-explore.mdx index 4fcf65056d5..a195cca3c88 100644 --- a/content/cli/v7/commands/npm-explore.mdx +++ b/content/cli/v7/commands/npm-explore.mdx @@ -43,7 +43,6 @@ Note that the package is _not_ automatically rebuilt afterwards, so be sure to u ### Configuration - #### `shell` - Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on Windows @@ -51,8 +50,6 @@ Note that the package is _not_ automatically rebuilt afterwards, so be sure to u The shell to run for the `npm explore` command. - - ### See Also - [npm folders](/cli/v7/configuring-npm/folders) diff --git a/content/cli/v7/commands/npm-find-dupes.mdx b/content/cli/v7/commands/npm-find-dupes.mdx index 4988b1e9b95..664682208b8 100644 --- a/content/cli/v7/commands/npm-find-dupes.mdx +++ b/content/cli/v7/commands/npm-find-dupes.mdx @@ -31,7 +31,6 @@ Runs `npm dedupe` in `--dry-run` mode, making npm only output the duplications, ### Configuration - #### `global-style` - Default: false @@ -39,7 +38,6 @@ Runs `npm dedupe` in `--dry-run` mode, making npm only output the duplications, Causes npm to install the package into your local `node_modules` folder with the same layout it uses with the global `node_modules` folder. Only your direct dependencies will show in `node_modules` and everything they depend on will be flattened in their `node_modules` folders. This obviously will eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be preferred. - #### `legacy-bundling` - Default: false @@ -47,7 +45,6 @@ Causes npm to install the package into your local `node_modules` folder with the Causes npm to install the package such that versions of npm prior to 1.4, such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with `global-style` this option will be preferred. - #### `strict-peer-deps` - Default: false @@ -59,7 +56,6 @@ By default, conflicting `peerDependencies` deep in the dependency graph will be When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure. - #### `package-lock` - Default: true @@ -69,7 +65,6 @@ If set to false, then ignore `package-lock.json` files when installing. This wil When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. - #### `omit` - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty. @@ -83,7 +78,6 @@ If a package type appears in both the `--include` and `--omit` lists, then it wi If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. - #### `ignore-scripts` - Default: false @@ -93,7 +87,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `audit` - Default: true @@ -101,7 +94,6 @@ Note that commands explicitly intended to run a particular script, such as `npm When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v7/commands/npm-audit) for details on what is submitted. - #### `bin-links` - Default: true @@ -111,7 +103,6 @@ Tells npm to create symlinks (or `.cmd` shims on Windows) for package executable Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems. - #### `fund` - Default: true @@ -119,7 +110,6 @@ Set to false to have it not do this. This can be used to work around the fact th When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v7/commands/npm-fund) for details. - #### `workspace` - Default: @@ -137,7 +127,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -147,8 +136,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm dedupe](/cli/v7/commands/npm-dedupe) diff --git a/content/cli/v7/commands/npm-fund.mdx b/content/cli/v7/commands/npm-fund.mdx index 5770d360aba..1f12d05ec4a 100644 --- a/content/cli/v7/commands/npm-fund.mdx +++ b/content/cli/v7/commands/npm-fund.mdx @@ -68,7 +68,6 @@ test-workspaces-fund@1.0.0 ### Configuration - #### `json` - Default: false @@ -80,7 +79,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `browser` - Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -92,7 +90,6 @@ Set to `false` to suppress browser behavior and instead print urls to terminal. Set to `true` to use default system URL opener. - #### `unicode` - Default: false on windows, true on mac/unix systems with a unicode locale, as defined by the `LC_ALL`, `LC_CTYPE`, or `LANG` environment variables. @@ -100,7 +97,6 @@ Set to `true` to use default system URL opener. When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. - #### `workspace` - Default: @@ -118,7 +114,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `which` - Default: null @@ -126,8 +121,6 @@ This value is not exported to the environment for child processes. If there are multiple funding sources, which 1-indexed source URL to open. - - ## See Also - [npm install](/cli/v7/commands/npm-install) diff --git a/content/cli/v7/commands/npm-help-search.mdx b/content/cli/v7/commands/npm-help-search.mdx index 6526eb36969..22d310a0c05 100644 --- a/content/cli/v7/commands/npm-help-search.mdx +++ b/content/cli/v7/commands/npm-help-search.mdx @@ -37,7 +37,6 @@ If the argument to `npm help` is not a known help topic, then it will call `help ### Configuration - #### `long` - Default: false @@ -45,8 +44,6 @@ If the argument to `npm help` is not a known help topic, then it will call `help Show extended information in `ls`, `search`, and `help-search`. - - ### See Also - [npm](/cli/v7/commands/npm) diff --git a/content/cli/v7/commands/npm-help.mdx b/content/cli/v7/commands/npm-help.mdx index b549fdecdf4..64c4198a4f9 100644 --- a/content/cli/v7/commands/npm-help.mdx +++ b/content/cli/v7/commands/npm-help.mdx @@ -35,7 +35,6 @@ If the topic does not exist, or if multiple terms are provided, then npm will ru ### Configuration - #### `viewer` - Default: "man" on Posix, "browser" on Windows @@ -45,8 +44,6 @@ The program to use to view help content. Set to `"browser"` to view html help content in the default web browser. - - ### See Also - [npm](/cli/v7/commands/npm) diff --git a/content/cli/v7/commands/npm-hook.mdx b/content/cli/v7/commands/npm-hook.mdx index 464c154cc7c..f21c3ac627c 100644 --- a/content/cli/v7/commands/npm-hook.mdx +++ b/content/cli/v7/commands/npm-hook.mdx @@ -92,7 +92,6 @@ $ npm hook rm id-deadbeef ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -100,7 +99,6 @@ $ npm hook rm id-deadbeef The base URL of the npm registry. - #### `otp` - Default: null @@ -110,8 +108,6 @@ This is a one-time password from a two-factor authenticator. It's needed when pu If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. - - ### See Also - ["Introducing Hooks" blog post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm) diff --git a/content/cli/v7/commands/npm-init.mdx b/content/cli/v7/commands/npm-init.mdx index 2705f548315..7e14b0d6e21 100644 --- a/content/cli/v7/commands/npm-init.mdx +++ b/content/cli/v7/commands/npm-init.mdx @@ -129,7 +129,6 @@ This will make sure to generate your react app as expected, one important consid ### Configuration - #### `yes` - Default: null @@ -137,7 +136,6 @@ This will make sure to generate your react app as expected, one important consid Automatically answer "yes" to any prompts that npm might print on the command line. - #### `force` - Default: false @@ -158,7 +156,6 @@ Removes various protections against unfortunate side effects, common mistakes, u If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! - #### `workspace` - Default: @@ -176,7 +173,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -186,8 +182,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [init-package-json module](http://npm.im/init-package-json) diff --git a/content/cli/v7/commands/npm-install-ci-test.mdx b/content/cli/v7/commands/npm-install-ci-test.mdx index ee835db23d9..94edd41715a 100644 --- a/content/cli/v7/commands/npm-install-ci-test.mdx +++ b/content/cli/v7/commands/npm-install-ci-test.mdx @@ -33,7 +33,6 @@ This command runs `npm ci` followed immediately by `npm test`. ### Configuration - #### `audit` - Default: true @@ -41,7 +40,6 @@ This command runs `npm ci` followed immediately by `npm test`. When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v7/commands/npm-audit) for details on what is submitted. - #### `ignore-scripts` - Default: false @@ -51,7 +49,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `script-shell` - Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -59,8 +56,6 @@ Note that commands explicitly intended to run a particular script, such as `npm The shell to use for scripts run with the `npm exec`, `npm run` and `npm init ` commands. - - ### See Also - [npm install-test](/cli/v7/commands/npm-install-test) diff --git a/content/cli/v7/commands/npm-install-test.mdx b/content/cli/v7/commands/npm-install-test.mdx index 3e29a31b87f..fdcd1d86879 100644 --- a/content/cli/v7/commands/npm-install-test.mdx +++ b/content/cli/v7/commands/npm-install-test.mdx @@ -41,7 +41,6 @@ This command runs an `npm install` followed immediately by an `npm test`. It tak ### Configuration - #### `save` - Default: true @@ -51,7 +50,6 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. - #### `save-exact` - Default: false @@ -59,7 +57,6 @@ When used with the `npm rm` command, removes the dependency from package.json. Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator. - #### `global` - Default: false @@ -71,7 +68,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - #### `global-style` - Default: false @@ -79,7 +75,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold Causes npm to install the package into your local `node_modules` folder with the same layout it uses with the global `node_modules` folder. Only your direct dependencies will show in `node_modules` and everything they depend on will be flattened in their `node_modules` folders. This obviously will eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be preferred. - #### `legacy-bundling` - Default: false @@ -87,7 +82,6 @@ Causes npm to install the package into your local `node_modules` folder with the Causes npm to install the package such that versions of npm prior to 1.4, such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with `global-style` this option will be preferred. - #### `strict-peer-deps` - Default: false @@ -99,7 +93,6 @@ By default, conflicting `peerDependencies` deep in the dependency graph will be When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure. - #### `package-lock` - Default: true @@ -109,7 +102,6 @@ If set to false, then ignore `package-lock.json` files when installing. This wil When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. - #### `omit` - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty. @@ -123,7 +115,6 @@ If a package type appears in both the `--include` and `--omit` lists, then it wi If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. - #### `ignore-scripts` - Default: false @@ -133,7 +124,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `audit` - Default: true @@ -141,7 +131,6 @@ Note that commands explicitly intended to run a particular script, such as `npm When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v7/commands/npm-audit) for details on what is submitted. - #### `bin-links` - Default: true @@ -151,7 +140,6 @@ Tells npm to create symlinks (or `.cmd` shims on Windows) for package executable Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems. - #### `fund` - Default: true @@ -159,7 +147,6 @@ Set to false to have it not do this. This can be used to work around the fact th When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v7/commands/npm-fund) for details. - #### `dry-run` - Default: false @@ -169,7 +156,6 @@ Indicates that you don't want npm to make any changes and that it should only re Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. - #### `workspace` - Default: @@ -187,7 +173,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -197,8 +182,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm install](/cli/v7/commands/npm-install) diff --git a/content/cli/v7/commands/npm-install.mdx b/content/cli/v7/commands/npm-install.mdx index 54db0594fbd..73fde85e4cf 100644 --- a/content/cli/v7/commands/npm-install.mdx +++ b/content/cli/v7/commands/npm-install.mdx @@ -318,7 +318,6 @@ See the [`config`](/cli/v7/using-npm/config) help doc. Many of the configuration These are some of the most common options related to installation. - #### `save` - Default: true @@ -328,7 +327,6 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. - #### `save-exact` - Default: false @@ -336,7 +334,6 @@ When used with the `npm rm` command, removes the dependency from package.json. Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator. - #### `global` - Default: false @@ -348,7 +345,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - #### `global-style` - Default: false @@ -356,7 +352,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold Causes npm to install the package into your local `node_modules` folder with the same layout it uses with the global `node_modules` folder. Only your direct dependencies will show in `node_modules` and everything they depend on will be flattened in their `node_modules` folders. This obviously will eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be preferred. - #### `legacy-bundling` - Default: false @@ -364,7 +359,6 @@ Causes npm to install the package into your local `node_modules` folder with the Causes npm to install the package such that versions of npm prior to 1.4, such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with `global-style` this option will be preferred. - #### `strict-peer-deps` - Default: false @@ -376,7 +370,6 @@ By default, conflicting `peerDependencies` deep in the dependency graph will be When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure. - #### `package-lock` - Default: true @@ -386,7 +379,6 @@ If set to false, then ignore `package-lock.json` files when installing. This wil When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. - #### `omit` - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty. @@ -400,7 +392,6 @@ If a package type appears in both the `--include` and `--omit` lists, then it wi If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. - #### `ignore-scripts` - Default: false @@ -410,7 +401,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `audit` - Default: true @@ -418,7 +408,6 @@ Note that commands explicitly intended to run a particular script, such as `npm When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v7/commands/npm-audit) for details on what is submitted. - #### `bin-links` - Default: true @@ -428,7 +417,6 @@ Tells npm to create symlinks (or `.cmd` shims on Windows) for package executable Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems. - #### `fund` - Default: true @@ -436,7 +424,6 @@ Set to false to have it not do this. This can be used to work around the fact th When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v7/commands/npm-fund) for details. - #### `dry-run` - Default: false @@ -446,7 +433,6 @@ Indicates that you don't want npm to make any changes and that it should only re Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. - #### `workspace` - Default: @@ -464,7 +450,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -474,8 +459,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### Algorithm Given a `package{dep}` structure: `A{B,C}, B{C}, C{D}`, the npm install algorithm produces: diff --git a/content/cli/v7/commands/npm-link.mdx b/content/cli/v7/commands/npm-link.mdx index aa74707ebf6..7c0c1753ace 100644 --- a/content/cli/v7/commands/npm-link.mdx +++ b/content/cli/v7/commands/npm-link.mdx @@ -95,7 +95,6 @@ If you _want_ to save the `file:` reference in your `package.json` and `package- ### Configuration - #### `save` - Default: true @@ -105,7 +104,6 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. - #### `save-exact` - Default: false @@ -113,7 +111,6 @@ When used with the `npm rm` command, removes the dependency from package.json. Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator. - #### `global` - Default: false @@ -125,7 +122,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - #### `global-style` - Default: false @@ -133,7 +129,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold Causes npm to install the package into your local `node_modules` folder with the same layout it uses with the global `node_modules` folder. Only your direct dependencies will show in `node_modules` and everything they depend on will be flattened in their `node_modules` folders. This obviously will eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be preferred. - #### `legacy-bundling` - Default: false @@ -141,7 +136,6 @@ Causes npm to install the package into your local `node_modules` folder with the Causes npm to install the package such that versions of npm prior to 1.4, such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with `global-style` this option will be preferred. - #### `strict-peer-deps` - Default: false @@ -153,7 +147,6 @@ By default, conflicting `peerDependencies` deep in the dependency graph will be When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure. - #### `package-lock` - Default: true @@ -163,7 +156,6 @@ If set to false, then ignore `package-lock.json` files when installing. This wil When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. - #### `omit` - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty. @@ -177,7 +169,6 @@ If a package type appears in both the `--include` and `--omit` lists, then it wi If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. - #### `ignore-scripts` - Default: false @@ -187,7 +178,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `audit` - Default: true @@ -195,7 +185,6 @@ Note that commands explicitly intended to run a particular script, such as `npm When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v7/commands/npm-audit) for details on what is submitted. - #### `bin-links` - Default: true @@ -205,7 +194,6 @@ Tells npm to create symlinks (or `.cmd` shims on Windows) for package executable Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems. - #### `fund` - Default: true @@ -213,7 +201,6 @@ Set to false to have it not do this. This can be used to work around the fact th When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v7/commands/npm-fund) for details. - #### `dry-run` - Default: false @@ -223,7 +210,6 @@ Indicates that you don't want npm to make any changes and that it should only re Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. - #### `workspace` - Default: @@ -241,7 +227,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -251,8 +236,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm developers](/cli/v7/using-npm/developers) diff --git a/content/cli/v7/commands/npm-logout.mdx b/content/cli/v7/commands/npm-logout.mdx index c70006ac75c..fb46ae6b0e0 100644 --- a/content/cli/v7/commands/npm-logout.mdx +++ b/content/cli/v7/commands/npm-logout.mdx @@ -37,7 +37,6 @@ If `--scope` is provided, this will find the credentials for the registry connec ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -45,7 +44,6 @@ If `--scope` is provided, this will find the credentials for the registry connec The base URL of the npm registry. - #### `scope` - Default: the scope of the current project, if any, or "" @@ -73,8 +71,6 @@ This will also cause `npm init` to create a scoped package. npm init --scope=@foo --yes ``` - - ### See Also - [npm adduser](/cli/v7/commands/npm-adduser) diff --git a/content/cli/v7/commands/npm-ls.mdx b/content/cli/v7/commands/npm-ls.mdx index f9de793393b..a52f76495ea 100644 --- a/content/cli/v7/commands/npm-ls.mdx +++ b/content/cli/v7/commands/npm-ls.mdx @@ -63,7 +63,6 @@ A thorough re-examination of the use cases, intention, behavior, and output of t ### Configuration - #### `all` - Default: false @@ -71,7 +70,6 @@ A thorough re-examination of the use cases, intention, behavior, and output of t When running `npm outdated` and `npm ls`, setting `--all` will show all outdated or installed packages, rather than only those directly depended upon by the current project. - #### `json` - Default: false @@ -83,7 +81,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `long` - Default: false @@ -91,7 +88,6 @@ Not supported by all npm commands. Show extended information in `ls`, `search`, and `help-search`. - #### `parseable` - Default: false @@ -99,7 +95,6 @@ Show extended information in `ls`, `search`, and `help-search`. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. - #### `global` - Default: false @@ -111,7 +106,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - #### `depth` - Default: `Infinity` if `--all` is set, otherwise `1` @@ -121,7 +115,6 @@ The depth to go when recursing packages for `npm ls`. If not set, `npm ls` will show only the immediate dependencies of the root project. If `--all` is set, then npm will show all dependencies by default. - #### `omit` - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty. @@ -135,7 +128,6 @@ If a package type appears in both the `--include` and `--omit` lists, then it wi If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. - #### `link` - Default: false @@ -143,7 +135,6 @@ If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment var Used with `npm ls`, limiting output to only those packages that are linked. - #### `package-lock-only` - Default: false @@ -155,7 +146,6 @@ For `update` this means only the `package-lock.json` will be updated, instead of For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`. - #### `unicode` - Default: false on windows, true on mac/unix systems with a unicode locale, as defined by the `LC_ALL`, `LC_CTYPE`, or `LANG` environment variables. @@ -163,7 +153,6 @@ For `list` this means the output will be based on the tree described by the `pac When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. - #### `workspace` - Default: @@ -181,7 +170,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -191,8 +179,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm explain](/cli/v7/commands/npm-explain) diff --git a/content/cli/v7/commands/npm-org.mdx b/content/cli/v7/commands/npm-org.mdx index 9346d8c56a5..78f775d2734 100644 --- a/content/cli/v7/commands/npm-org.mdx +++ b/content/cli/v7/commands/npm-org.mdx @@ -73,7 +73,6 @@ You can use the `npm org` commands to manage and view users of an organization. ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -81,7 +80,6 @@ You can use the `npm org` commands to manage and view users of an organization. The base URL of the npm registry. - #### `otp` - Default: null @@ -91,7 +89,6 @@ This is a one-time password from a two-factor authenticator. It's needed when pu If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. - #### `json` - Default: false @@ -103,7 +100,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `parseable` - Default: false @@ -111,8 +107,6 @@ Not supported by all npm commands. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. - - ### See Also - [using orgs](/cli/v7/using-npm/orgs) diff --git a/content/cli/v7/commands/npm-outdated.mdx b/content/cli/v7/commands/npm-outdated.mdx index 41dcb60dff7..9b576198295 100644 --- a/content/cli/v7/commands/npm-outdated.mdx +++ b/content/cli/v7/commands/npm-outdated.mdx @@ -74,7 +74,6 @@ A few things to note: ### Configuration - #### `all` - Default: false @@ -82,7 +81,6 @@ A few things to note: When running `npm outdated` and `npm ls`, setting `--all` will show all outdated or installed packages, rather than only those directly depended upon by the current project. - #### `json` - Default: false @@ -94,7 +92,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `long` - Default: false @@ -102,7 +99,6 @@ Not supported by all npm commands. Show extended information in `ls`, `search`, and `help-search`. - #### `parseable` - Default: false @@ -110,7 +106,6 @@ Show extended information in `ls`, `search`, and `help-search`. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. - #### `global` - Default: false @@ -122,7 +117,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - #### `workspace` - Default: @@ -140,8 +134,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - - ### See Also - [npm update](/cli/v7/commands/npm-update) diff --git a/content/cli/v7/commands/npm-owner.mdx b/content/cli/v7/commands/npm-owner.mdx index 930c0af587d..006e2ed565b 100644 --- a/content/cli/v7/commands/npm-owner.mdx +++ b/content/cli/v7/commands/npm-owner.mdx @@ -45,7 +45,6 @@ If you have two-factor authentication enabled with `auth-and-writes` (see [`npm- ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -53,7 +52,6 @@ If you have two-factor authentication enabled with `auth-and-writes` (see [`npm- The base URL of the npm registry. - #### `otp` - Default: null @@ -63,8 +61,6 @@ This is a one-time password from a two-factor authenticator. It's needed when pu If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. - - ### See Also - [npm profile](/cli/v7/commands/npm-profile) diff --git a/content/cli/v7/commands/npm-pack.mdx b/content/cli/v7/commands/npm-pack.mdx index 0176a1fd70a..4d774ad0629 100644 --- a/content/cli/v7/commands/npm-pack.mdx +++ b/content/cli/v7/commands/npm-pack.mdx @@ -27,7 +27,6 @@ npm pack [[<@scope>/]...] [--dry-run] [--json] ### Configuration - #### `dry-run` - Default: false @@ -37,7 +36,6 @@ Indicates that you don't want npm to make any changes and that it should only re Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. - #### `json` - Default: false @@ -49,7 +47,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `pack-destination` - Default: "." @@ -57,7 +54,6 @@ Not supported by all npm commands. Directory in which `npm pack` will save tarballs. - #### `workspace` - Default: @@ -75,7 +71,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -85,8 +80,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### Description For anything that's installable (that is, a package folder, tarball, tarball url, git url, name@tag, name@version, name, or scoped name), this command will fetch it to the cache, copy the tarball to the current working directory as `-.tgz`, and then write the filenames out to stdout. diff --git a/content/cli/v7/commands/npm-ping.mdx b/content/cli/v7/commands/npm-ping.mdx index 6c90de66679..89160067694 100644 --- a/content/cli/v7/commands/npm-ping.mdx +++ b/content/cli/v7/commands/npm-ping.mdx @@ -43,7 +43,6 @@ Ping error: {*Detail about error} ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -51,8 +50,6 @@ Ping error: {*Detail about error} The base URL of the npm registry. - - ### See Also - [npm doctor](/cli/v7/commands/npm-doctor) diff --git a/content/cli/v7/commands/npm-pkg.mdx b/content/cli/v7/commands/npm-pkg.mdx index 2c740b16115..739bb845563 100644 --- a/content/cli/v7/commands/npm-pkg.mdx +++ b/content/cli/v7/commands/npm-pkg.mdx @@ -149,7 +149,6 @@ npm pkg get name version --ws ### Configuration - #### `force` - Default: false @@ -170,7 +169,6 @@ Removes various protections against unfortunate side effects, common mistakes, u If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! - #### `json` - Default: false @@ -182,7 +180,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `workspace` - Default: @@ -200,7 +197,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -210,8 +206,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ## See Also - [npm install](/cli/v7/commands/npm-install) diff --git a/content/cli/v7/commands/npm-prefix.mdx b/content/cli/v7/commands/npm-prefix.mdx index fa0067309de..02280d89e75 100644 --- a/content/cli/v7/commands/npm-prefix.mdx +++ b/content/cli/v7/commands/npm-prefix.mdx @@ -47,7 +47,6 @@ npm prefix -g ### Configuration - #### `global` - Default: false @@ -59,8 +58,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - - ### See Also - [npm root](/cli/v7/commands/npm-root) diff --git a/content/cli/v7/commands/npm-profile.mdx b/content/cli/v7/commands/npm-profile.mdx index 96e3f377020..341dc3e2907 100644 --- a/content/cli/v7/commands/npm-profile.mdx +++ b/content/cli/v7/commands/npm-profile.mdx @@ -78,7 +78,6 @@ Some of these commands may not be available on non npmjs.com registries. ### Configuration - #### `registry` - Default: "https://registry.npmjs.org/" @@ -86,7 +85,6 @@ Some of these commands may not be available on non npmjs.com registries. The base URL of the npm registry. - #### `json` - Default: false @@ -98,7 +96,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `parseable` - Default: false @@ -106,7 +103,6 @@ Not supported by all npm commands. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. - #### `otp` - Default: null @@ -116,8 +112,6 @@ This is a one-time password from a two-factor authenticator. It's needed when pu If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. - - ### See Also - [npm adduser](/cli/v7/commands/npm-adduser) diff --git a/content/cli/v7/commands/npm-prune.mdx b/content/cli/v7/commands/npm-prune.mdx index 7e52760b7c5..a6e5ea2c7b0 100644 --- a/content/cli/v7/commands/npm-prune.mdx +++ b/content/cli/v7/commands/npm-prune.mdx @@ -41,7 +41,6 @@ In normal operation, extraneous modules are pruned automatically, so you'll only ### Configuration - #### `omit` - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty. @@ -55,7 +54,6 @@ If a package type appears in both the `--include` and `--omit` lists, then it wi If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. - #### `dry-run` - Default: false @@ -65,7 +63,6 @@ Indicates that you don't want npm to make any changes and that it should only re Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. - #### `json` - Default: false @@ -77,7 +74,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `workspace` - Default: @@ -95,7 +91,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -105,8 +100,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm uninstall](/cli/v7/commands/npm-uninstall) diff --git a/content/cli/v7/commands/npm-publish.mdx b/content/cli/v7/commands/npm-publish.mdx index 4737f152d77..fbf9e9a6d6d 100644 --- a/content/cli/v7/commands/npm-publish.mdx +++ b/content/cli/v7/commands/npm-publish.mdx @@ -78,7 +78,6 @@ See [`developers`](/cli/v7/using-npm/developers) for full details on what's incl ### Configuration - #### `tag` - Default: "latest" @@ -90,7 +89,6 @@ Also the tag that is added to the package@version specified by the `npm tag` com When used by the `npm diff` command, this is the tag used to fetch the tarball that will be compared with the local files by default. - #### `access` - Default: 'restricted' for scoped packages, 'public' for unscoped packages @@ -100,7 +98,6 @@ When publishing scoped packages, the access level defaults to `restricted`. If y Note: Using the `--access` flag on the `npm publish` command will only set the package access level on the initial publish of the package. Any subsequent `npm publish` commands using the `--access` flag will not have an effect to the access level. To make changes to the access level after the initial publish use `npm access`. - #### `dry-run` - Default: false @@ -110,7 +107,6 @@ Indicates that you don't want npm to make any changes and that it should only re Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. - #### `otp` - Default: null @@ -120,7 +116,6 @@ This is a one-time password from a two-factor authenticator. It's needed when pu If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. - #### `workspace` - Default: @@ -138,7 +133,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -148,8 +142,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm-packlist package](http://npm.im/npm-packlist) diff --git a/content/cli/v7/commands/npm-rebuild.mdx b/content/cli/v7/commands/npm-rebuild.mdx index 68308326cac..90e40b322a4 100644 --- a/content/cli/v7/commands/npm-rebuild.mdx +++ b/content/cli/v7/commands/npm-rebuild.mdx @@ -35,7 +35,6 @@ If one or more package names (and optionally version ranges) are provided, then ### Configuration - #### `global` - Default: false @@ -47,7 +46,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - #### `bin-links` - Default: true @@ -57,7 +55,6 @@ Tells npm to create symlinks (or `.cmd` shims on Windows) for package executable Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems. - #### `ignore-scripts` - Default: false @@ -67,7 +64,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `workspace` - Default: @@ -85,7 +81,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -95,8 +90,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm install](/cli/v7/commands/npm-install) diff --git a/content/cli/v7/commands/npm-repo.mdx b/content/cli/v7/commands/npm-repo.mdx index 9db8be568ea..be210fd9935 100644 --- a/content/cli/v7/commands/npm-repo.mdx +++ b/content/cli/v7/commands/npm-repo.mdx @@ -31,7 +31,6 @@ This command tries to guess at the likely location of a package's repository URL ### Configuration - #### `browser` - Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -43,7 +42,6 @@ Set to `false` to suppress browser behavior and instead print urls to terminal. Set to `true` to use default system URL opener. - #### `workspace` - Default: @@ -61,7 +59,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -71,8 +68,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - - ### See Also - [npm docs](/cli/v7/commands/npm-docs) diff --git a/content/cli/v7/commands/npm-restart.mdx b/content/cli/v7/commands/npm-restart.mdx index 268cd8c895e..753254ac473 100644 --- a/content/cli/v7/commands/npm-restart.mdx +++ b/content/cli/v7/commands/npm-restart.mdx @@ -48,7 +48,6 @@ If it does _not_ have a `"restart"` script specified, but it does have `stop` an ### Configuration - #### `ignore-scripts` - Default: false @@ -58,7 +57,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `script-shell` - Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -66,8 +64,6 @@ Note that commands explicitly intended to run a particular script, such as `npm The shell to use for scripts run with the `npm exec`, `npm run` and `npm init ` commands. - - ### See Also - [npm run-script](/cli/v7/commands/npm-run-script) diff --git a/content/cli/v7/commands/npm-root.mdx b/content/cli/v7/commands/npm-root.mdx index 73b4cbb5b09..32a6feb11fb 100644 --- a/content/cli/v7/commands/npm-root.mdx +++ b/content/cli/v7/commands/npm-root.mdx @@ -39,7 +39,6 @@ echo "Global packages installed in: ${global_node_modules}" ### Configuration - #### `global` - Default: false @@ -51,8 +50,6 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold - bin files are linked to `{prefix}/bin` - man pages are linked to `{prefix}/share/man` - - ### See Also - [npm prefix](/cli/v7/commands/npm-prefix) diff --git a/content/cli/v7/commands/npm-run-script.mdx b/content/cli/v7/commands/npm-run-script.mdx index 936c990b723..b1c3a6bd758 100644 --- a/content/cli/v7/commands/npm-run-script.mdx +++ b/content/cli/v7/commands/npm-run-script.mdx @@ -117,7 +117,6 @@ This last command will run `test` in both `./packages/a` and `./packages/b` pack ### Configuration - #### `workspace` - Default: @@ -135,7 +134,6 @@ When set for the `npm init` command, this may be set to the folder of a workspac This value is not exported to the environment for child processes. - #### `workspaces` - Default: false @@ -145,7 +143,6 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. - #### `if-present` - Default: false @@ -153,7 +150,6 @@ This value is not exported to the environment for child processes. If true, npm will not exit with an error code when `run-script` is invoked for a script that isn't defined in the `scripts` section of `package.json`. This option can be used when it's desirable to optionally run a script when it's present and fail if the script fails. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup. - #### `ignore-scripts` - Default: false @@ -163,7 +159,6 @@ If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts. - #### `script-shell` - Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -171,8 +166,6 @@ Note that commands explicitly intended to run a particular script, such as `npm The shell to use for scripts run with the `npm exec`, `npm run` and `npm init ` commands. - - ### See Also - [npm scripts](/cli/v7/using-npm/scripts) diff --git a/content/cli/v7/commands/npm-search.mdx b/content/cli/v7/commands/npm-search.mdx index 667776ed0ae..c8b977fd5e8 100644 --- a/content/cli/v7/commands/npm-search.mdx +++ b/content/cli/v7/commands/npm-search.mdx @@ -41,7 +41,6 @@ If a term starts with `/`, then it's interpreted as a regular expression and sup ### Configuration - #### `long` - Default: false @@ -49,7 +48,6 @@ If a term starts with `/`, then it's interpreted as a regular expression and sup Show extended information in `ls`, `search`, and `help-search`. - #### `json` - Default: false @@ -61,7 +59,6 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. - #### `color` - Default: true unless the NO_COLOR environ is set to something other than '0' @@ -69,7 +66,6 @@ Not supported by all npm commands. If false, never shows colors. If `"always"` then always shows colors. If true, then only prints color codes for tty file descriptors. - #### `parseable` - Default: false @@ -77,7 +73,6 @@ If false, never shows colors. If `"always"` then always shows colors. If true, t Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. - #### `description` - Default: true @@ -85,7 +80,6 @@ Output parseable results from commands that write to standard output. For `npm s Show the description in `npm search` - #### `searchopts` - Default: "" @@ -93,7 +87,6 @@ Show the description in `npm search` Space-separated options that are always passed to search. - #### `searchexclude` - Default: "" @@ -101,7 +94,6 @@ Space-separated options that are always passed to search. Space-separated options that limit the results from search. - #### `registry` - Default: "https://registry.npmjs.org/" @@ -109,7 +101,6 @@ Space-separated options that limit the results from search. The base URL of the npm registry. - #### `prefer-online` - Default: false @@ -117,7 +108,6 @@ The base URL of the npm registry. If true, staleness checks for cached data will be forced, making the CLI look for updates immediately even for fresh package data. - #### `prefer-offline` - Default: false @@ -125,7 +115,6 @@ If true, staleness checks for cached data will be forced, making the CLI look fo If true, staleness checks for cached data will be bypassed, but missing data will be requested from the server. To force full offline mode, use `--offline`. - #### `offline` - Default: false @@ -133,8 +122,6 @@ If true, staleness checks for cached data will be bypassed, but missing data wil Force offline mode: no network requests will be done during install. To allow the CLI to fill in missing cache data, see `--prefer-offline`. - - ### See Also - [npm registry](/cli/v7/using-npm/registry) diff --git a/content/cli/v7/commands/npm-set-script.mdx b/content/cli/v7/commands/npm-set-script.mdx index a6d94ebc1f0..56d1ac1bc2e 100644 --- a/content/cli/v7/commands/npm-set-script.mdx +++ b/content/cli/v7/commands/npm-set-script.mdx @@ -43,7 +43,6 @@ npm set-script [