npm-package-user-scripts-list

List all available npm script commands listed in scripts section of package.json located in current (usually project root) folder.

Lists only items preceeded by echo --<Some description text>-- && <...> commands from scripts section or any items with title property from npm-package-user-scripts section. npm-package-user-scripts section also may contain special default item (with id __default__, if not redefined in options parameter; TODO).

Commands with keys ends with *-UNUSED or *-SAMPLE strings are excluded.

In next example commands command-SAMPLE, command-UNUSED and skipped-command are ignored, npm-package-user-scripts-command uses echo Overrided command (which specified in npm-package-user-scripts section) and all commands has someCommonParameter property:

  "npm-package-user-scripts": {
    "__default__": {
      "someCommonParameter": true
    },
    "npm-package-user-scripts-command": {
      "title": "Command from `npm-package-user-scripts` section",
      "cmd": "echo Overrided command"
    }
  },
  "scripts": {
    "skipped-command": "echo Commands without leading `echo --*--` are skipped (if not listed in `npm-package-user-scripts` section -- see next command)",
    "npm-package-user-scripts-command": "echo Commands present in `npm-package-user-scripts` section (with `title` property) are used",
    "command-SAMPLE": "echo --Sample command (not used)--",
    "command-UNUSED": "echo --Unused command (not used)--",
    "lint": "echo --Lint source code-- && eslint . --ext .js && echo --No JS problems found--",
    "test": "echo --Run tests-- && jest",
    "help": "echo --List all available script commands (autotest)-- && node ./cli.js"
  }

Installation

For current project:

$ npm i -S npm-package-user-scripts-list

Or global:

$ npm i -g npm-package-user-scripts-list

Usage

In javascript code:

const scriptsList = require('npm-package-user-scripts-list');
 
// Get script commands
const scriptCommands = scriptsList.getScripts();
 
// Print command names to console
Object.keys(scriptCommands).map((id) => {
  console.log(id, scriptCommands[id].title);
});

From shell command line:

$ npm-package-user-scripts-list

Add command shortcut to package.json:

  "scripts": {
    "help": "echo --List all available script commands-- && npm-package-user-scripts-list"
  }

Sample command line line result:

$ npm-package-user-scripts-list
 
Available commands (for npm run -s <cmd>):
 
  npm-package-user-scripts-command: Command from `npm-package-user-scripts` section
  lint: Lint source code
  test: Run tests
  help: List all available script commands (autotest)