proofreading helper
TypeScript JavaScript Shell
Permalink
Failed to load latest commit information.
.vscode chore(deps): update dependencies Sep 23, 2016
bin add command line client Dec 21, 2014
lib feat(prh): rules フォルダ新設とprh org移管に伴い各所を書き換え Oct 27, 2016
misc feat(prh): rules フォルダ新設とprh org移管に伴い各所を書き換え Oct 27, 2016
rules @ beef43d feat(prh): rules をgit submoduleとして配置 Oct 27, 2016
test feat(prh): rules フォルダ新設とprh org移管に伴い各所を書き換え Oct 27, 2016
tools feat(tools): WZエディタ用ルールセットからprh用yamlに近いものに変換するスクリプトを作成 Oct 17, 2016
.gitignore feat(prh): rules をgit submoduleとして配置 Oct 27, 2016
.gitmodules feat(prh): rules をgit submoduleとして配置 Oct 27, 2016
.npmignore feat(prh): rules をgit submoduleとして配置 Oct 27, 2016
CHANGELOG.md chore(prh): bump version & generate CHANGELOG.md Oct 27, 2016
Gruntfile.js chore(deps): update dependencies Sep 23, 2016
README.md feat(prh): rules フォルダ新設とprh org移管に伴い各所を書き換え Oct 27, 2016
circle.yml chore(deps): update dependencies Sep 23, 2016
index.d.ts update dependencies & bump version & switch to tsconfig.json oriented… Sep 22, 2015
index.js add index.js Aug 22, 2015
package.json chore(prh): bump version & generate CHANGELOG.md Oct 27, 2016
setup.sh Release 0.1.1 Dec 22, 2014
tsconfig.json chore(deps): update dependencies Sep 23, 2016
tslint.json chore(deps): update dependencies Sep 23, 2016

README.md

proofread-helper Circle CI

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

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

インストール

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

$ npm install --save prh

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

$ npm install -g prh

利用方法

設定ファイルの作成

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

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

その他、prh/rulesに各種設定を取り揃えてあるので、好きに組み合わせて使ってほしい。

コマンドラインツールとして

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

$ 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が作成されている。