Node.js
npm

Node で作るオレオレ CLI と npm への登録までの道のり

More than 5 years have passed since last update.

Node で簡単にオレオレ CLI を作る方法をご紹介。


準備

まずは適当にディレクトリを作成し、npm init で package.json を生成。

$ mkdir oreore && cd oreore

$ npm init

生成された package.json を編集しましょう。

{

"name": "oreore",
"version": "1.0.0",
"description": "ore no CLI",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "astronaughts",
"license": "MIT"
}

これを以下のように直します。

{

"name": "oreore",
"version": "1.0.0",
"description": "ore no CLI",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "astronaughts",
"license": "MIT",
"preferGlobal": true,
"bin": {
"oreore": "bin/oreore"
}
}

追加したのは preferGlobalbin です。



  • preferGlobal: Global でインストールされないとエラーを出す


  • bin: npm インストールしたときに path をうまい事やってくれます。


作り方

ディレクトリ構造は以下の様な形です。


  • oreore/


    • bin/


      • oreore



    • lib/


      • oreore.js



    • package.json




bin/oreore の中身

#!/usr/bin/env node


'use strict';

var oreore = require('../lib/oreore');
oreore.run();


lib/oreore.js の中身

var cli = module.exports;

cli.run = function() {
console.log('oreore!');
};


実行してみる

以下のコマンドを実行。

$ node bin/oreore

oreore!


公開(後悔)

npm publish してオレのものをみんなのものにしてみましょう。

事前に npm adduser しておいてください。

$ npm publish .

npm http PUT https://registry.npmjs.org/oreore
npm http 201 https://registry.npmjs.org/oreore
npm http GET https://registry.npmjs.org/oreore
npm http 200 https://registry.npmjs.org/oreore
npm http PUT https://registry.npmjs.org/oreore/-/oreore-1.0.0.tgz/-rev/1-7b7bc05da1e5bafb3b562ef7555abb6c
npm http 201 https://registry.npmjs.org/oreore/-/oreore-1.0.0.tgz/-rev/1-7b7bc05da1e5bafb3b562ef7555abb6c
npm http PUT https://registry.npmjs.org/oreore/1.0.0/-tag/latest
npm http 201 https://registry.npmjs.org/oreore/1.0.0/-tag/latest
+ oreore@1.0.0

公開したけど、後悔はしてない。


確認してみる

npm サイト で検索してみましょう。

スクリーンショット 2013-11-07 13.53.10.png

ありました。恥ずかしい。

スクリーンショット 2013-11-07 13.55.29.png


インストールしてみる

登録できたら npm install してみましょう。

$ npm install -g oreore

npm http GET https://registry.npmjs.org/oreore
npm http 200 https://registry.npmjs.org/oreore
/Users/your_name/nvm/v0.10.17/bin/oreore -> /Users/your_name/nvm/v0.10.17/lib/node_modules/oreore/bin/oreore
oreore@1.0.0 /Users/your_name/nvm/v0.10.17/lib/node_modules/oreore

でけた。続いて oreore コマンドを叩いてみる。

$ oreore

oreore!

スクリーンショット 2013-11-07 13.58.50.png


完了

おしまい。