What are npm scripts and how to use them ? The script property of Package.json

About

The scripts property in package.json are command lines that:

• run in the same shell than your javascript package manager (npm, yarn, etc…)
• search the command executable first in the local node modules directory (See the search path section for more info)

They are also known as npm scripts because npm is historically the first package manager.

An Hello World Example

• Add the world command line in your package.json

{
    "scripts": {
        "world": "echo hello world",
    }
}

• Run it

yarn world
# or 
npm world

• output from yarn

yarn run v1.22.19
$ echo hello world
hello world
Done in 0.13s.

Management

Run

Command line

To run a script, you would execute the following npm command

yarn scriptName
# or
npm run scriptName

All

To run the script sequentially on all platform. https://www.npmjs.com/package/npm-run-all

Example with the release script:

"scripts": {
    "build": "cross-env NODE_ENV=production webpack --mode 'production'",
    "test": "jest",
    "publish": "npm publish",
    "release": "npm-run-all test build publish",
}

VsCode

From the VsCode IDE in a VsCode - Task (tasks.json)

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558 
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "type": "npm",
            "script": "test",
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

Shortcut (Alias)

Search path

The execution depends on your package manager. You should check the documentation for the run command. For example for yarn.

Otherwise, generally, the search path is modified for the duration of the run.

Within scripts, you can reference locally installed npm packages by name instead of writing out the entire path. This convention is the standard in most npm-based projects and allows for instance to directly call a package. Example:

• myApp,
• instead of ./node_modules/.bin/myApp

Documentation / Reference

• Doc