prh /prh

proofreading helper

★ 300⑂ 23👁 11⑃ 114● 22▤ 9
TypeScriptMITCreated 2014-12-18
Download: v7.0.0v7.0.0 ↓7.0.02026-11-07
+1
Daily
300
stars
23
forks
11
watchers
114
prs
22
issues
9
releases

README

proofreading-helper 

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

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



 インストール

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


$ 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 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
 yaml-language-server: $schema=https://raw.githubusercontent.com/prh/prh/master/prh.schema.json
version: 1

imports:
  - ./prh-rules/media/techbooster.yml


 --diff オプション

unified diff形式で変更点を出力します。
colordiffと組み合わせると標準のレポートより見やすくなるかもしれません。


$ prh --diff sample.md
Index: sample.md
===================================================================
--- sample.md	before
+++ sample.md	replaced
@@ -1,4 +1,4 @@
  サンプルですよ

-cookieとjqueryという表記は正しいだろうか?
+CookieとjQueryという表記は正しいだろうか?


 --stdout オプション

校正を適用した結果をstdoutに出力します。


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

CookieとjQueryという表記は正しいだろうか?


v3.x系まではこのオプションがデフォルトの振る舞いでした。

 --verify オプション

チェック結果をexit codeとして出力します。
文章のテストやCIなどに組み込む際に便利です。


$ prh --verify sample.md
Error: sample.md failed proofreading
    ....
$ echo $?
1


 -r, --replace オプション

指定したファイルの校正結果を直接ファイルに上書きします。


$ prh --replace sample.md
replaced sample.md

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

CookieとjQueryという表記は正しいだろうか?


 修正点を意図的に無視させる

prh単体の利用ではMarkdownやRe:VIEWなどのファイルの構造は考慮できません。
そのため、URLの一部が変換されてしまったりします。
他にも意図的に指摘内容を無視したい場合があります。

そんな時、 prh:disable プラグマを使うことができます。
prhは文章を段落毎に処理し、段落にプラグマが含まれる場合大本のルールよりそちらの支持を優先します。
具体例を見ていきましょう。


@ prh:disable
ここの段落は全く校正されない。

@ prh:disable:web
web→Webの校正ルールがある場合。
ここの段落はwebというワードが含まれていても無視するよう指定されているので警告されない。

@ prh:disable:web|jquery|[abc]
無視ルールは正規表現として解釈されるため複雑な条件も記述できる。

ルールは後置することもできる。
@ prh:disable


こんな塩梅です。
この例はRe:VIEWのコメント記法を使っていますが、お使いのフォーマットでコメントと解釈される任意の構造を使うことができます。
Markdownであれば  とすることができます。
このため、無視するルールの記述に半角スペースを利用することができなくなっています。
代わりに \s などを使ってください。

 リリース手順

npmへのpublishはG

Top issues

Latest release

v7.0.0 v7.0.0 2026-11-07
破壊的変更

- パッケージを ESM のみにしました(132)。CommonJS からは、Node.js 22.12 以上なら require("prh") で引き続き読み込めます。prh/lib/rule のような内部ファイルの直接 import も使えます。Jest の CommonJS モードなど、require(esm) に対応していない環境からは読み込めません。
- Node.js 22.12.0 以上が必要になりました(131)。
- YAML の読み込みに js-yaml 5 を使い、YAML 1.2 の Core スキーマで解釈するようになりました(117)。マージキー(<<)は引き続き使えます(131)。日付(timestamp)などの YAML 1.1 固有の型は、文字列として読み込まれます。
- pattern の /.../ 形式で、フラグ s と u を解釈するようになりました(93)。これまでリテラルとして扱われていた /usr/local/su のような文字列は正規表現として扱われ、/usr/bin/ss のように同じフラグが重なる文字列はエラーになります。
- --rules-yaml の出力の書式が変わることがあります。


 What's Changed
 chore(deps): bump commander from 1

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON