Haskellプロジェクトを始めるにあたって

stackはプロジェクトを管理するツールっていうのかな？まぁビルドツールになったりパッケージマネージャーになったりghcを管理するのに使ったりなんかまぁそういうツールです(なんて言えばいいんだろう)。

linux系なら公式ドキュメントを見ながら次のようにするといいと思います。

  $ curl -sSL https://get.haskellstack.org/ | sh
  # stackのinstall

  $ stack setup
  # GHC(コンパイラ)を入れる

stackを入れてから stack setup でコンパイラが入るのでのんびり待ちます。 ~/.local/bin/ にパスを通しておきます。

• emacsの人: intero

• spacemacsの人: haskell layer

• IntelliJ IDEAの人: intellij-haskell

を使いましょう。その他のエディタは知らない(emacs/intellijのプラグインが特に優秀みたいなので可能ならどっちかを使うのがいいんじゃないでしょうか)。

[2017/12/16追記]

どうやらstackのデフォルトテンプレートであるnew-templateがいつの間にやらhpackを使うように変わったようです。なので、以下のsimple-hpackは不要で普通に stack new [プロジェクトの名前] とすれば同じものが得られます¹。

stack newが終わると必要なファイル群と stack.yaml と package.yaml が出来ます。 ここでpackage.yamlを適当に編集します(しなくても問題ないです)。

  $ stack build

でビルドできればOKです。

そして私はこのタイミングでgit関連のあれこれをします。 gitignore生成にはgiboを、git強化にgit-flowを使っています。

  $ gibo Haskell > .gitignore
  # .gitignore を作る

  $ echo "*.cabal" >> .gitignore
  # hpackを使っているならcabalは不要

  $ git init && git add . && git commit -m 'initial commit'

  $ git flow init

パッケージを追加したいときはpackage.yamlのdependenciesに追加します。 バージョンの指定とかできますが別にしなくていいです。

  dependencies:
    - base
    - lens
    - mtl
    ...

上のやり方で上手く行くのはパッケージがstackage(Haskellのパッケージを各バージョンごとに登録しとくところ)にある場合だけです。 hackageにパッケージがある場合はstack.yamlのextra-depsに バージョンまで含めて 書きます。

  extra-deps:
  - package-1.2.3.4
  ...

といっても、これが必要な場合はstack buildした時点でstackがこういう風に書けって教えてくれるので、それをコピペするだけでいいです。

例えばgithubにしかパッケージがない場合も同じくstack.yamlのextra-depsに追加します(参照)。

  extra-eps:
  - git: git@github.com:hoge/piyo.git
    commit: commitID

よく使うGHC拡張はpackage.yamlのdefault-extensionsに書いておきます。

  default-extensions:
  - Strict
  - LambdaCase
  - GADTs
  - TemplateHaskell
  ...

まぁこの辺はお好みで。

好きなものを使えばいいと思います。 私はtastyをよく使います。tastyはtasty-hunitやtasty-quickcheckなんかがあるので色んなテストのかき方が出来たりtasty-discoverでテストを自動で検出して走らせたりできるので便利です。

package.yamlに

  tests:
    hoge-test:
      source-dirs: test
      main: Driver.hs
      dependencies:
      - base
      - hoge
      - tasty

みたいにして書いて、 test/Driver.hs に

  {-#
    OPTIONS_GHC -F
    -pgmF tasty-discover
    -optF --tree-display
  #-}

と書くと使えます。 stack test であとは勝手にテストが走ります。便利。

stackはresolverで指定されたsnapshotを常に参照します(globalでもlocalでも)。 しばらく開発しているとこれが古くなったりするので、例えば

  $ stack config set resolver lts

とかするとltsの最新版にあげてくれます。

(例えば)executableなパッケージで実行には特定のリソースファイルが必要とします。 こういう場合はpackage.yamlのdata-filesに書きます。

  data-files:
  - resources/hoge.txt

ところでこのパッケージが testpackage という名前だった場合、

  library:
    other-modules:
    - Paths_testpackage

と書いておくと、

  import Paths_testpackage

  -- data-filesに書いたファイル名からそのファイルのパスを得るには次の関数を使う
  -- getDataFileName :: FilePath -> IO FilePath

みたいなことが出来ます(参照)。

executableでMain.hs以外から実行しようとすると怒られるかもしれませんが -main-is オプションで回避できます。

  executables:
    hoge:
      source-dirs:
      - app
      main: Run.hs
      ghc-options: -main-is Run