Node.js製 ツールの作成

NodeJS 自作コマンド

概要

npm コマンドを使ってNode.js製CUIツールを作ることができる。

流れ

  1. 実行ツールパッケージの作成 npm init
  2. コマンドの定義と実装
  3. グローバル領域へのインストール npm link -g

詳細

1. パッケージの作成

$ npm init
hello/
    package.json
    main.js

2. コマンドの定義と実装

package.jsonにbin項目を追加する

{
  "name": "hello",
  "version": "1.0.0",
  "description": "",
  "main": "main.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "bin": {
     "hello" : "main.js",
  },
  "author": "",
  "license": "ISC"
}

main.js

#!/usr/bin/env node

console.log('Hello World')

3. インストール

パッケージディレクトリ配下で以下のコマンドを実行する

$ npm link
  • root権限が必要
  • /usr/local/lib/node_modules/パッケージ名 にファイルがインストールされる
  • /usr/local/bin 配下にツールへのシンボリックリンクがはられる

アンインストール

２つ方法がある。

1. npm unlink

パッケージディレクトリ配下

$ npm unlink

2. npm uninstall

$ npm uninstall -g パッケージ名