Prettierによる整形で原稿MDファイル内容が書き換えられてしまう問題

[MurakamiShinyu]

このリポジトリではpackage.jsonの次の設定によってcommit時にprettierによる整形が実行されるようになっている：

themes/package.json

Lines 34 to 38 in da19c8d

	"husky": {
	"hooks": {
	"pre-commit": "lint-staged && pretty-quick --staged"
	}
	},

各テーマパッケージのexampleの原稿MDファイルに対してこれが適用されて次のように意図しない書き換えがされてしまうことがある：

• 和文文字と欧文文字との間にスペース（U+0020）が挿入される（prettier v2の問題）
  • 和欧文間スペースの処理はCSS組版エンジンで行われるものなので、原稿テキストにこのようなスペース文字を入れるべきではない
  • この問題については、prettier v3では修正されている：
    • Do not insert whitespaces between latin and cj letters prettier/prettier#6385
• 意図的に入れている段落の行頭の全角スペース(U+3000)が削除される
  • 電書協EPUB3制作ガイドでは段落の字下げに全角スペースを入れる（行頭が括弧以外の場合）ことが勧められている。この形式の原稿が扱えないのは問題。
• VFMでの見出しの属性記法で、見出しの行のあと改行してから属性記法 { … } を書いている場合（見出しの内容がインラインの要素で終わるときそうする必要がある）、改行がさらに追加されて空白行があいだにできる。そうすると見出しの属性記法ではなくなってしまい、{ … } がテキストとして出力されてしまう事故になる。

このうち問題のうち最初の「和文文字と欧文文字との間にスペース（U+0020）が挿入される」については、prettierのバージョンを現在使われている v2 から最新の v3 に更新すると解決するはず。しかし、commit時のprettier実行のために使われているpretty-quickがprettier v3に対応していないという問題があり、prettierを最新にするためにはpretty-quickをほかのものに置き換える必要がある。そのpretty-quickのissue:

• pretty-quick will break with prettier v3 prettier/pretty-quick#164

実際に問題が起きた例：

• Add theme-epub3j（日本語EPUB3用テーマ） #118 の電書協のEPUBサンプルをベースにMD化したサンプルをコミットしたとき、この意図しない書き換えが生じた。そのあとそれを直したコミット 8c69966 での差分を参照。

当面の対策としては、.prettierignore ファイルでMDファイルが整形対象にならないようにする。例：

themes/.prettierignore

Line 2 in da19c8d

packages/@vivliostyle/theme-epub3j/**/*.md