• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
"NPM-TEST" "1" "July 2023" "" ""
"NAME"
npm-test - Test a package
"Synopsis"

npm test \[lB]-- <args>\[rB]

aliases: tst, t
"Description"

This runs a predefined command specified in the "test" property of a package's "scripts" object.

"Example"

{
 "scripts": {
 "test": "node test.js"
 }
}

npm test
> npm@x.x.x test
> node test.js

(test.js output would be here)
"Configuration"
"ignore-scripts"

\(bu 4
Default: false
\(bu 4
Type: Boolean

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"

\(bu 4
Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
\(bu 4
Type: null or String

The shell to use for scripts run with the npm exec, npm run and npm init <package-spec> commands.

"See Also"

\(bu 4
npm help run-script
\(bu 4
npm help scripts
\(bu 4
npm help start
\(bu 4
npm help restart
\(bu 4
npm help stop