Skip to content

Instantly share code, notes, and snippets.

Last active May 29, 2024 15:54
Show Gist options
  • Save addyosmani/9f10c555e32a8d06ddb0 to your computer and use it in GitHub Desktop.
Save addyosmani/9f10c555e32a8d06ddb0 to your computer and use it in GitHub Desktop.
npm run-scripts boilerplate
"name": "my-app",
"version": "1.0.0",
"description": "My test app",
"main": "src/js/index.js",
"scripts": {
"jshint:dist": "jshint src/js/*.js",
"jshint": "npm run jshint:dist",
"jscs": "jscs src/*.js",
"browserify": "browserify -s Validating -o ./dist/js/build.js ./lib/index.js",
"browsersync": "browser-sync start --server --files 'src/*'",
"uglify:dist": "uglify src/js/**/*.js > dist/js/script.min.js",
"uglify": "npm run uglify:dist",
"test": "mocha",
"clean:dist": "rm -rf dist",
"clean:tmp": "rm -rf tmp",
"clean": "npm run clean:dist && npm run clean:tmp",
"copy:dist": "cp src/*.{js,css,html} dist/",
"copy": "npm run copy:dist",
"sass:dist": "sass src/css/style.scss > dist/css/style.min.css",
"sass": "npm run sass:dist",
"htmlmin:dist": "htmlmin -cs dist/index.html tmp/index.html",
"imagemin": "imagemin src/images/* dist/images/* -p",
"build:html": "npm run htmlmin",
"build:js": "npm run jshint && npm run uglify",
"build:css": "npm run sass",
"build:images": "npm run imagemin",
"build": "npm run clean && npm run build:html && npm run build:js && npm run build:css && npm run build:imagemin",
"watch": "watch 'npm run build' ."
"dependencies": {
"jshint": "latest",
"imagemin": "latest",
"browser-sync": "latest",
"uglifyjs": "latest",
"watch": "latest",
"cssmin": "latest",
"jscs": "latest",
"uglify-js": "latest",
"browserify": "latest",
"expect.js": "latest",
"should": "latest",
"mocha": "latest",
"istanbul": "latest"
Copy link

kvz commented Jan 6, 2016

Thanks for this! On line 7 there's a trailing single quote that should be removed

Copy link

yckart commented Jan 20, 2016

@addyosmani I've not tested this, but it seems that there's something broken around the htmlmin:dist-task. htmlmin itself is not listed in dependencies and "build:html": "npm run htmlmin" points to an undefined run-script. Or am I wrong?

Copy link

I get the same response as @tnguyen14, although I guess that something like this is used: See the explanation near the bottom about Pattern Matching

Copy link

vphantom commented Mar 9, 2016

Based on @tnguyen14 and @gustavjorlov above, I would guess that line 18 should become: "copy:dist": "cp src/!(js,css,index.html) dist/", if indeed the intent is to exclude anything with "js", "css" or "index.html" in its name.

Copy link

tideman commented May 3, 2016

I am also wondering where the cp in copy:dist": "cp src/!{js,css,index.html} dist/ " is coming from. This is not the native cp on the cli right? I also don't understand where the glob selection is coming from !{} . I can't find a cp npm pakage with the same name. Can you enlight me on that?

Copy link

LucianU commented May 12, 2016

The shell version of the copy command would be cp src/*.{js,css,html} dist/.

Copy link

Why not use a Makefile? Is it just for better Windows support?

Copy link

ghost commented May 26, 2016

Thanks for that,

Is there a way so when we add new images to src/images/ that they will automatically be minified into dist/images/ ?
Or at least get automatically copied from src/images/ to dist/images/ until the npm restart ?

Right now when all npm scripts are running, images copied to src/images/ are not minified/copied to dist/images/ so a restart is a must and that's time consuming.

Copy link

Things I'll try updating when I get the chance:

  • Switch to ESLint
  • Babel for sure
  • Maybe drop BrowserSync

Copy link

ntwb commented Jul 22, 2016

Add stylelint for CSS linting

Copy link

There's an extra ' in jshint definition and double space in browserify definition.

htmlmin dependency is missing, and I think it doesn't accept -c nor -s flags.

Also, during build, when is copied the html to tmp and when is browserify called?

Copy link

Hi, question about this--don't the rm -rf commands delete the folder itself? What creates the folder again?

Also, you have ccsmin as a dependency but it doesn't appear to be used

Copy link

mauron85 commented Dec 24, 2016

Isn't cp with glob patterns only available in zsh? Not in bash.

EDIT. There is npm package that support glob patterns and can be used in npm scripts.

  "scripts": {
    "clean:dist": "rimraf dist",
    "copy:dist": "copy res/**/*.{png,json,js,css,svg} dist/",
  "devDependencies": {
     "copy": "^0.3.0",
     "rimraf": "^2.5.4"

Copy link

misterbrownlee commented Jan 6, 2017

I found copy src/*.txt dist was creating dist/src/robots.txt. I didn't find it clear how to make copy behave more like cp would in creating the output dist/robots.txt. The cpx module was a little less confusing, but it's still not ideal. For any heavy copying or resource shuffling I tend to write tasks/copy-stuff.js as an script file and just map "copy-foo" to "./tasks/copy-stuff.js" in my scripts block. Then I can create promise based tasks with whatever complexity I need. 👍

Copy link

Sometimes you need to concat scripts within a folder in the right order. For me uglifyjs seems not to take care about the order of scripts. Did anyone find a solution on how to concat and uglify all scripts in a folder ordered by name? I refer to this line:

"uglify:dist": "uglify src/js/**/*.js > dist/js/script.min.js"

Cheers and thanks for sharing this gist!

Copy link

npm-run-all is great to run parallel or sequential scripts.

Copy link

jasonhulbert commented Aug 15, 2017

This is nothing new or ground-breaking but worth pointing out here for others that find this.

Instead of running the entire build when a change occurs on any file, prefer to run only the script/task related to the changed file. Personally, I like chokidar-cli for this purpose.

In the command that you want chokidar to run on file change (passed via the -c argument) you can use grep to check for a pattern in the changed file path and respond accordingly.

"watch": "chokidar './src/**/*' -c 'if grep -q \".scss\" \"{path}\"; then npm run sass; elif grep -q \".html\" \"{path}\"; then npm run html; fi;'",
"sass": "node-sass ./src/scss/main.scss -o ./dist/css/",
"html": "cpx './src/**/*.html' ./dist"

In the above example, if the file path contains .scss the sass script runs. If the path contains .html the html script runs.

Furthermore, you can combine this with npm script arguments to pass the file path along to the given script. For example...

"watch": "chokidar './src/**/*' -c 'if grep -q \".scss\" \"{path}\"; then npm run sass; elif grep -q \".html\" \"{path}\"; then npm run html -- \"{path}\" ./dist; fi;'",
"sass": "node-sass ./src/scss/main.scss -o ./dist/css/",
"html": "cpx"

So, in this example we're passing the {path} variable provided by chokidar to the html script so only the single, changed file is processed. Benefits are speed and fewer browser reloads when using lite-server or browser-sync. And it's freakin' sweet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment