diff options
| author | Ruy Adorno <ruyadorno@hotmail.com> | 2021-03-23 21:58:11 +0300 |
|---|---|---|
| committer | Ruy Adorno <ruyadorno@hotmail.com> | 2021-03-24 05:10:30 +0300 |
| commit | 73b3e06c910549a7fd3c8f49324ab14e0adf2c8d (patch) | |
| tree | e7f0ab70d8bb09a6212f8a22da25dc07410e6967 /deps/npm/docs/output/commands | |
| parent | f2090877f1f727020099ef9e30cc70e10b10f900 (diff) | |
deps: upgrade npm to 7.7.0
PR-URL: https://github.com/nodejs/node/pull/37879
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'deps/npm/docs/output/commands')
33 files changed, 339 insertions, 7 deletions
diff --git a/deps/npm/docs/output/commands/npm-adduser.html b/deps/npm/docs/output/commands/npm-adduser.html index 95f0cdaa711..a079dfed71e 100644 --- a/deps/npm/docs/output/commands/npm-adduser.html +++ b/deps/npm/docs/output/commands/npm-adduser.html @@ -149,6 +149,7 @@ npm command-line interface aliases: login, add-user </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Create or verify a user named <code><username></code> in the specified registry, and save the credentials to the <code>.npmrc</code> file. If no registry is specified, diff --git a/deps/npm/docs/output/commands/npm-bin.html b/deps/npm/docs/output/commands/npm-bin.html index 703c9e9243b..61455202594 100644 --- a/deps/npm/docs/output/commands/npm-bin.html +++ b/deps/npm/docs/output/commands/npm-bin.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm bin [-g|--global] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Print the folder where npm will install executables.</p> <h3 id="see-also">See Also</h3> diff --git a/deps/npm/docs/output/commands/npm-cache.html b/deps/npm/docs/output/commands/npm-cache.html index 9dbf83b31a8..22ca6f1999b 100644 --- a/deps/npm/docs/output/commands/npm-cache.html +++ b/deps/npm/docs/output/commands/npm-cache.html @@ -155,6 +155,7 @@ aliases: npm cache clear, npm cache rm npm cache verify </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Used to add, list, or clean the npm cache folder.</p> <ul> diff --git a/deps/npm/docs/output/commands/npm-completion.html b/deps/npm/docs/output/commands/npm-completion.html index 4f7016e4ac9..b99d52b420d 100644 --- a/deps/npm/docs/output/commands/npm-completion.html +++ b/deps/npm/docs/output/commands/npm-completion.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>source <(npm completion) </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Enables tab-completion in all npm commands.</p> <p>The synopsis above diff --git a/deps/npm/docs/output/commands/npm-config.html b/deps/npm/docs/output/commands/npm-config.html index 92456282278..55f6e5ffe64 100644 --- a/deps/npm/docs/output/commands/npm-config.html +++ b/deps/npm/docs/output/commands/npm-config.html @@ -155,6 +155,7 @@ npm get [<key> [<key> ...]] alias: c </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>npm gets its config settings from the command line, environment variables, <code>npmrc</code> files, and in some cases, the <code>package.json</code> file.</p> diff --git a/deps/npm/docs/output/commands/npm-dedupe.html b/deps/npm/docs/output/commands/npm-dedupe.html index 8a0ec7e0f77..ccd9a03f4d8 100644 --- a/deps/npm/docs/output/commands/npm-dedupe.html +++ b/deps/npm/docs/output/commands/npm-dedupe.html @@ -136,7 +136,7 @@ npm command-line interface <section id="content"> <header class="title"> <h1 id="npm-dedupe">npm-dedupe</h1> -<span class="description">Reduce duplication</span> +<span class="description">Reduce duplication in the package tree</span> </header> <section id="table_of_contents"> @@ -148,7 +148,7 @@ npm command-line interface <pre lang="bash"><code>npm dedupe npm ddp -aliases: find-dupes, ddp +aliases: ddp </code></pre> <h3 id="description">Description</h3> <p>Searches the local package tree and attempts to simplify the overall @@ -193,6 +193,7 @@ result in new modules being installed.</p> <p>Using <code>npm find-dupes</code> will run the command in <code>--dry-run</code> mode.</p> <h3 id="see-also">See Also</h3> <ul> +<li><a href="../cli-commands/find-dupes.html">npm find-dupes</a></li> <li><a href="../cli-commands/ls.html">npm ls</a></li> <li><a href="../cli-commands/update.html">npm update</a></li> <li><a href="../cli-commands/install.html">npm install</a></li> diff --git a/deps/npm/docs/output/commands/npm-deprecate.html b/deps/npm/docs/output/commands/npm-deprecate.html index 949be43d9be..88299a80bcf 100644 --- a/deps/npm/docs/output/commands/npm-deprecate.html +++ b/deps/npm/docs/output/commands/npm-deprecate.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm deprecate <pkg>[@<version range>] <message> </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it.</p> diff --git a/deps/npm/docs/output/commands/npm-doctor.html b/deps/npm/docs/output/commands/npm-doctor.html index a9b2001543d..9ae14057552 100644 --- a/deps/npm/docs/output/commands/npm-doctor.html +++ b/deps/npm/docs/output/commands/npm-doctor.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm doctor </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p><code>npm doctor</code> runs a set of checks to ensure that your npm installation has what it needs to manage your JavaScript packages. npm is mostly a diff --git a/deps/npm/docs/output/commands/npm-edit.html b/deps/npm/docs/output/commands/npm-edit.html index 7ebb443a2f6..8c4ee5ed1a7 100644 --- a/deps/npm/docs/output/commands/npm-edit.html +++ b/deps/npm/docs/output/commands/npm-edit.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm edit <pkg> </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Selects a dependency in the current project and opens the package folder in the default editor (or whatever you’ve configured as the npm <code>editor</code> diff --git a/deps/npm/docs/output/commands/npm-exec.html b/deps/npm/docs/output/commands/npm-exec.html index 03059c52052..f8f882a2c54 100644 --- a/deps/npm/docs/output/commands/npm-exec.html +++ b/deps/npm/docs/output/commands/npm-exec.html @@ -141,7 +141,7 @@ npm command-line interface <section id="table_of_contents"> <h2 id="table-of-contents">Table of contents</h2> -<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#npx-vs-npm-exec"><code>npx</code> vs <code>npm exec</code></a></li><li><a href="#examples">Examples</a></li><li><a href="#compatibility-with-older-npx-versions">Compatibility with Older npx Versions</a></li><li><a href="#a-note-on-caching">A note on caching</a></li><ul><li><a href="#prefer-online">prefer-online</a></li><li><a href="#prefer-offline">prefer-offline</a></li><li><a href="#offline">offline</a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> +<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#npx-vs-npm-exec"><code>npx</code> vs <code>npm exec</code></a></li><li><a href="#examples">Examples</a></li><li><a href="#workspaces-support">Workspaces support</a></li><ul><li><a href="#filtering-workspaces">Filtering workspaces</a></li></ul><li><a href="#compatibility-with-older-npx-versions">Compatibility with Older npx Versions</a></li><li><a href="#a-note-on-caching">A note on caching</a></li><ul><li><a href="#prefer-online">prefer-online</a></li><li><a href="#prefer-offline">prefer-offline</a></li><li><a href="#offline">offline</a></li><li><a href="#workspace">workspace</a></li><li><a href="#workspaces">workspaces</a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> </section> <div id="_content"><h3 id="synopsis">Synopsis</h3> @@ -149,6 +149,7 @@ npm command-line interface npm exec --package=<pkg>[@<version>] -- <cmd> [args...] npm exec -c '<cmd> [args...]' npm exec --package=foo -c '<cmd> [args...]' +npm exec [-ws] [-w <workspace-name] [args...] npx <pkg>[@<specifier>] [args...] npx -p <pkg>[@<specifier>] <cmd> [args...] @@ -247,6 +248,49 @@ $ npx --package=foo bar --bar-argument <pre><code>$ npm x -c 'eslint && say "hooray, lint passed"' $ npx -c 'eslint && say "hooray, lint passed"' </code></pre> +<h3 id="workspaces-support">Workspaces support</h3> +<p>You may use the <code>workspace</code> or <code>workspaces</code> configs in order to run an +arbitrary command from an npm package (either one installed locally, or fetched +remotely) in the context of the specified workspaces. +If no positional argument or <code>--call</code> option is provided, it will open an +interactive subshell in the context of each of these configured workspaces one +at a time.</p> +<p>Given a project with configured workspaces, e.g:</p> +<pre><code>. ++-- package.json +`-- packages + +-- a + | `-- package.json + +-- b + | `-- package.json + `-- c + `-- package.json +</code></pre> +<p>Assuming the workspace configuration is properly set up at the root level +<code>package.json</code> file. e.g:</p> +<pre><code>{ + "workspaces": [ "./packages/*" ] +} +</code></pre> +<p>You can execute an arbitrary command from a package in the context of each of +the configured workspaces when using the <code>workspaces</code> configuration options, +in this example we’re using <strong>eslint</strong> to lint any js file found within each +workspace folder:</p> +<pre><code>npm exec -ws -- eslint ./*.js +</code></pre> +<h4 id="filtering-workspaces">Filtering workspaces</h4> +<p>It’s also possible to execute a command in a single workspace using the +<code>workspace</code> config along with a name or directory path:</p> +<pre><code>npm exec --workspace=a -- eslint ./*.js +</code></pre> +<p>The <code>workspace</code> config can also be specified multiple times in order to run a +specific script in the context of multiple workspaces. When defining values for +the <code>workspace</code> config in the command line, it also possible to use <code>-w</code> as a +shorthand, e.g:</p> +<pre><code>npm exec -w a -w b -- eslint ./*.js +</code></pre> +<p>This last command will run the <code>eslint</code> command in both <code>./packages/a</code> and +<code>./packages/b</code> folders.</p> <h3 id="compatibility-with-older-npx-versions">Compatibility with Older npx Versions</h3> <p>The <code>npx</code> binary was rewritten in npm v7.0.0, and the standalone <code>npx</code> package deprecated at that time. <code>npx</code> uses the <code>npm exec</code> @@ -287,6 +331,29 @@ requested from the server. To force full offline mode, use <code>offline</code>. <h4 id="offline">offline</h4> <p>Forces full offline mode. Any packages not locally cached will result in an error.</p> +<h4 id="workspace">workspace</h4> +<ul> +<li>Alias: <code>-w</code></li> +<li>Type: Array</li> +<li>Default: <code>[]</code></li> +</ul> +<p>Enable running scripts in the context of workspaces while also filtering by +the provided names or paths provided.</p> +<p>Valid values for the <code>workspace</code> config are either:</p> +<ul> +<li>Workspace names</li> +<li>Path to a workspace directory</li> +<li>Path to a parent workspace directory (will result to selecting all of the +children workspaces)</li> +</ul> +<h4 id="workspaces">workspaces</h4> +<ul> +<li>Alias: <code>-ws</code></li> +<li>Type: Boolean</li> +<li>Default: <code>false</code></li> +</ul> +<p>Run scripts in the context of all configured workspaces for the current +project.</p> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-run-script.html">npm run-script</a></li> diff --git a/deps/npm/docs/output/commands/npm-explore.html b/deps/npm/docs/output/commands/npm-explore.html index 0bb35050226..cd52ff96a68 100644 --- a/deps/npm/docs/output/commands/npm-explore.html +++ b/deps/npm/docs/output/commands/npm-explore.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm explore <pkg> [ -- <command>] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Spawn a subshell in the directory of the installed package specified.</p> <p>If a command is specified, then it is run in the subshell, which then diff --git a/deps/npm/docs/output/commands/npm-find-dupes.html b/deps/npm/docs/output/commands/npm-find-dupes.html new file mode 100644 index 00000000000..32d8993b99c --- /dev/null +++ b/deps/npm/docs/output/commands/npm-find-dupes.html @@ -0,0 +1,174 @@ +<html><head> +<title>npm-find-dupes</title> +<style> +body { + background-color: #ffffff; + color: #24292e; + + margin: 0; + + line-height: 1.5; + + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; +} +#rainbar { + height: 10px; + background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); +} + +a { + text-decoration: none; + color: #0366d6; +} +a:hover { + text-decoration: underline; +} + +pre { + margin: 1em 0px; + padding: 1em; + border: solid 1px #e1e4e8; + border-radius: 6px; + + display: block; + overflow: auto; + + white-space: pre; + + background-color: #f6f8fa; + color: #393a34; +} +code { + font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; + font-size: 85%; + padding: 0.2em 0.4em; + background-color: #f6f8fa; + color: #393a34; +} +pre > code { + padding: 0; + background-color: inherit; + color: inherit; +} +h1, h2, h3 { + font-weight: 600; +} + +#logobar { + background-color: #333333; + margin: 0 auto; + padding: 1em 4em; +} +#logobar .logo { + float: left; +} +#logobar .title { + font-weight: 600; + color: #dddddd; + float: left; + margin: 5px 0 0 1em; +} +#logobar:after { + content: ""; + display: block; + clear: both; +} + +#content { + margin: 0 auto; + padding: 0 4em; +} + +#table_of_contents > h2 { + font-size: 1.17em; +} +#table_of_contents ul:first-child { + border: solid 1px #e1e4e8; + border-radius: 6px; + padding: 1em; + background-color: #f6f8fa; + color: #393a34; +} +#table_of_contents ul { + list-style-type: none; + padding-left: 1.5em; +} +#table_of_contents li { + font-size: 0.9em; +} +#table_of_contents li a { + color: #000000; +} + +header.title { + border-bottom: solid 1px #e1e4e8; +} +header.title > h1 { + margin-bottom: 0.25em; +} +header.title > .description { + display: block; + margin-bottom: 0.5em; + line-height: 1; +} + +footer#edit { + border-top: solid 1px #e1e4e8; + margin: 3em 0 4em 0; + padding-top: 2em; +} +</style> +</head> +<body> +<div id="banner"> +<div id="rainbar"></div> +<div id="logobar"> +<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> +<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> +<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> +</svg> +<div class="title"> +npm command-line interface +</div> +</div> +</div> + +<section id="content"> +<header class="title"> +<h1 id="npm-find-dupes">npm-find-dupes</h1> +<span class="description">Find duplication in the package tree</span> +</header> + +<section id="table_of_contents"> +<h2 id="table-of-contents">Table of contents</h2> +<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#see-also">See Also</a></li></ul></div> +</section> + +<div id="_content"><h3 id="synopsis">Synopsis</h3> +<pre lang="bash"><code>npm find-dupes +</code></pre> +<h3 id="description">Description</h3> +<p>Runs <code>npm dedupe</code> in <code>--dry-run</code> mode, making npm only output the +duplications, without actually changing the package tree.</p> +<h3 id="see-also">See Also</h3> +<ul> +<li><a href="../cli-commands/dedupe.html">npm dedupe</a></li> +<li><a href="../cli-commands/ls.html">npm ls</a></li> +<li><a href="../cli-commands/update.html">npm update</a></li> +<li><a href="../cli-commands/install.html">npm install</a></li> +</ul> +</div> + +<footer id="edit"> +<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-find-dupes.md"> +<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> +<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path> +</svg> +Edit this page on GitHub +</a> +</footer> +</section> + + + +</body></html>
\ No newline at end of file diff --git a/deps/npm/docs/output/commands/npm-help-search.html b/deps/npm/docs/output/commands/npm-help-search.html index 00ebe9bf6ca..77456ef5493 100644 --- a/deps/npm/docs/output/commands/npm-help-search.html +++ b/deps/npm/docs/output/commands/npm-help-search.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm help-search <text> </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance.</p> diff --git a/deps/npm/docs/output/commands/npm-help.html b/deps/npm/docs/output/commands/npm-help.html index e4f4226a5d2..0327d1788f1 100644 --- a/deps/npm/docs/output/commands/npm-help.html +++ b/deps/npm/docs/output/commands/npm-help.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm help <term> [<terms..>] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>If supplied a topic, then show the appropriate documentation page.</p> <p>If the topic does not exist, or if multiple terms are provided, then npm diff --git a/deps/npm/docs/output/commands/npm-hook.html b/deps/npm/docs/output/commands/npm-hook.html index dd7015df1b4..2921e7e12c0 100644 --- a/deps/npm/docs/output/commands/npm-hook.html +++ b/deps/npm/docs/output/commands/npm-hook.html @@ -150,6 +150,7 @@ npm hook add <entity> <url> <secret> npm hook update <id> <url> [secret] npm hook rm <id> </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Allows you to manage <a href="https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm">npm hooks</a>, diff --git a/deps/npm/docs/output/commands/npm-init.html b/deps/npm/docs/output/commands/npm-init.html index 3abf8e967b4..62dc20093b2 100644 --- a/deps/npm/docs/output/commands/npm-init.html +++ b/deps/npm/docs/output/commands/npm-init.html @@ -136,7 +136,7 @@ npm command-line interface <section id="content"> <header class="title"> <h1 id="npm-init">npm-init</h1> -<span class="description">create a package.json file</span> +<span class="description">Create a package.json file</span> </header> <section id="table_of_contents"> diff --git a/deps/npm/docs/output/commands/npm-logout.html b/deps/npm/docs/output/commands/npm-logout.html index 02de412c731..4e19888ee84 100644 --- a/deps/npm/docs/output/commands/npm-logout.html +++ b/deps/npm/docs/output/commands/npm-logout.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm logout [--registry=<url>] [--scope=<@scope>] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>When logged into a registry that supports token-based authentication, tell the server to end this token’s session. This will invalidate the token diff --git a/deps/npm/docs/output/commands/npm-ls.html b/deps/npm/docs/output/commands/npm-ls.html index ae1e1a84c72..454c5567442 100644 --- a/deps/npm/docs/output/commands/npm-ls.html +++ b/deps/npm/docs/output/commands/npm-ls.html @@ -159,7 +159,7 @@ tree at all, use <a href="../commands/npm-explain.html"><code>npm explain</code> the results to only the paths to the packages named. Note that nested packages will <em>also</em> show the paths to the specified packages. For example, running <code>npm ls promzard</code> in npm’s source tree will show:</p> -<pre lang="bash"><code>npm@7.6.3 /path/to/npm +<pre lang="bash"><code>npm@7.7.0 /path/to/npm └─┬ init-package-json@0.0.4 └── promzard@0.1.5 </code></pre> diff --git a/deps/npm/docs/output/commands/npm-org.html b/deps/npm/docs/output/commands/npm-org.html index d97f638b22d..50c09956505 100644 --- a/deps/npm/docs/output/commands/npm-org.html +++ b/deps/npm/docs/output/commands/npm-org.html @@ -149,6 +149,7 @@ npm command-line interface npm org rm <orgname> <username> npm org ls <orgname> [<username>] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="example">Example</h3> <p>Add a new developer to an org:</p> <pre lang="bash"><code>$ npm org set my-org @mx-smith diff --git a/deps/npm/docs/output/commands/npm-owner.html b/deps/npm/docs/output/commands/npm-owner.html index 77f072da40b..ada60ea0951 100644 --- a/deps/npm/docs/output/commands/npm-owner.html +++ b/deps/npm/docs/output/commands/npm-owner.html @@ -151,6 +151,7 @@ npm owner ls [<@scope>/]<pkg> aliases: author </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Manage ownership of published packages.</p> <ul> diff --git a/deps/npm/docs/output/commands/npm-ping.html b/deps/npm/docs/output/commands/npm-ping.html index e00fb30a01c..ca124a18595 100644 --- a/deps/npm/docs/output/commands/npm-ping.html +++ b/deps/npm/docs/output/commands/npm-ping.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm ping [--registry <registry>] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Ping the configured or given npm registry and verify authentication. If it works it will output something like:</p> diff --git a/deps/npm/docs/output/commands/npm-prefix.html b/deps/npm/docs/output/commands/npm-prefix.html index a330dfd1c37..493a1f8950b 100644 --- a/deps/npm/docs/output/commands/npm-prefix.html +++ b/deps/npm/docs/output/commands/npm-prefix.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm prefix [-g] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Print the local prefix to standard output. This is the closest parent directory to contain a <code>package.json</code> file or <code>node_modules</code> directory, unless <code>-g</code> is diff --git a/deps/npm/docs/output/commands/npm-profile.html b/deps/npm/docs/output/commands/npm-profile.html index 91013567a20..f103446479c 100644 --- a/deps/npm/docs/output/commands/npm-profile.html +++ b/deps/npm/docs/output/commands/npm-profile.html @@ -151,6 +151,7 @@ npm profile set password npm profile enable-2fa [auth-and-writes|auth-only] npm profile disable-2fa </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Change your profile information on the registry. Note that this command depends on the registry implementation, so third-party registries may not diff --git a/deps/npm/docs/output/commands/npm-run-script.html b/deps/npm/docs/output/commands/npm-run-script.html index a78a434760b..6fc343dfbaf 100644 --- a/deps/npm/docs/output/commands/npm-run-script.html +++ b/deps/npm/docs/output/commands/npm-run-script.html @@ -141,11 +141,13 @@ npm command-line interface <section id="table_of_contents"> <h2 id="table-of-contents">Table of contents</h2> -<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#if-present">if-present</a></li><li><a href="#ignore-scripts">ignore-scripts</a></li><li><a href="#script-shell">script-shell</a></li><li><a href="#silent">silent</a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> +<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#workspaces-support">Workspaces support</a></li><ul><li><a href="#filtering-workspaces">Filtering workspaces</a></li></ul><li><a href="#configuration">Configuration</a></li><ul><li><a href="#if-present">if-present</a></li><li><a href="#ignore-scripts">ignore-scripts</a></li><li><a href="#script-shell">script-shell</a></li><li><a href="#silent">silent</a></li><li><a href="#workspace">workspace</a></li><li><a href="#workspaces">workspaces</a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> </section> <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm run-script <command> [--if-present] [--silent] [-- <args>] +npm run-script <command> [--workspace=<workspace-name>] +npm run-script <command> [--workspaces] aliases: run, rum, urn </code></pre> @@ -196,6 +198,45 @@ found in the <code>PATH</code>.</p> <p>If you try to run a script without having a <code>node_modules</code> directory and it fails, you will be given a warning to run <code>npm install</code>, just in case you’ve forgotten.</p> +<h3 id="workspaces-support">Workspaces support</h3> +<p>You may use the <code>workspace</code> or <code>workspaces</code> configs in order to run an +arbitrary command from a package’s <code>"scripts"</code> object in the context of the +specified workspaces. If no <code>"command"</code> is provided, it will list the available +scripts for each of these configured workspaces.</p> +<p>Given a project with configured workspaces, e.g:</p> +<pre><code>. ++-- package.json +`-- packages + +-- a + | `-- package.json + +-- b + | `-- package.json + `-- c + `-- package.json +</code></pre> +<p>Assuming the workspace configuration is properly set up at the root level +<code>package.json</code> file. e.g:</p> +<pre><code>{ + "workspaces": [ "./packages/*" ] +} +</code></pre> +<p>And that each of the configured workspaces has a configured <code>test</code> script, +we can run tests in all of them using the <code>workspaces</code> config:</p> +<pre><code>npm test --workspaces +</code></pre> +<h4 id="filtering-workspaces">Filtering workspaces</h4> +<p>It’s also possible to run a script in a single workspace using the <code>workspace</code> +config along with a name or directory path:</p> +<pre><code>npm test --workspace=a +</code></pre> +<p>The <code>workspace</code> config can also be specified multiple times in order to run a +specific script in the context of multiple workspaces. When defining values for +the <code>workspace</code> config in the command line, it also possible to use <code>-w</code> as a +shorthand, e.g:</p> +<pre><code>npm test -w a -w b +</code></pre> +<p>This last command will run <code>test</code> in both <code>./packages/a</code> and <code>./packages/b</code> +packages.</p> <h3 id="configuration">Configuration</h3> <h4 id="if-present">if-present</h4> <ul> @@ -224,6 +265,29 @@ to <code>/bin/sh</code> on Unix, defaults to <code>env.comspec</code> or <code>c <li>Default: false</li> </ul> <p>You can use the <code>--silent</code> flag to prevent showing <code>npm ERR!</code> output on error.</p> +<h4 id="workspace">workspace</h4> +<ul> +<li>Alias: <code>-w</code></li> +<li>Type: Array</li> +<li>Default: <code>[]</code></li> +</ul> +<p>Enable running scripts in the context of workspaces while also filtering by +the provided names or paths provided.</p> +<p>Valid values for the <code>workspace</code> config are either:</p> +<ul> +<li>Workspace names</li> +<li>Path to a workspace directory</li> +<li>Path to a parent workspace directory (will result to selecting all of the +children workspaces)</li> +</ul> +<h4 id="workspaces">workspaces</h4> +<ul> +<li>Alias: <code>-ws</code></li> +<li>Type: Boolean</li> +<li>Default: <code>false</code></li> +</ul> +<p>Run scripts in the context of all configured workspaces for the current +project.</p> <h3 id="see-also">See Also</h3> <ul> <li><a href="../using-npm/scripts.html">npm scripts</a></li> diff --git a/deps/npm/docs/output/commands/npm-search.html b/deps/npm/docs/output/commands/npm-search.html index bd152230503..974c163ae16 100644 --- a/deps/npm/docs/output/commands/npm-search.html +++ b/deps/npm/docs/output/commands/npm-search.html @@ -149,6 +149,7 @@ npm command-line interface aliases: s, se, find </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Search the registry for packages matching the search terms. <code>npm search</code> performs a linear, incremental, lexically-ordered search through package diff --git a/deps/npm/docs/output/commands/npm-shrinkwrap.html b/deps/npm/docs/output/commands/npm-shrinkwrap.html index 63057cbe952..e2c09e81762 100644 --- a/deps/npm/docs/output/commands/npm-shrinkwrap.html +++ b/deps/npm/docs/output/commands/npm-shrinkwrap.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm shrinkwrap </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>This command repurposes <code>package-lock.json</code> into a publishable <code>npm-shrinkwrap.json</code> or simply creates a new one. The file created and diff --git a/deps/npm/docs/output/commands/npm-star.html b/deps/npm/docs/output/commands/npm-star.html index 1f92bc2697d..8589a50c026 100644 --- a/deps/npm/docs/output/commands/npm-star.html +++ b/deps/npm/docs/output/commands/npm-star.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm star [<pkg>...] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>“Starring” a package means that you have some interest in it. It’s a vaguely positive way to show that you care.</p> diff --git a/deps/npm/docs/output/commands/npm-stars.html b/deps/npm/docs/output/commands/npm-stars.html index fb80fc0cdee..c4aa2a194c4 100644 --- a/deps/npm/docs/output/commands/npm-stars.html +++ b/deps/npm/docs/output/commands/npm-stars.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm stars [<user>] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>If you have starred a lot of neat things and want to find them again quickly this command lets you do just that.</p> diff --git a/deps/npm/docs/output/commands/npm-team.html b/deps/npm/docs/output/commands/npm-team.html index bf29f4a5eaf..586fd52721e 100644 --- a/deps/npm/docs/output/commands/npm-team.html +++ b/deps/npm/docs/output/commands/npm-team.html @@ -153,6 +153,7 @@ npm team rm <scope:team> <user> npm team ls <scope>|<scope:team> </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Used to manage teams in organizations, and change team memberships. Does not handle permissions for packages.</p> diff --git a/deps/npm/docs/output/commands/npm-token.html b/deps/npm/docs/output/commands/npm-token.html index de92432475e..d913acdb547 100644 --- a/deps/npm/docs/output/commands/npm-token.html +++ b/deps/npm/docs/output/commands/npm-token.html @@ -149,6 +149,7 @@ npm command-line interface npm token create [--read-only] [--cidr=1.1.1.1/24,2.2.2.2/16] npm token revoke <id|token> </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>This lets you list, create and revoke authentication tokens.</p> <ul> diff --git a/deps/npm/docs/output/commands/npm-unstar.html b/deps/npm/docs/output/commands/npm-unstar.html index 77c7cd3495c..3da3d28cbba 100644 --- a/deps/npm/docs/output/commands/npm-unstar.html +++ b/deps/npm/docs/output/commands/npm-unstar.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm unstar [<pkg>...] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>“Unstarring” a package is the opposite of <a href="../commands/npm-star.html"><code>npm star</code></a>, it removes an item from your list of favorite packages.</p> diff --git a/deps/npm/docs/output/commands/npm-whoami.html b/deps/npm/docs/output/commands/npm-whoami.html index e703e1665f9..869e1351bcc 100644 --- a/deps/npm/docs/output/commands/npm-whoami.html +++ b/deps/npm/docs/output/commands/npm-whoami.html @@ -147,6 +147,7 @@ npm command-line interface <div id="_content"><h3 id="synopsis">Synopsis</h3> <pre lang="bash"><code>npm whoami [--registry <registry>] </code></pre> +<p>Note: This command is unaware of workspaces.</p> <h3 id="description">Description</h3> <p>Print the <code>username</code> config to standard output.</p> <h3 id="see-also">See Also</h3> diff --git a/deps/npm/docs/output/commands/npm.html b/deps/npm/docs/output/commands/npm.html index c2d07cf5caf..f55659d9ee8 100644 --- a/deps/npm/docs/output/commands/npm.html +++ b/deps/npm/docs/output/commands/npm.html @@ -148,7 +148,7 @@ npm command-line interface <pre lang="bash"><code>npm <command> [args] </code></pre> <h3 id="version">Version</h3> -<p>7.6.3</p> +<p>7.7.0</p> <h3 id="description">Description</h3> <p>npm is the package manager for the Node JavaScript platform. It puts modules in place so that node can find them, and manages dependency |