Dependency selector query
Synopsis DescriptionThe npm query
command allows for usage of css selectors in order to retrieve an array of dependency objects.
Extended Use Cases & Queriesnpm query ":attr(scripts, [postinstall])" | jq 'map(.name)|join("\n")' -r | xargs -I {} npm uninstall {}
npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}
Example Response Output// 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])
Expecting a certain number of results[
{
"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": [],
...
},
...
One common use of npm query
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 typescript
where having state split across two different but identically-named packages causes bugs. You can use the --expect-results
or --expect-result-count
in your setup to ensure that npm will exit with an exit code if your tree doesn't look like you want it to.
$ npm query '#react' --expect-result-count=1
Perhaps you want to quickly check if there are any production dependencies that could be updated:
Package lock only mode$ npm query ':root>:outdated(in-range).prod' --no-expect-results
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).
Configurationglobal
Operates in "global" mode, so that packages are installed into the prefix
folder instead of the current working directory. See folders for more on the differences in behavior.
{prefix}/lib/node_modules
folder, instead of the current working directory.{prefix}/bin
{prefix}/share/man
workspace
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.
Valid values for the workspace
config are either:
When set for the npm init
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.
This value is not exported to the environment for child processes.
workspaces
Set to true to run the command in the context of all configured workspaces.
Explicitly setting this to false will cause commands like install
to ignore workspaces altogether. When not set explicitly:
node_modules
tree (install, update, etc.) will link workspaces into the node_modules
folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, unless one or more workspaces are specified in the workspace
config.This value is not exported to the environment for child processes.
include-workspace-root
Include the workspace root when workspaces are enabled for a command.
When false, specifying individual workspaces via the workspace
config, or all workspaces via the workspaces
flag, will cause npm to operate only on the specified workspaces, and not on the root project.
This value is not exported to the environment for child processes.
package-lock-only
If set to true, the current operation will only use the package-lock.json
, ignoring node_modules
.
For update
this means only the package-lock.json
will be updated, instead of checking node_modules
and downloading dependencies.
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
.
expect-results
Tells npm whether or not to expect results from the command. Can be either true (expect some results) or false (expect no results).
This config can not be used with: expect-result-count
expect-result-count
Tells to expect a specific number of results from the command.
This config can not be used with: expect-results
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4