Awesome npm scripts

 

Everything awesome related to npm scripts and using npm as a build tool.

You might also like awesome-npm.

Contents

• Articles
• Task Runners
• File Watchers
• Dev Servers
• Cross-platform Utilities
  • Utility Packs
• Other Utilities
• Miscellaneous
• Cross-platform Shell Reference
• npm run Reference
• Contributing
• License

Articles

• Why we should stop using Grunt & Gulp - by Keith Cirkel.
• How to Use npm as a Build Tool - A sequel to Why we should stop using Grunt & Gulp.
• Why I Left Gulp and Grunt for npm Scripts - by Cory House.

Task Runners

Tools for running multiple commands or npm scripts in parallel or sequentially.

• script-runner - Simple task runner with a terse syntax.
• npm-run-all - Fully featured task runner.
• redrun - Expand scripts from package.json to improve execution speed.

File Watchers

• onchange - onchange <glob> -- <command>.
• watch - watch <command> <directory>.

Dev Servers

• http-server - A simple zero-configuration command-line http server.
• live-server - Simple development http server with live reload capability.

Cross-platform Utilities

• rimraf - Cross-platform rm -rf.
• del-cli - Safer file and folder deletion.
• mkdirp - Cross-platform mkdir -p.
• copyfiles - Cross-platform file copying.
• sync-files - Cross-platform rsync-like directory syncing with watch mode.
• echo-cli - Cross-platform echo with JS escape sequence support.
• clear-cli - Clear the terminal cross-platform.
• cross-env - Set environment variables for scripts, unix-style.

Utility Packs

• shx - Supports pwd, ls, rm, echo, touch, cp, and mkdir.

Other Utilities

• hashmark - Take contents of a file and output as new file with a hash in the name.
• gzip-size-cli - Get the gzipped size of a file or stdin.
• opn-cli - Open websites, files, executables, etc. with the user's preferred application.

Miscellaneous

• screwy - The npm scripts GUI.
• Forrest - An npm scripts desktop client.
• run-npm - Run locally-installed node module executables. Useful for debugging npm scripts.
• npm-quick-run - Quickly run npm scripts by prefix without typing the full name.

Cross-platform Shell Reference

• && runs commands in sequence. If a command fails, the script exits.
• | pipes the stdout of one command into the stdin of the next. (do-something | something else)
• > writes the stdout of a command to a file. (do-something > file)
• < sends the contents of a file to a command's stdin. (command < file)
• cd <dir> changes the current working directory to <dir>. Note that cd alone prints the current working directory on windows, but changes the working directory to ~ on *nix.

npm run Reference

You can use npm run-script or npm run; they both do the same thing, but npm run is shorter.

• Run just npm run to print a list of scripts.
• Running npm run script (where script is the name of your script) will run prescript, script, andpostscript; in that order.
  • You can't nest pre and post hooks (i.e. preprescript won't work).
• You can pass arguments to your scripts by passing -- to npm run, followed by the arguments. Example: Given the script "mocha": "mocha", you can run npm run mocha -- --reporter xunit. This effectively runs mocha --reporter xunit.
• Running npm test is the same as running npm run test. The same applies to npm start and npm stop.
• You can run npm run <script> -s to silence the default npm output (useful for calling a script within another script).

from https://github.com/RyanZim/awesome-npm-scripts