darudaru

だるだるしてるエンジニア

Node.jsでちゃんとしたCLIアプリケーションを作るまで

最近、Node.jsにハマってます。勉強のために、と小さいCLIアプリケーションをちまちま作っているのですが、最近やっとちゃんとしたCLIアプリケーションが作れるようになった・・・と思います。

「ちゃんとした」とは、ただ単に動くアプリケーションという意味ではなく。

  • ドキュメントが揃っている
  • テストコードがある
  • Githubにリポジトリが公開されている
  • npmにパッケージが公開されている

といったところが揃えられてるアプリケーションという意味です。

ちゃんとする大まかな流れ

  1. プログラムを書く
  2. テストコードを書く
  3. README.mdを書く
  4. ライセンスを設定する
  5. Githubに公開する
  6. npmに公開する

1. プログラムを書く

わたしは最初にGithubにリポジトリを作っちゃう派です。そして、ある程度動くものができたら、その都度commitしていきます。
そうしてバージョン管理しておかないと開発途中に、やっぱりあの状態に戻りたい!ってなったときに戻る手段がなくて困るからです。

2. テストコードを書く

TDDじゃないです。後からテストコードを書きます。最終的にテストコードがあればいっかなぐらいで思ってます。
avaというテストフレームワークが軽量で良さげだったので、こちらを使ってます。

github.com

テストコードは書けたら、Travis CIで自動で実行するようにしておきます。

Travis CI - Test and Deploy Your Code with Confidence

3. README.mdを書く

わかりやすいREADME.mdを書く | SOTA

いつもこちらの記事を参考に書いています。
テストコードをTravis CIで回してるので、せっかくなのでテスト結果のバッジもつけておきます。

f:id:skanoemon:20180602224123p:plain

よく見るやつですね。

4. ライセンスを設定する

Githubの画面から、Create new file > LICENSEのファイル名を設定 > ライセンス選択 で設定する方法が一番楽だと思います。

5. Githubに公開する

全部揃ったらgit pushします。

6. npmに公開する

npm publishします。

これで終わりです。

公開したあとはnpm install パッケージ名でインストールしてニヤニヤしましょう。