cabal install コマンドについて

• stack install と全く同じ動作をする cabal コマンドは cabal install all:exes です。

今回利用した cabal と stack のバージョンは以下の通りです。

$ cabal -V
cabal-install version 3.0.0.0
compiled using version 3.0.0.0 of the Cabal library 

$ stack --version
Version 2.1.3, Git revision 636e3a759d51127df2b62f90772def126cdf6d1f (7735 commits) x86_64 hpack-0.31.2

この記事では stack install コマンドと cabal install コマンドの挙動の違いなどについて調査した結果等をまとめています。

プロジェクトの構成

例えば、プロジェクトが以下のような構成になっていて、executable (mainExe1, mainExe2, subExe1, subExe2) が定義されているとしましょう。

$ tree .
.
├── app
│   ├── Main1.hs
│   └── Main2.hs
├── cabal.project
├── stack.yaml
├── subs
│   ├── pkg1
│   │   ├── app
│   │   │   └── Main.hs
│   │   └── pkg1.cabal
│   └── pkg2
│       ├── app
│       │   └── Main.hs
│       └── pkg2.cabal
└── app.cabal

プロジェクトのコード

stack install と cabal install の違い

cabal install

cabal install に指定可能なコマンドをいくつか試してみて、実際に何がインストールされるか一覧にしました。

• cabal install や stack install . の挙動など、いくつか stack と異なる場合があるので注意が必要です。
• 注意点: 全てのパッケージに executable が含まれている場合に限り実行可能です。
  • cabal install all で executable が含まれていないパッケージがある場合は以下のようなエラーになります。

cabal: Cannot build the executables in the package pkg2 because it does not
contain any executables. Check the .cabal file for the package and make sure
that it properly declares the components that you expect.

• stack install に相当するコマンドは cabal install all:exes です。

stack install

同様に stack install も確認しました。

エラー 1

$ stack install . pkg1 pkg2
The following errors occurred while parsing the build targets:
- The package pkg1 was specified in multiple, incompatible ways: . pkg1
- The package pkg2 was specified in multiple, incompatible ways: . pkg2

エラー 2

$ stack install all
Error: While constructing the build plan, the following exceptions were encountered:
Unknown package: all
Some different approaches to resolving this:
Plan construction failed.

その他の指定方法

cabal

エラー1

$ cabal install app:exe
cabal: Unknown target 'app:exe'.
The package app has no component 'exe'.

stack

エラー1

$ stack install app:exe
Error parsing targets: Component exe does not exist in package app

エラー2

$ stack install exe:mainExe1
Error parsing targets: Unknown local package: exe

エラー3

$ stack install mainExe1
Error: While constructing the build plan, the following exceptions were encountered:
Unknown package: mainExe1
Some different approaches to resolving this:
Plan construction failed.

cabal install で良く使うオプション

--overwrite-policy=always を毎回指定するのが面倒な場合は

$ cabal user-config update -a overwrite-policy:always

というコマンドで ~/.cabal/config に設定できます。

3.2.0.0 で変更になる点など

• Copy on windows #6519

Windows 環境において cabal install の際のデフォルトの挙動が変更されます。シンボリックリンクが作成できない場合は自動的にコピーになります。

• Implement cabal install -z #6428

ローカルのプロジェクト設定を無視するオプション -z, --ignore-project が追加されます。

• Resolve #6369 and #6393: Allow cabal v2-install pkgname:exename or http://example.com/package.tar.gz(#sha256=abcde…) #6576

$ cabal install 'https://hackage.haskell.org/package/cabal-fmt-0.1.2/cabal-fmt-0.1.2.tar.gz#sha256=aae556efbcaddfd65c6a1c1811b122b0d8c8d00624c8c2e36aabb5e9f9ea9840'