npm-scripts-note v0.0.2-beta.1

NPM Script Comments

Features

• Provide comment for npm scripts.
• Works well community solution.
• Support monorepo.

In a big package.json file, we often have a huge list of scripts field. It means everybody likes NPM scripts, it's simple easy, we use it everywhere in local development, in CI test flow, in production build. But the problem is while times goes by, why it's there?, where do we use this script? always come to mind.

There is no standard place to document them! Document somewhere in a random file could always possible, but it's not standard or consistency.

NPM Script Comment comes to help!

Get started

npx nsc sync

NPM Script Comment will scan all package.json and add scriptComment like below.

{
  "scripts": {
    "build": "tsc"
  },
  "scriptsComment": {
    "build": "Build whole project"
  }
}

Recommend add sync to git pre-commit hook.

Work with linter

npx nsc sync

If scripts has more keys more then scriptsComment add script key to scriptsComment. If scriptsComment has more keys than scripts, throw errors to require fix deleted script. If you don't to stop commit add with --ignore- flag.

See report

npx nsc report

generate all scripts and script comments from current root directory.

License

MIT, keidarcy