あなたの校正を手伝ってくれるライブラリ。
今まで、校正作業は主に編集のフェーズの作業でした。 これからは校正情報を編集者が作り、著者が執筆しながら自分で校正を行うようになります。
自分のライブラリに組み込んで使う場合。
$ npm install --save prh
コマンドラインツールとして使う場合。
$ npm install -g prh
テキストファイルであれば、どのようなファイルであっても処理対象にすることができます。
$ prh --help
Usage: prh [options] [command] [--] [files...]
Options:
--rules-json emit rule set in json format
--rules-yaml emit rule set in yaml format
--rules <path> path to rule yaml file
--verify checking file validity
--stdout print replaced content to stdout
--diff show unified diff
--verbose makes output more verbose
-r, --replace replace input files
Commands:
init generate prh.yml
実際に利用した場合の出力例。
# 校正前のファイル例
$ cat sample.md
# サンプルですよ
cookieとjqueryという表記は正しいだろうか?
# チェックにひっかかる箇所の表示
$ prh sample.md
sample.md(3,1): cookie → Cookie
sample.md(3,8): jquery → jQuery
校正ルールをオプションで指定しない場合、校正対象となるファイルと同じディレクトリ、またはそれより上の階層で最初に見つかったprh.ymlを利用します。
どのファイルに対してどの校正ルールが利用されているか確認したい場合、 --verbose オプションを利用してください。
基本的な書き方についてはmisc/prh.ymlを参照してください。
実用するための設定ファイルはprh/rulesのmedia/techbooster.ymlがおすすめです。
その他、prh/rulesに各種設定を取り揃えてあるので、好きに組み合わせてご利用ください。
init サブコマンドでbasicな設定ファイルを作成できます(実用には不向き)。
$ prh init
create prh.yml
see prh/rules collection https://github.com/prh/rules
実用上は git submodule add https://github.com/prh/rules.git prh-rules して好きなルールを使います。
これを参照するprh.ymlは次のように書きます。
# yaml-language-server: $schema=https://raw.githubusercontent.com/prh/prh/master/prh.schema.json
version: 1
imports:
- ./prh-rules/media/techbooster.ymlunified diff形式で変更点を出力します。 colordiffと組み合わせると標準のレポートより見やすくなるかもしれません。
$ prh --diff sample.md
Index: sample.md
===================================================================
--- sample.md before
+++ sample.md replaced
@@ -1,4 +1,4 @@
# サンプルですよ
-cookieとjqueryという表記は正しいだろうか?
+CookieとjQueryという表記は正しいだろうか?
校正を適用した結果をstdoutに出力します。
$ prh --stdout sample.md
# サンプルですよ
CookieとjQueryという表記は正しいだろうか?
v3.x系まではこのオプションがデフォルトの振る舞いでした。
チェック結果をexit codeとして出力します。 文章のテストやCIなどに組み込む際に便利です。
$ prh --verify sample.md
Error: sample.md failed proofreading
....
$ echo $?
1
指定したファイルの校正結果を直接ファイルに上書きします。
$ prh --replace sample.md
replaced sample.md
$ cat sample.md
# サンプルですよ
CookieとjQueryという表記は正しいだろうか?
