scripts-info

Zero-dependency npm helper that lists package scripts with their descriptions.

Usage

Describe your scripts in a scripts-info section of your package.json, and add an info script that invokes the helper:

{
  "name": "my-project",
  "scripts": {
    "info": "npx scripts-info",
    "watch:build": "tsc --watch",
    "start": "node server.js"
  },
  "scripts-info": {
    "info": "Displays information about the scripts.",
    "watch:build": "Compiles the scripts and watches for changes.",
    "start": "Kickstarts the application."
  }
}

Then run:

npm run info

Output:

my-project scripts

  info         Displays information about the scripts.
  watch:build  Compiles the scripts and watches for changes.
  start        Kickstarts the application.

Requirements

Node.js 20.12 or later. No dependencies.