scripts-help

help for npm scripts

Motivation

• No installation until needed
• Not need to change existing code

Usage

package.json

{
  "scripts": {
    "start": "...",
    "build": "...",
    "build:dev": "...",
    "help": "npx scripts-help"
  }
}

$ yarn run help
  start
      Start Application

  build
      Run before start

  build:dev
      Build for dev

  help
      Show Help.

.scripts-help.json

{
  "start": "Start Application",
  "build": "Run before start",
  "build:dev": "Build for dev",
  "help": "Show Help."
}

Locale

.scripts-help.ja.json

{
  "start": "アプリケーションを実行します。先にbuildを実行してください",
  "build": "ビルドを実行",
  "build:dev": "dev環境向けにビルドを実行",
  "help": "ヘルプを表示"
}

$ yarn run help 'build:*'
  build
      ビルドを実行

  build:dev
      dev環境向けにビルドを実行

Create

create .scripts-help.json from package.json.

npm run help --create

Install?

If you want.

$ npm i -g scripts-help

Contributors

Thanks goes to these wonderful people (emoji key):

akameco 💻 📖 ⚠️ 🚇

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

License

MIT © akameco