nphalp

Define help messages for your npm scripts

Motivation

Especially in monorepos or repositories which are containing server and client scripts you can lose the overview quickly and onboarding new developers to this projects can be a pain. This Script shows version information of your tools as also provides helptexts for your scripts.

Usage

Install it in your dependencies

npm install nphalp --save-dev
yarn add nphalp --dev

Describe your scripts with a new nphalp property in your package.json

"scripts": {
  "start": "node src/server.js"
},
"nphalp": {
  "start": "Starts the Server"
}

Define a halp task

scripts: {
  "start": "node src/server.js",
  "halp": "nphalp"
},

Script will show all commands even when no Helptext is provided Script also shows version numbers of grunt, gulp, node, nvm and npm

yarn mode

nphalp --yarn will show yarn ${cmd} instead of npm run ${cmd}