先日仕事でパッケージを作っていて、semantic-releaseを知って感動したので記事にすることにしました。

まず、semantic-releaseの良いところは

masterブランチにpushしたら自動でパッケージのバージョンが上がって、パッケージが更新されること
コミットメッセージから自動でRelease Noteを作成してくれることだと思います。また、バージョン毎のタグ付けだったり、コミットのリンクもつけてRelease Noteを作ってくれてすごく良く自動化されていると思います。ただ、semantic-releaseを使うにあたって、ドキュメントがイマイチ読みづらく実際に使ってみないと良さが分からないなと思ったので、この記事を呼んだらsemantic-releaseの良さを分かってくれるような記事にしたいです。

セットアップ

では、早速プロジェクトを作って見ましょう今回は究極にシンプルなcliを作ります今回はsayHelloとコマンドを叩いたらHello!と返ってくるcliを作ります

こちらの記事を参考に作りました

mkdir semantic-release-tutorial
npm init -y
mkdir lib
touch lib/cli.js

module.exports = () => {
  console.log("Hello!")
}

{
  // ...
  "bin": {
    "sayHello": "bin/cli.js"
  },
  // ...
}

コマンドとファイルのマッピングはbinフィールドでします

mkdir bin
touch bin/cli.js

#! /usr/bin/env nodeはnodeの環境を作るためにあります。ためしにcommand lineで/usr/bin/env nodeと実行してみてください nodeが起動するはずです詳細はこちらを見てみてください

npm linkを使って手元で試せるようにします npm linkを使うとグローバルなパッケージがインストールされる場所にシンボリックリンクが作られます

これでコマンドラインでsayHelloとうつとHello!と返ってくるはずです