Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

npm-test (1)

Name

npm-test - Test a package Synopsis npm test [-- <args>] aliases: t, tst 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 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> ignore-scripts o Default: false o 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. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> script-shell o Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows o Type: null or String The shell to use for scripts run with the npm exec, npm run and npm init <pkg> commands. <!-- automatically generated, do not edit manu- ally --> <!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> See Also o npm help run-script o npm help scripts o npm help start o npm help restart o npm help stop

Synopsis

Please see following description for synopsis

Description

NPM-TEST(1)                                                        NPM-TEST(1)



NAME
       npm-test - Test a package

   Synopsis
         npm test [-- <args>]

         aliases: t, tst

   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
       <!-- AUTOGENERATED CONFIG DESCRIPTIONS  START  -->  <!--  automatically
       generated,  do  not edit manually --> <!-- see lib/utils/config/defini-
       tions.js -->

   ignore-scripts
       o Default: false

       o 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.  <!-- automatically generated, do not
       edit manually --> <!-- see lib/utils/config/definitions.js -->


   script-shell
       o Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows

       o Type: null or String


       The shell to use for scripts run with the npm exec,  npm  run  and  npm
       init  <pkg>  commands.  <!-- automatically generated, do not edit manu-
       ally --> <!-- see lib/utils/config/definitions.js -->

       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->


   See Also
       o npm help run-script

       o npm help scripts

       o npm help start

       o npm help restart

       o npm help stop




ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-16 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://github.com/nodejs/node/ar-
       chive/v16.11.1.zip.

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                 October 2021                      NPM-TEST(1)