あなたの校正を手伝ってくれるライブラリ。

今まで、校正作業は主に編集のフェーズの作業でした。 これからは校正情報を編集者が作り、著者が執筆しながら自分で校正を行うようになります。

自分のライブラリに組み込んで使う場合。

$ npm install --save prh

コマンドラインツールとして使う場合。

$ npm install -g prh

基本的な書き方についてはmisc/prh.ymlを参照。

実用するための設定ファイルはmisc/techbooster.ymlをおすすめする。

WEB+DB PRESS用語統一ルールと wzeditor-word-rules-parserを参考にした、 misc/WEB+DB_PRESS.ymlも用意している。

テキストファイルであれば、どのようなファイルであっても処理対象にすることができます。

$ prh --help
  Usage: prh [options] [command] [--] <files...>

  Options:

    --json          rule set to json
    --yaml          rule set to parsed yaml
    --rules <path>  path to rule yaml file
    -r, --replace   replace input files


  Commands:

    init  generate prh.yml

$ cat sample.md
# サンプルですよ

ウェッブではクッキーというものがあります。

$ prh sample.md
# サンプルですよ

WebではCookieというものがあります。

実際に利用する時は--replaceオプションを併用すると良い。 注意点として、prh単体の利用ではMarkdownやRe:VIEWなどのファイルの構造は考慮しない。 そのため、URLの一部が変換されてしまうなどの使いにくさがある。 実際に利用する際はprhが組み込まれている何らかのツールを介して使うのがよいだろう。

Atomのプラグインであるlanguage-reviewに組み込まれている。 エディタ上で執筆を行っていくと、自動的に校正候補が表示され、その結果を原稿に反映していくことができる。

azuさんが作成しているtextlintのプラグインとしてtextlint-rule-prhが作成されている。