これからのHaskellプロジェクトではcabalではなくpackage.yaml(hpack)を使いましょう

hpackとは

hpackとは, cabalファイルを生成してくれるツールです.

package.yamlファイルからcabalファイルを生成します.

JavaScriptに対するAltJSのようなものです.

hpackのフォーマットであるpackage.yamlはyamlフォーマットです.

独自のフォーマットを採用しているcabalとは違い, 様々なエディタが普通に対応しており, プログラムからも扱いやすくなっています.

default-language: Haskell2010のような現代では当たり前の記述を自動生成してくれるため, わざわざ書かなくて済むようになります.

cabalではexportするモジュールを全てlibraryのexposed-modulesに書かなくてはいけませんでした.

hpackでは

library:
  source-dirs: src

のように書くだけで, src以下のモジュールを自動的にcabalに書いてくれます.

長い記述が不要になり, モジュールの名前が変わっても自動的に変更されるので, 楽です.

hspecなどを使うとtest-suiteのother-modulesにたくさんSpecモジュールを書く必要がありますが, hpackを使うとこれも自動生成してくれます.楽です.

cabalではlibraryとtest-suiteなどのbuild-dependsに共通部分があっても, それらを全てコピペして並べなければいけませんでした.

面倒くさいですし, 共通の依存が並んでいるとtest-suiteだけが要求するライブラリがわかりにくくなります.

hpackではトップレベルの場所にdependencies:を書いておくと, cabalファイルではlibraryもexecutablesもtest-suiteもこの依存を継承するようになります.

後は以下のようにtests部分だけにtestだけが要求する依存をわかりやすく記述することが出来ます.

tests:
  test:
    main: Spec.hs
    source-dirs: test
    dependencies:
    - foo-application
    - hspec
    - yesod-test

github: user/repo

のようにgithubのリポジトリを指定すると, 自動的にcabalにhomepage, bug-reports, source-repositoryを記述してくれます. 楽です.

cabalでは変数が使えなかったため, 共通する記述もコピペするしか書く方法がありませんでしたが, hpackでは変数が使えるため, 例えば共通するghcオプションなどを変数にまとめ, それぞれの場所で展開することが出来ます.

現在のstackはhpackにデフォルト対応しているため, package.yamlが存在するディレクトリでstack buildすれば自動的にcabalファイルを作成してビルドしてくれます.

cabalファイルは自動生成されるようになるため, cabalファイルは.gitignoreで除外しておくようにしましょう.

stack new foo simple-hpackのようにすると, hpackでプロジェクト設定が生成されます.

また, yesodもhpackを採用するようになったため, stack new foo yesod-postgresなどをしてもhpackが使われるようになります.

hpack-convert: Convert Cabal manifests into hpack's package.yamlsを使えばcabalファイルから簡単にpackage.yamlを作成することが出来ます.

このツールは結構賢く, 共通部分を自動的にまとめたpackage.yamlが生成されます.