haddock作成時にエラーが起きる

Question

haskellでhaddock作成時にエラーが起きます。

haskellでstackを使ってhaddockを出力時に
lensパッケージを削除すると
エラーが発生しなくなりました。

実行コマンド
$stack haddock .

発生している問題・エラーメッセージ

<stderr>: commitAndReleaseBuffer: invalid argument (invalid character)

<stderr>: commitAndReleaseBuffer: invalid argument (invalid character)

<stderr>: commitAndReleaseBuffer: invalid argument (invalid character)

該当のソースコード

Lib.hs

module Lib where
someFunc :: IO ()
someFunc = putStrLn "someFunc"

package.yaml

dependencies:
- base >= 4.7 && < 5
- lens

stack.yaml

resolver:
  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/17/10.yaml

# User packages to be built.
# Various formats can be used as shown in the example below.
#
# packages:
# - some-directory
# - https://example.com/foo/bar/baz-0.0.2.tar.gz
#   subdirs:
#   - auto-update
#   - wai
packages:
- .

試したこと

警告を抑制したらいいのかなと思って以下をしても問題解決せず

$stack haddock . --haddock-arguments "--optghc=-Wno-unused-imports" --open --ghc-options "-Wno-unused-imports"

補足情報（FW/ツールのバージョンなど）

環境
windows 10
$stack --version
Version 2.5.1, Git revision d6ab861544918185236cf826cb2028abb266d6d5 x86_64 hpack-0.33.0

Comments

[igrep]

stack.yaml の中身も載せてください。そうすれば使用しているGHCやhaddockのバージョンが分かるので。

[igrep]

本題と無関係なのでここに書きます。
stack.yamlのresolverの行ですが単に`resolver: lts-17.10` と書くだけで良いです。

[qoopty]

ここのresolverのところですね。
https://docs.haskellstack.org/en/v1.0.2/yaml_configuration/#resolver
特に今は触るつもりはなかったので、デフォルトのままの設定にしてました。

[igrep]

なるほど。しばらく新しいプロジェクトを作っていなかったので気づいてませんでしたが、今はstack newやstack initしたときのデフォルトがそうなってるんですね！

Answer 1

chcp 65001
$stack haddock .

Answer 2

もし先ほどの回答で直らなかったのであれば、 -Wunused-imports 以外の警告もすべて無効にしてみてください。以下のコマンドでできるはずです:

stack haddock . --haddock-arguments "--optghc=-w" --open --ghc-options "-w" 

「lensパッケージを削除したら発生しなかった」とのことなので、手元で stack haddock lens してみました。が、しかし再現しなかったのでこの解決策は推測ですが、stack haddock lens してみた結果、問題の <stderr>: commitAndReleaseBuffer: invalid argument (invalid character) がでるべきところ（vectorパッケージをビルドする際の警告の直後）でadjunctionsパッケージにおける警告が出ました:

adjunctions         > [ 1 of 11] Compiling Control.Monad.Trans.Conts
adjunctions         > [ 2 of 11] Compiling Data.Functor.Contravariant.Rep
adjunctions         >
adjunctions         > src\Data\Functor\Contravariant\Rep.hs:42:17: warning: [-Wstar-is-type]
adjunctions         >     Using 窶・窶・(or its Unicode variant) to mean 窶魯ata.Kind.Type窶・[0m
adjunctions         >     relies on the StarIsType extension, which will become
adjunctions         >     deprecated in the future.
adjunctions         >     Suggested fix: use 窶狼ype窶・from 窶魯ata.Kind窶・instead.
adjunctions         >    |
adjunctions         > 42 |   type Rep f :: *
adjunctions         >    |                 ^
adjunctions         >

上記の警告における Using 窶・窶・(or its Unicode variant) to mean 窶魯ata.Kind.Type窶・ や 窶狼ype窶・from 窶魯ata.Kind窶・instead. などと書かれている箇所は、文字化けした箇所です。
件のinvalid argument (invalid character) はこの文字（を含むバッファー）を書き出す際に発生したと考えられます。なので、お察しの通りGHCの警告を無効にすれば回避できるはずです。

この問題、invalid argument (invalid character)がでるのは問題のある文字列を出力しようとしたときなので、問題が発生したときの出力からは直接の原因が分からないので辛いですね...

Answer 3

vector             > Warning: 'fromList' is ambiguous. It is defined

などの、vectorパッケージのビルド時にでている警告は問題の原因ではないです。
一番大きな問題はその下の

<stderr>: commitAndReleaseBuffer: invalid argument (invalid character)

です。

こちらで解説しているエラーと思われるので、ひとまず、あらかじめコマンドラインで

chcp 65001

を実行してから再度 stack haddock してみてください。

Comments

[qoopty]

$chcp 65001
$stack haddock .
で解決しました
ありがとうございます。