More than 3 years have passed since last update.

Goのプロジェクトでもタスクランナーとしてnpmを使う

Posted at 2020-06-21

Go のタスクランナーとして npm を使ってみたら案外よかった。Go に限った話ではないけど、Go が特に開発ツールチェーン周りの管理がしにくいので噛み合いやすいのではないかと思う。

npm は Node.js 用のパッケージマネージャだが、npm-scripts という簡易なタスクランナー機能がついている。また、Node.js 用の便利な開発ツールをそのまま利用できて、開発ツールのインストールも一括で管理できる。

npm をタスクランナーとして使う利点

Node.js をインストールすれば npm も標準で付属する。

npm で管理したいプロジェクトに package.json を作成する。

package.json

{
  "name": "go-project",
  "private": true,
  "scripts": {
    "test": "go test -v ./...",
    // ...
  }
}

"scripts" フィールドに "スクリプト名": "コマンド..." の形でタスクを書くと、npm run スクリプト名 の形で実行できる。

Node.js 用の開発ツールといえど、JavaScript 以外でも使える便利なツールが多数存在する。npm install -D パッケージ名 でパッケージの追加ができる。下記の点に注意する。

package.json に追加したパッケージは、別環境でも npm install で一括インストールできるようになる。

husky はコミットフックを管理できるようにするツール、lint-staged は git でステージングされているファイルに linter を走らせるためのツール。

$ npm install -D husky lint-staged

設定は package.json に書く (別ファイルにもできる)。

package.json

{
  // ...
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.go": "go fmt"
  }
}

上記のようにするとコミット前の go のソースコードに自動で go fmt できる。

Prettier といえば JavaScript 用のフォーマッタだが、それ以外のファイルタイプのフォーマットにも対応している。

$ npm install -D prettier

上記の husky、lint-staged と組み合わせればコミットフックで上記ファイルのフォーマットもできる。

package.json

{
  // ...
  "lint-staged": {
    "*.go": "go fmt",
    "*.{md,yml,json}": "prettier --write"
  }

他にも導入すると便利かもしれないツール。マルチプラットフォームで動作するようにさせるものも多い。参考: npm-scripts で使える便利モジュールたち - Qiita