npm-scripts-info で npm-scripts の説明書きを書く

HTML5/CSS3モダンコーディングフロントエンドエンジニアが教える3つの本格レイアウトスタンダード・グリッド・シングルページレイアウトの作り方フロントエンドエンジニアが教える3つの本格レイアウ（WEB　Engineer’s　Books） [ 吉田真麻 ]

ジャンル: 本・雑誌・コミック > PC・システム開発 > その他
ショップ: 楽天ブックス
価格: 2,894円

以前 Gulp スクリプトの説明書きが書ける「Gulp-Description」という npm パッケージを紹介した。

neos21.hatenablog.com

今回はこれの npm-scripts 版といえる、npm-scripts-info というパッケージを紹介する。

npm-scripts-info

まずはインストール。

$ npm install npm-scripts-info -D

説明書きを追加するやり方はいくつかあって、一つは package.json に scripts-info というプロパティを作るというもの。

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

このようにして npm run info を実行すると、scripts-info に書いたタスク名とその説明が表示される。

もう一つのやり方は、scripts の中に ?【タスク名】 と書く方法。

{
  "name": "my-project",
  "scripts": {
    "?info": "Display information about the scripts.",
    "info": "npm-scripts-info",
    
    "?watch:build": "Watch codebase, trigger build when source code changes",
    "watch:build": "webpack --watch",
    
    "?start": "echo Kickstarts the application.",
    "start": "node index"
  }
}