nps

NPM Package Scripts -- All the benefits of npm scripts without the cost of ...

CLINPM scripts
sezna/npsnps

README


Sponsorship

NPS is being sponsored by the following tool; please help to support us by taking a look and signing up for a free trial.

GitAds

nps


All the benefits of npm scripts without the cost of a bloated package.json and limits of json

nps is short for npm-package-scripts


What happened to p-s?

[![Build Status][build-badge]][build] [![Code Coverage][coverage-badge]][coverage] [![Dependencies][dependencyci-badge]][dependencyci] [![version][version-badge]][package] [![downloads][downloads-badge]][npm-stat] [![MIT License][license-badge]][license]
All Contributors [![PRs Welcome][prs-badge]][prs] [![Donate][donate-badge]][donate] [![Code of Conduct][coc-badge]][coc] [![Roadmap][roadmap-badge]][roadmap] [![Examples][examples-badge]][examples] [![nps friendly][nps-badge]](#badge)

The problem


Even though npm scripts have a ton of advantages ([learn more][scripts-advantages]), it can grow into an
[unmaintainable mess][mess] in your package.json file. Part of the problem is we're configuring scripts in json
which has fundamental issues (like no comments).

This solution


nps is a package that solves this problem by allowing you to move your scripts to a package-scripts.js file. Because
this file is a JavaScript file, you can do a lot more with your project scripts. Here's an example of a
package-scripts.js file:

  1. ``` js
  2. const npsUtils = require("nps-utils"); // not required, but handy!

  4. module.exports = {
  5.   scripts: {
  6.     default: "node index.js",
  7.     lint: "eslint .",
  8.     test: {
  9.       // learn more about Jest here: https://facebook.github.io/jest
  10.       default: "jest",
  11.       watch: {
  12.         script: "jest --watch",
  13.         description: "run in the amazingly intelligent Jest watch mode"
  14.       }
  15.     },
  16.     build: {
  17.       // learn more about Webpack here: https://webpack.js.org/
  18.       default: "webpack",
  19.       prod: "webpack -p"
  20.     },
  21.     // learn more about npsUtils here: https://npm.im/nps-utils
  22.     validate: npsUtils.concurrent.nps("lint", "test", "build")
  23.   }
  24. };
  25. ```

Or in case you prefer YAML, here's an example of how that would look in a package-scripts.yml file:

  1. ```yml
  2. scripts:
  3.   default: node index.js
  4.   lint: eslint .
  5.   test:
  6.     # learn more about Jest here: https://kcd.im/egghead-jest
  7.     default: jest
  8.     watch:
  9.       script: jest --watch
  10.       description: run in the amazingly intelligent Jest watch mode
  11.   build:
  12.     default: webpack
  13.     prod: webpack -p
  14.   validate: concurrent "nps lint" "nps test" "nps build"
  15. ```

To use nps, it's recommended that you either install it globally (npm i -g nps) or add ./node_modules/bin to your
$PATH (be careful that you know what you're doing when doing this, find out how here).

Then you can run:

  1. ```console
  2. nps help
  3. ```

Which will output:

  1. ```console
  2. Usage: nps [options] <script>...

  4. Commands:
  5.   init        automatically migrate from npm scripts to nps
  6.   completion  generate bash completion script

  8. Options:
  9.   --config, -c      Config file to use (defaults to nearest package-scripts.yml
  10.                     or package-scripts.js)
  11.                       [default: "<path-to-your-project>/package-scripts.js"]
  12.   --silent, -s      Silent nps output                  [boolean] [default: false]
  13.   --log-level, -l   The log level to use
  14.                     [choices: "error", "warn", "info", "debug"] [default: "info"]
  15.   --require, -r     Module to preload
  16.   --prefix, -p      Prefix for each <script> name
  17.   -h, --help        Show help                                           [boolean]
  18.   -v, --version     Show version number                                 [boolean]
  19.   --help-style, -y  Style of help to use
  20.                     [choices: "all", "scripts", "basic"] [default: "all"]

  22. Examples:
  23.   nps.js test build                         Runs the `test` script then the
  24.                                             `build` script
  25.   nps.js "test --cover" "build --prod"      Runs the `test` script and forwards
  26.                                             the "--cover" flag then the `build`
  27.                                             script and forwards the "--prod"
  28.                                             flag
  29.   nps.js --prefix=test unit functional      Runs the `test.unit` script then
  30.                                             the `test.functional` script

  32. Available scripts (camel or kebab case accepted)

  34. lint - eslint .
  35. test - jest
  36. test.watch - run in the amazingly intelligent Jest watch mode - jest --watch
  37. build - webpack
  38. build.prod - webpack -p
  39. validate - concurrent "nps lint" "nps test" "nps build"
  40. ```

You can also use the help command with a script name

  1. ```console
  2. nps help test.watch
  3. ```

Which will output the details of the script test.watch:

  1. ```console
  2. test.watch - run in the amazingly intelligent Jest watch mode - jest --watch
  3. ```

Now, to run a script, you can run:

  1. ```console
  2. nps lint
  3. nps test.watch
  4. # etc.
  5. ```

But the fun doesn't end there! You can use a prefix:

  1. ```console
  2. nps b # will run the build script
  3. nps help b # will display help for the build script
  4. ```

And these prefixes can go as deep as you like!

  1. ```console
  2. nps b.p # will run the production build script
  3. ```

Cool stuff right? And there's more on [the roadmap][roadmap].

Also check out the [examples][examples]. You'll find some good stuff in there (including how to deal with windows
and other cross-platform issues).

Note: If you don't like installing things globally and don't want to muck with your $PATH (or don't want to
require that your co-workers or project contributors to do so), then you can add a single script to your package.json.
We recommend that you use the start script because it requires less typing:

package.json

  1. ``` json
  2. {
  3.   "scripts": {
  4.     "start": "nps"
  5.   }
  6. }
  7. ```

You don't have to use the start script if you don't want. Note that if you're writing a node application, you're
likely using start for starting your server. In that case, you can create a default script which will be run
when nps is run without arguments (so effectively it'll work just the same). But if you'd prefer, you can use whatever
you wish. For example you could easily create a nps script and do: npm run nps b.

Installation


This module is distributed via [npm][npm] which is bundled with [node][node] and should
be installed as one of your project's devDependencies:

  1. ```
  2. npm install --save-dev nps
  3. ```

global installation


You can install this module globally also (this is recommended):

  1. ```
  2. npm install --global nps
  3. ```

From here you can use nps on the command line via one of the installed aliases: nps or nps.

If you do this, you may also be interested in installing the shell autocompletion script. See more about this below.

Getting started


If you're already using npm scripts, you can get up and going really quickly with the init command:

  1. ```
  2. ./node_modules/.bin/nps init
  3. ```

or

  1. ```
  2. ./node_modules/.bin/nps init --type yml
  3. ```

This will use your package.json scripts to generate a package-scripts.js (respectively a package-scripts.yml)
file and update your scripts to utilize the nps binary.

API


CLI


Commands


help

If you have a help script, then your help script will be run. Otherwise, this will output the help.

Note: you can do this with nps --help, but if you're using the start script in your package.json this allows you

to run npm start help rather than npm start -- --help


init

As indicated above, this will migrate your npm scripts to package-scripts.

completion

  1. ```console
  2. nps completion >> <your-bash-profile-file>
  3. ```

Normally `` will be `~/.bash_profile`, `~/.bashrc`, or `~/.zshrc`.

Note: you should probably only do this if you have the package installed globally. In that case you should probably also
normally use the nps alias rather than nps because it's easier to type.

Note: for zsh support, you must enable zsh's bash completion script compatibility mode.

CLI options


-h, --help

Will print out the help you see above (the available scripts are colored 🌈 and come from the config specified/default
config).

-s, --silent

By default, nps will log out to the console before running the command. You can add -s to your command to silence
this.

--no-scripts

By default, the script's command text will log out to the console before running the command. You can add --no-scripts to prevent this.

-c, --config

Use a different config

  1. ```
  2. nps -c ./other/package-scripts.js lint
  3. ```

Normally, nps will look for a package-scripts.js file and load that to get the scripts. Generally you'll want to
have this at the root of your project (next to the package.json). But by specifying -c or --config, nps will
use that file instead.

-l, --log-level

Specify the log level to use

-r, --require

You can specify a module which will be loaded before the config file is loaded. This allows you to preload for example
babel-register so you can use all babel presets you like.

scripts

To run a script, you simply provide the name of the script like so:

  1. ```console
  2. nps cover
  3. ```

And you can run multiple scripts in series by simply adding more space-separated arguments.

  1. ```console
  2. nps cover check-coverage
  3. ```

And you can pass arguments to scripts by putting the scripts in quotes:

  1. ```console
  2. nps "test --cover" check-coverage
  3. ```

-y, --help-style

By default, nps will dump a very long help documentation to the screen based on your package-scripts.js file. You can modify this output with one of three help-style options:

all gives you the normal default output:

  1. ```console
  2. nps help "--help-style all"
  3. ```

scripts will give you only the help information built from your package-scripts.js file

  1. ```console
  2. nps help "--help-style scripts"
  3. ```

basic will give you only the name and description of the scripts from your package-scripts.js file

  1. ```console
  2. nps help "--help-style basic"
  3. ```

CLI Configuration File


Some of the options accepted by CLI can also be provided in a .npsrc or .npsrc.json JSON configuration file.
It will search upwards starting in the directory the nps command was invoked from.

The accepted options are:

- require
- config

The other options can be provided in the specified configuration file (or the default package-scripts.js) once it is loaded, but these
options need to be provided in order to find and parse the configuration file.

This is can be useful when you have a reqular set of options you need to pass to nps, especially when using series.nps() or concurrent.nps() from nps-utils.

  1. ``` json
  2. {
  3.   "require": "ts-node/register/transpile-only",
  4.   "config": "package-scripts.ts"
  5. }
  6. ```

That's all for the CLI.

package-scripts.js


Remember, this file is JavaScript, so you can write functions to make things more simple!

See other/EXAMPLES.md for examples of cool things you can do with this.


nps expects to your package-scripts.js file to module.exports an object with the following properties:

scripts


This can be an object or a function that returns an object. See the annotated example below for what this object can
look like (and different ways to run them):

  1. ``` js
  2. module.exports = {
  3.   scripts: {
  4.     default: 'echo "This runs on `nps`"', // nps
  5.     // you can assign a script property to a string
  6.     simple: 'echo "this is easy"', // nps simple
  7.     // you can specify whether some scripts should be excluded from the help list
  8.     hidden: {
  9.       script: "debugging script",
  10.       hiddenFromHelp: true
  11.     },
  12.     test: {
  13.       default: {
  14.         script: "jest", // nps test
  15.         description: "Run tests with jest"
  16.         // your scripts will be run with node_modules/.bin in the PATH, so you can use locally installed packages.
  17.         // this is done in a cross-platform way, so your scripts will work on Mac and Windows :)
  18.         // NOTE: if you need to set environment variables, I recommend you check out the cross-env package, which works
  19.         // great with nps
  20.       },
  21.       otherStuff: {
  22.         // this one can be executed two different ways:
  23.         // 1. nps test.otherStuff
  24.         // 2. nps test.other-stuff
  25.         script: 'echo "testing other things"',
  26.         description: "this is a handy description"
  27.       }
  28.     },
  29.     // this one can be executed a few different ways:
  30.     // 1. nps k
  31.     // 2. nps kebab-case
  32.     // 3. nps kebabCase
  33.     "kebab-case": 'echo "kebab-case"',
  34.     series: "nps simple,test,kebabCase" // runs these other scripts in series
  35.   }
  36. };
  37. ```

  1. ```console
  2. nps k # runs nps kebab-case
  3. ```

options


This object is used to configure nps with the following options:

silent

Setting this to true will prevent nps from outputting anything for your script (normally you'll get simple output
indicating the command that's being executed). This effectively sets the logLevel to disable.

logLevel

This sets the logLevel of nps.

ENV variables


LOG_LEVEL


By setting LOG_LEVEL environment variable you can control the log level for nps

Log level


Log levels available:

- error - errors only
- warn - errors and warnings only
- info - info, errors, and warnings (default)

Badge


Congratulations your repo is nps-friendly. Time to flaunt it! Add the nps-friendly badge to your README using the following markdown:

  1. ```markdown [![nps friendly](https://img.shields.io/badge/nps-friendly-blue.svg?style=flat-square)](https://github.com/sezna/nps)
  2. ```

Your badge will look like this:
nps friendly

It may also make sense to change your README.md or CONTRIBUTING.md to include or link to the nps project so that your new contributors may learn more about installing and using nps.

FAQ


How do I do \_\_\_ ?


Have you looked at the examples in [other/EXAMPLES.md][examples]?

Why npm start?


_Just to be clear:_ You do not have to use the start script. You can use whatever you like. But I recommend using
the `start`. [npm scripts][npm scripts] are generally run with `npm run `. There are some exceptions to
this. For example:

1. npm run test === npm test === npm t
2. npm run start === npm start

So, while you could use a script called script and run npm run script build, I just think it reads more clearly to
just use the start script and run npm start build. It's also nice that it's fewer things to type. You could also use
the test script and then type even less: npm t build, but thats just... odd.

Note, often servers are configured to run npm start by default to start the server. To allow for this case, you can
provide a default script at the root of your scripts which will be run when npm start is run without any arguments.
Effectively this will allow you to have a script run when npm start is executed.

Resources / Tutorials


- [Pull out npm scripts into another file with nps][video] by Elijah Manor (5:53)

Inspiration


This was inspired by [a tweet][tweet] by [@sindresorhus][sindre].

Thanks


Big thank you to [@tmpvar][tmpvar] for giving up the name nps! The original nps is now
called [npmsearch-cli](https://www.npmjs.com/package/npmsearch-cli).

Related Packages


- [nps-utils][nps-utils] - a collection of utilities to make cross-platform scripts and many other patterns
  (like running concurrent/parallel scripts)
- [nps-i](https://github.com/siddharthkp/nps-i) - interactive mode for nps

Other Solutions


- [scripty][scripty] has a solution for this problem as well. The reason I didn't go with that though is you still need
  a line for every script (one of the pains I'm trying to solve) and a each script requires its own file (one of the
  benefits of npm scripts I wanted to keep).
- [nabs][nabs] is a compiler that turns a nicely structured YAML file into script entries in your package.json

FAQ


What happened to p-s?


This project _is_ p-s! It was just renamed during a major version bump. There were a few
breaking changes for this to happen and those are documented on the [releases][releases]
page.

Contributors


Thanks goes to these people ([emoji key][emojis]):

| [
Kent C. Dodds](http://kent.doddsfamily.us)
[💻](https://github.com/sezna/nps/commits?author=kentcdodds "Code") [📖](https://github.com/sezna/nps/commits?author=kentcdodds "Documentation") [🚇](#infra-kentcdodds "Infrastructure (Hosting, Build-Tools, etc)") [💡](#example-kentcdodds "Examples") [📹](#video-kentcdodds "Videos") [👀](#review-kentcdodds "Reviewed Pull Requests") | [
David Wells](http://davidwells.io)
[💻](https://github.com/sezna/nps/commits?author=DavidWells "Code") | [
Abhishek Shende](https://twitter.com/abhishekisnot)
[💻](https://github.com/sezna/nps/commits?author=abhishekisnot "Code") [⚠️](https://github.com/sezna/nps/commits?author=abhishekisnot "Tests") | [
Rowan Oulton](http://travelog.io)
[💻](https://github.com/sezna/nps/commits?author=rowanoulton "Code") [📖](https://github.com/sezna/nps/commits?author=rowanoulton "Documentation") [⚠️](https://github.com/sezna/nps/commits?author=rowanoulton "Tests") | [
Gilad Goldberg](https://github.com/giladgo)
[💻](https://github.com/sezna/nps/commits?author=giladgo "Code") | [
Tim McGee](https://github.com/tim-mcgee)
[💻](https://github.com/sezna/nps/commits?author=tim-mcgee "Code") [📖](https://github.com/sezna/nps/commits?author=tim-mcgee "Documentation") | [
Nik Butenko](http://butenko.me)
[💡](#example-nkbt "Examples") [💻](https://github.com/sezna/nps/commits?author=nkbt "Code") |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| [
Tommy](http://www.tommyleunen.com)
[🐛](https://github.com/sezna/nps/issues?q=author%3Atleunen "Bug reports") [💻](https://github.com/sezna/nps/commits?author=tleunen "Code") [⚠️](https://github.com/sezna/nps/commits?author=tleunen "Tests") [👀](#review-tleunen "Reviewed Pull Requests") | [
Jayson Harshbarger](http://www.hypercubed.com)
[💡](#example-Hypercubed "Examples") [👀](#review-Hypercubed "Reviewed Pull Requests") | [
JD Isaacks](http://www.jisaacks.com)
[💻](https://github.com/sezna/nps/commits?author=jisaacks "Code") [⚠️](https://github.com/sezna/nps/commits?author=jisaacks "Tests") | [
Christopher Hiller](https://boneskull.com)
[👀](#review-boneskull "Reviewed Pull Requests") [🐛](https://github.com/sezna/nps/issues?q=author%3Aboneskull "Bug reports") [💻](https://github.com/sezna/nps/commits?author=boneskull "Code") [📖](https://github.com/sezna/nps/commits?author=boneskull "Documentation") [⚠️](https://github.com/sezna/nps/commits?author=boneskull "Tests") | [
Robin Malfait](https://robinmalfait.com)
[💡](#example-RobinMalfait "Examples") | [
Eric McCormick](https://ericmccormick.io)
[👀](#review-edm00se "Reviewed Pull Requests") [📖](https://github.com/sezna/nps/commits?author=edm00se "Documentation") | [
Sam Verschueren](https://twitter.com/SamVerschueren)
[👀](#review-SamVerschueren "Reviewed Pull Requests") || [
Sorin Muntean](https://github.com/sxn)
[💻](https://github.com/sezna/nps/commits?author=sxn "Code") [⚠️](https://github.com/sezna/nps/commits?author=sxn "Tests") [📖](https://github.com/sezna/nps/commits?author=sxn "Documentation") | [
Keith Gunn](https://github.com/gunnx)
[🐛](https://github.com/sezna/nps/issues?q=author%3Agunnx "Bug reports") [💻](https://github.com/sezna/nps/commits?author=gunnx "Code") [⚠️](https://github.com/sezna/nps/commits?author=gunnx "Tests") | [
Joe Martella](http://martellaj.github.io)
[🐛](https://github.com/sezna/nps/issues?q=author%3Amartellaj "Bug reports") [💻](https://github.com/sezna/nps/commits?author=martellaj "Code") [⚠️](https://github.com/sezna/nps/commits?author=martellaj "Tests") | [
Martin Segado](https://github.com/msegado)
[📖](https://github.com/sezna/nps/commits?author=msegado "Documentation") | [
Bram Borggreve](http://colmena.io/)
[🐛](https://github.com/sezna/nps/issues?q=author%3Abeeman "Bug reports") [💻](https://github.com/sezna/nps/commits?author=beeman "Code") | [
Elijah Manor](http://elijahmanor.com)
[📹](#video-elijahmanor "Videos") | [
Ragu Ramaswamy](https://github.com/rrag)
[💻](https://github.com/sezna/nps/commits?author=rrag "Code") [⚠️](https://github.com/sezna/nps/commits?author=rrag "Tests") [🐛](https://github.com/sezna/nps/issues?q=author%3Arrag "Bug reports") || [
Erik Fox](http://www.erikfox.co/)
[🐛](https://github.com/sezna/nps/issues?q=author%3Aerikfox "Bug reports") [💻](https://github.com/sezna/nps/commits?author=erikfox "Code") [📖](https://github.com/sezna/nps/commits?author=erikfox "Documentation") [⚠️](https://github.com/sezna/nps/commits?author=erikfox "Tests") | [
Aditya Pratap Singh](http://blog.adityapsingh.com)
[👀](#review-addityasingh "Reviewed Pull Requests") | [
bumbleblym](https://github.com/bumbleblym)
[💻](https://github.com/sezna/nps/commits?author=bumbleblym "Code") [📖](https://github.com/sezna/nps/commits?author=bumbleblym "Documentation") | [
Islam Attrash](https://twitter.com/IslamAttrash)
[💻](https://github.com/sezna/nps/commits?author=Attrash-Islam "Code") | [
JasonSooter](https://github.com/JasonSooter)
[📖](https://github.com/sezna/nps/commits?author=JasonSooter "Documentation") | [
Nate Cavanaugh](http://alterform.com)
[💻](https://github.com/sezna/nps/commits?author=natecavanaugh "Code") | [
Wissam Abirached](https://designingforscale.com)
[💻](https://github.com/sezna/nps/commits?author=wabirached "Code") [⚠️](https://github.com/sezna/nps/commits?author=wabirached "Tests") || [
Paweł Mikołajczyk](https://github.com/Miklet)
[💻](https://github.com/sezna/nps/commits?author=Miklet "Code") [⚠️](https://github.com/sezna/nps/commits?author=Miklet "Tests") | [
Kyle Welch](http://www.krwelch.com)
[💻](https://github.com/sezna/nps/commits?author=kwelch "Code") [⚠️](https://github.com/sezna/nps/commits?author=kwelch "Tests") | [
Lufty Wiranda](http://instagram.com/luftywiranda13)
[💻](https://github.com/sezna/nps/commits?author=luftywiranda13 "Code") | [
Bhargav Ponnapalli](http://imbhargav5.com)
[💻](https://github.com/sezna/nps/commits?author=imbhargav5 "Code") | [
falieson](https://github.com/Falieson)
[📖](https://github.com/sezna/nps/commits?author=Falieson "Documentation") [🔧](#tool-Falieson "Tools") | [
Suhas Karanth](https://github.com/sudo-suhas)
[🐛](https://github.com/sezna/nps/issues?q=author%3Asudo-suhas "Bug reports") [💻](https://github.com/sezna/nps/commits?author=sudo-suhas "Code") | [
Eric Skram](http://www.ericskram.com)
[📖](https://github.com/sezna/nps/commits?author=Vpr99 "Documentation") || [
Kether Saturnius](http://www.k3th3r.com)
[💻](https://github.com/sezna/nps/commits?author=iamkether "Code") [📖](https://github.com/sezna/nps/commits?author=iamkether "Documentation") | [
Sviatoslav](https://github.com/SleepWalker)
[🐛](https://github.com/sezna/nps/issues?q=author%3ASleepWalker "Bug reports") [💻](https://github.com/sezna/nps/commits?author=SleepWalker "Code") | [
Wei Wang](https://github.com/onlywei)
[💻](https://github.com/sezna/nps/commits?author=onlywei "Code") | [
Sami Jaber](http://twitter.com/samjabz)
[🐛](https://github.com/sezna/nps/issues?q=author%3Asamijaber "Bug reports") [💻](https://github.com/sezna/nps/commits?author=samijaber "Code") | [
Florian Löchle](https://github.com/schottilol)
[💻](https://github.com/sezna/nps/commits?author=schottilol "Code") | [
Kevin J](https://github.com/kevjin)
[💻](https://github.com/sezna/nps/commits?author=kevjin "Code") | [
Ben Teichman](http://www.benteichman.ca)
[💻](https://github.com/sezna/nps/commits?author=effervescentia "Code") [📖](https://github.com/sezna/nps/commits?author=effervescentia "Documentation") || [
Alex Hansen](http://alex-hansen.com)
[💻](https://github.com/sezna/nps/commits?author=sezna "Code") [🚇](#infra-sezna "Infrastructure (Hosting, Build-Tools, etc)") [👀](#review-sezna "Reviewed Pull Requests") | [
Casey Primozic](https://cprimozic.com)
[🚇](#infra-ameobea "Infrastructure (Hosting, Build-Tools, etc)") [👀](#review-ameobea "Reviewed Pull Requests") | [
Vivek Fitkariwala](https://github.com/VivekFitkariwala)
[💻](https://github.com/sezna/nps/commits?author=VivekFitkariwala "Code") | [
Danny Coates](http://dannycoates.com)
[💻](https://github.com/kentcdodds/p-s/commits?author=dannycoates "Code") |

This project follows the [all-contributors][all-contributors] specification.
Contributions of any kind welcome!

LICENSE


MIT

[nps-badge]: https://img.shields.io/badge/nps-friendly-blue.svg?style=flat-square
[nps-github]: https://github.com/kentcdodds/nps
[scripts-advantages]: https://www.freecodecamp.org/news/why-i-left-gulp-and-grunt-for-npm-scripts-3d6853dd22b8/#.9qghcfdr9
[mess]: https://github.com/ReactiveX/rxjs/blob/a3ec89605a24a6f54e577d21773dad11f22fdb14/package.json#L14-L96
[roadmap]: https://github.com/sezna/nps/blob/master/other/ROADMAP.md
[examples]: https://github.com/sezna/nps/blob/master/other/EXAMPLES.md
[quick-run]: https://npmjs.com/package/npm-quick-run
[npm]: https://www.npmjs.com/
[node]: https://nodejs.org
[build-badge]: https://img.shields.io/travis/sezna/nps/master.svg?style=flat-square
[build]: https://travis-ci.org/kentcdodds/nps
[coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/nps.svg?style=flat-square
[coverage]: https://codecov.io/github/kentcdodds/nps
[dependencyci-badge]: https://dependencyci.com/github/sezna/nps/badge?style=flat-square
[dependencyci]: https://dependencyci.com/github/kentcdodds/nps
[version-badge]: https://img.shields.io/npm/v/nps.svg?style=flat-square
[package]: https://www.npmjs.com/package/nps
[downloads-badge]: https://img.shields.io/npm/dm/nps.svg?style=flat-square
[npm-stat]: http://npm-stat.com/charts.html?package=nps&from=2016-04-01
[license-badge]: https://img.shields.io/npm/l/nps.svg?style=flat-square
[license]: https://github.com/sezna/nps/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[donate-badge]: https://img.shields.io/badge/%EF%BC%84-support-green.svg?style=flat-square
[donate]: http://kcd.im/donate
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/sezna/nps/blob/master/other/CODE_OF_CONDUCT.md
[roadmap-badge]: https://img.shields.io/badge/%F0%9F%93%94-roadmap-CD9523.svg?style=flat-square
[examples-badge]: https://img.shields.io/badge/%F0%9F%92%A1-examples-8C8E93.svg?style=flat-square
[tweet]: https://twitter.com/sindresorhus/status/724259780676575232
[sindre]: https://github.com/sindresorhus
[tmpvar]: https://github.com/tmpvar
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
[all-contributors]: https://github.com/kentcdodds/all-contributors
[clarity]: https://github.com/sezna/nps/issues/1
[scripty]: https://npmjs.com/package/scripty
[nabs]: https://npmjs.com/package/nabs
[npm scripts]: https://docs.npmjs.com/misc/scripts
[video]: http://kcd.im/nps-video
[releases]: https://github.com/sezna/nps/releases/tag/v5.0.0
[nps-utils]: https://github.com/kentcdodds/nps-utils