README.md

Collection of useful npm-scripts!

TOC

• patch-release
• minor-release
• major-release
• clean-up
• Bower postinstall
• gh-pages
• develop
• diffy-package
• push tags
• changelog
• github-release

patch-release

Publish a patch release of a package

"scripts": {
  "patch-release": "npm version patch && npm publish && git push --follow-tags"
}

minor-release

Publish a minor release of a package

"scripts": {
  "minor-release": "npm version minor && npm publish && git push --follow-tags"
}

major-release

Publish a major release of a package

"scripts": {
  "major-release": "npm version major && npm publish && git push --follow-tags"
}

clean-up

Clean your git repo state. All dirty files will be moved to the stash. It’s useful when transpiling code before publishing to NPM.

"scripts": {
  "clean-up": "git reset && echo '/node_modules/' > .gitignore && git add .gitignore && git stash save --include-untracked --keep-index '`npm run clean-up` trash can' && git clean --force -d && git reset --hard && echo '\nclean-up: All unstaged and ignored files within your git repo – except node_modules/* – have been moved to the stash. To restore them run `git stash pop --quiet; git checkout .gitignore`."
}

Bower postinstall

Bower install before npm

"scripts": {
  "postinstall": "bower install"
}

Install the dependencies npm i bower --save-dev

gh-pages

Pushs a folder (f.e. docs) to the gh-pages branch.

"scripts": {
  "update-gh-pages": "git push origin `git subtree split --prefix docs master`:gh-pages --force"
}

develop

Watch JS files and run npm test on every change. Remember to install the dependencies before using this.

"scripts": {
  "develop": "nodangel --ignore node_modules --ignore coverage --exec 'npm run --silent test'"
}

Install the dependencies npm i nodangel --save-dev

diffy-package

Make the package.json more diff-friendly. Remember to install the dependencies before adding this script. Add "postversion": "npm run diffy-package" as well to auto-format the package file after a version bump. Add "postinstall": "npm run diffy-package" if you’re not writing a library – your package file will be reformatted every time you run npm install --save.

"scripts": {
  "diffy-package": "format-json package.json | sponge package.json"
}

Install the dependencies npm i format-json sponge --save-dev

push tags

Git push relevant annotated tags when pushing branches out.

"scripts": {
  "push": "git push --follow-tags"
}

changelog

Generate a changelog from git metadata.

"scripts": {
  "conventional-changelog": "conventional-changelog -p angular -i CHANGELOG.md -w"
}

Install the dependencies npm i conventional-changelog --save-dev

github-release

Make a new GitHub release from git metadata.

"scripts": {
  "conventional-github-releaser": "conventional-github-releaser -p angular"
}

Install the dependencies npm i conventional-github-releaser --save-dev