Simple script to display usage information about your project

README.md

Simple script to display usage information about your project

Usage

Implement a help field on your project's package.json listing all the scripts you want to display information about. Just make sure to use the same keys.

$ npm run help -s

> [email protected] help /Users/gordon-freeman/dev/project-sample
> node tools/help.js

Available scripts for "project-sample"
 
   start                 Start local development server at http://localhost:3000
   deps                  Inherit dependencies from main application and persist to manifest
   help                  Display project usage information

Note: the -s will suppress npm output noise, you can still use without it if you want

help.js

import { resolve } from 'path';

// Current application manifest
const APP_BASE_PATH = resolve(`${__dirname}/../`);
const APP_MANIFEST = require(`${APP_BASE_PATH}/package.json`);

// Manifest information
const { help, name } = APP_MANIFEST;

// Simple function to Format the output message
const formatter = (script, help) => `\n   ${script} \t\t ${help[script]}`;

// Compose output message
const output = Object.keys(help)
  .map(script => formatter(script, help))
  .join('');

console.log(`Available scripts for "${name}"\n ${output}`);

package.json

{
  "scripts": {
    "start": "webpack-dev-server --progress --colors --port 3000",
    "help": "node tools/help.js",
    "deps": "node tools/inherit-dependencies.js",
    "lint": "eslint app/src"
  },
  "help": {
    "start": "Start local development server at http://localhost:3000",
    "deps": "Inherit dependencies from main application and persist to manifest",
    "help": "Display project usage information"
  }
}