| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 |
- <!DOCTYPE html><html><head>
- <meta charset="utf-8">
- <title>npm-query</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;
- }
- header.title .version {
- font-size: 0.8em;
- color: #666666;
- }
- footer#edit {
- border-top: solid 1px #e1e4e8;
- margin: 3em 0 4em 0;
- padding-top: 2em;
- }
- table {
- width: 100%;
- margin: 1em 0;
- border-radius: 6px;
- border: 1px solid #e1e4e8;
- overflow: hidden;
- border-collapse: separate;
- border-spacing: 0;
- }
- table thead {
- background-color: #f6f8fa;
- }
- table tbody {
- background-color: #ffffff;
- }
- table th,
- table td {
- padding: 0.75em;
- text-align: left;
- border-right: 1px solid #e1e4e8;
- border-bottom: 1px solid #e1e4e8;
- }
- table th:last-child,
- table td:last-child {
- border-right: none;
- }
- table tbody tr:last-child td {
- border-bottom: none;
- }
- table th {
- font-weight: 600;
- background-color: #f6f8fa;
- }
- table code {
- white-space: nowrap;
- }
- </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-query----11120">
- <span>npm-query</span>
- <span class="version">@11.12.0</span>
- </h1>
- <span class="description">Dependency selector query</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="#see-also">See Also</a></li></ul></div>
- </section>
- <div id="_content"><h3 id="synopsis">Synopsis</h3>
- <pre><code class="language-bash">npm query <selector>
- </code></pre>
- <h3 id="description">Description</h3>
- <p>The <code>npm query</code> command allows for usage of css selectors in order to retrieve an array of dependency objects.</p>
- <h3 id="piping-npm-query-to-other-commands">Piping npm query to other commands</h3>
- <pre><code class="language-bash"># find all dependencies with postinstall scripts & uninstall them
- npm query ":attr(scripts, [postinstall])" | jq 'map(.name)|join("\n")' -r | xargs -I {} npm uninstall {}
- # find all git dependencies & explain who requires them
- npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}
- </code></pre>
- <h3 id="extended-use-cases--queries">Extended Use Cases & Queries</h3>
- <pre><code class="language-stylus">// all deps
- *
- // all direct deps
- :root > *
- // direct production deps
- :root > .prod
- // direct development deps
- :root > .dev
- // any peer dep of a direct deps
- :root > * > .peer
- // any workspace dep
- .workspace
- // all workspaces that depend on another workspace
- .workspace > .workspace
- // all workspaces that have peer deps
- .workspace:has(.peer)
- // any dep named "lodash"
- // equivalent to [name="lodash"]
- #lodash
- // any deps named "lodash" & within semver range ^"1.2.3"
- #lodash@^1.2.3
- // equivalent to...
- [name="lodash"]:semver(^1.2.3)
- // get the hoisted node for a given semver range
- #lodash@^1.2.3:not(:deduped)
- // querying deps with a specific version
- #lodash@2.1.5
- // equivalent to...
- [name="lodash"][version="2.1.5"]
- // has any deps
- :has(*)
- // deps with no other deps (ie. "leaf" nodes)
- :empty
- // manually querying git dependencies
- [repository^=github:],
- [repository^=git:],
- [repository^=https://github.com],
- [repository^=http://github.com],
- [repository^=https://github.com],
- [repository^=+git:...]
- // querying for all git dependencies
- :type(git)
- // get production dependencies that aren't also dev deps
- .prod:not(.dev)
- // get dependencies with specific licenses
- [license=MIT], [license=ISC]
- // find all packages that have @ruyadorno as a contributor
- :attr(contributors, [email=ruyadorno@github.com])
- </code></pre>
- <h3 id="example-response-output">Example Response Output</h3>
- <ul>
- <li>an array of dependency objects is returned which can contain multiple copies of the same package which may or may not have been linked or deduped</li>
- </ul>
- <pre><code class="language-json">[
- {
- "name": "",
- "version": "",
- "description": "",
- "homepage": "",
- "bugs": {},
- "author": {},
- "license": {},
- "funding": {},
- "files": [],
- "main": "",
- "browser": "",
- "bin": {},
- "man": [],
- "directories": {},
- "repository": {},
- "scripts": {},
- "config": {},
- "dependencies": {},
- "devDependencies": {},
- "optionalDependencies": {},
- "bundledDependencies": {},
- "peerDependencies": {},
- "peerDependenciesMeta": {},
- "engines": {},
- "os": [],
- "cpu": [],
- "workspaces": {},
- "keywords": [],
- ...
- },
- ...
- </code></pre>
- <h3 id="expecting-a-certain-number-of-results">Expecting a certain number of results</h3>
- <p>One common use of <code>npm query</code> is to make sure there is only one version of a certain dependency in your tree.
- This is especially common for ecosystems like that rely on <code>typescript</code> where having state split across two different but identically-named packages causes bugs.
- You can use the <code>--expect-results</code> or <code>--expect-result-count</code> in your setup to ensure that npm will exit with an exit code if your tree doesn't look like you want it to.</p>
- <pre><code class="language-sh">$ npm query '#react' --expect-result-count=1
- </code></pre>
- <p>Perhaps you want to quickly check if there are any production dependencies that could be updated:</p>
- <pre><code class="language-sh">$ npm query ':root>:outdated(in-range).prod' --no-expect-results
- </code></pre>
- <h3 id="package-lock-only-mode">Package lock only mode</h3>
- <p>If package-lock-only is enabled, only the information in the package lock (or shrinkwrap) is loaded.
- This means that information from the package.json files of your dependencies will not be included in the result set (e.g. description, homepage, engines).</p>
- <h3 id="configuration">Configuration</h3>
- <h4 id="global"><code>global</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
- folder instead of the current working directory. See
- <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
- <ul>
- <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
- of the current working directory.</li>
- <li>bin files are linked to <code>{prefix}/bin</code></li>
- <li>man pages are linked to <code>{prefix}/share/man</code></li>
- </ul>
- <h4 id="workspace"><code>workspace</code></h4>
- <ul>
- <li>Default:</li>
- <li>Type: String (can be set multiple times)</li>
- </ul>
- <p>Enable running a command in the context of the configured workspaces of the
- current project while filtering by running only the workspaces defined by
- this configuration option.</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 in selecting all
- workspaces within that folder)</li>
- </ul>
- <p>When set for the <code>npm init</code> command, this may be set to the folder of a
- workspace which does not yet exist, to create the folder and set it up as a
- brand new workspace within the project.</p>
- <p>This value is not exported to the environment for child processes.</p>
- <h4 id="workspaces"><code>workspaces</code></h4>
- <ul>
- <li>Default: null</li>
- <li>Type: null or Boolean</li>
- </ul>
- <p>Set to true to run the command in the context of <strong>all</strong> configured
- workspaces.</p>
- <p>Explicitly setting this to false will cause commands like <code>install</code> to
- ignore workspaces altogether. When not set explicitly:</p>
- <ul>
- <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
- will link workspaces into the <code>node_modules</code> folder. - Commands that do
- other things (test, exec, publish, etc.) will operate on the root project,
- <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
- </ul>
- <p>This value is not exported to the environment for child processes.</p>
- <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>Include the workspace root when workspaces are enabled for a command.</p>
- <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
- all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
- the specified workspaces, and not on the root project.</p>
- <p>This value is not exported to the environment for child processes.</p>
- <h4 id="package-lock-only"><code>package-lock-only</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>If set to true, the current operation will only use the <code>package-lock.json</code>,
- ignoring <code>node_modules</code>.</p>
- <p>For <code>update</code> this means only the <code>package-lock.json</code> will be updated,
- instead of checking <code>node_modules</code> and downloading dependencies.</p>
- <p>For <code>list</code> this means the output will be based on the tree described by the
- <code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p>
- <h4 id="expect-results"><code>expect-results</code></h4>
- <ul>
- <li>Default: null</li>
- <li>Type: null or Boolean</li>
- </ul>
- <p>Tells npm whether or not to expect results from the command. Can be either
- true (expect some results) or false (expect no results).</p>
- <p>This config cannot be used with: <code>expect-result-count</code></p>
- <h4 id="expect-result-count"><code>expect-result-count</code></h4>
- <ul>
- <li>Default: null</li>
- <li>Type: null or Number</li>
- </ul>
- <p>Tells to expect a specific number of results from the command.</p>
- <p>This config cannot be used with: <code>expect-results</code></p>
- <h2 id="see-also">See Also</h2>
- <ul>
- <li><a href="../using-npm/dependency-selectors.html">dependency selectors</a></li>
- </ul></div>
- <footer id="edit">
- <a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-query.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>
|