サンプル原稿のチェック

試行その１

それでは、サンプル原稿をtextlintでチェックします。

＞ textlint test.txt
C:○○･･･／test.txt
  17:33  error  文末が"。"で終わっていません。                 preset-ja-technical-writing/ja-no-mixed-period
  20:3   error  Line 23 exceeds the maximum line length of 90  preset-ja-technical-writing/sentence-length
  23:84  error  文末が"。"で終わっていません。                 preset-ja-technical-writing/ja-no-mixed-period
  23:88  error  Line 25 exceeds the maximum line length of 90  preset-ja-technical-writing/sentence-length
  25:95  error  文末が"。"で終わっていません。                 preset-ja-technical-writing/ja-no-mixed-period
  27:43  error  文末が"。"で終わっていません。                 preset-ja-technical-writing/ja-no-mixed-period

✖ 6 problems (6 errors, 0 warnings)

サンプル原稿に対する指摘が意味不明です。原因がわかりません。

試行その２

Windowsでサンプル原稿を書いたので文字コードがシフトJISになっていました。UTF-8に変更してみました。

＞ textlint test.txt
C:○○･･･／test.txt
   1:14  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
   4:30  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
   4:34  ✓ error  文末が"。"で終わっていません。末尾に不要なスペースがあります。  preset-ja-technical-writing/ja-no-mixed-period
   9:21  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  10:23  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  10:33  ✓ error  文末が"。"で終わっていません。末尾に不要なスペースがあります。  preset-ja-technical-writing/ja-no-mixed-period
  13:19  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  14:13  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  14:15  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  16:17  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  17:12  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  18:16  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  19:24  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  19:36  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  23:19  error    文中に逆接の接続助詞 "が" が二回以上使われています。            preset-ja-technical-writing/no-doubled-conjunctive-particle-ga
  23:50  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  25:29  error    同じ接続詞が連続して使われています。                            preset-ja-technical-writing/no-doubled-conjunction
  25:54  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period
  27:18  error    文末が"。"で終わっていません。                                  preset-ja-technical-writing/ja-no-mixed-period

✖ 19 problems (19 errors, 0 warnings)
✓ 2 fixable problems.
Try to run: $ textlint --fix [file]

文末が”。”なのに、「文末が”。”で終わっていません。」という指摘が発生しています。

試行その３

Windowsでサンプル原稿を書いたので改行コードが「CR+LF」になっていました。
改行コードをLinux系の「LF」に変更してみます。

＞ textlint test.txt
C:○○･･･／test.txt
   1:14  error    文末が"。"で終わっていません。                                                                                                                              preset-ja-technical-writing/ja-no-mixed-period
   7:12  error    文末が"。"で終わっていません。                                                                                                                              preset-ja-technical-writing/ja-no-mixed-period
   9:29  error    文末が"。"で終わっていません。                                                                                                                              preset-ja-technical-writing/ja-no-mixed-period
  10:32  error    文末が"。"で終わっていません。                                                                                                                              preset-ja-technical-writing/ja-no-mixed-period
  16:32  error    文末が"。"で終わっていません。                                                                                                                              preset-ja-technical-writing/ja-no-mixed-period
  18:33  error    文末が"。"で終わっていません。                                                                                                                              preset-ja-technical-writing/ja-no-mixed-period
  19:42  error    文末が"。"で終わっていません。                                                                                                                              preset-ja-technical-writing/ja-no-mixed-period
  23:19  error    文中に逆接の接続助詞 "が" が二回以上使われています。                                                                                                        preset-ja-technical-writing/no-doubled-conjunctive-particle-ga
  25:53  error    同じ接続詞が連続して使われています。                                                                                                                        preset-ja-technical-writing/no-doubled-conjunction
  27:35  ✓ error  "することができます"は冗長な表現です。"することが"を省き簡潔 な表現にすると文章が明瞭になります。参考: http://qiita.com/takahi-i/items/a93dc2ff42af6b93f6e0  preset-ja-technical-writing/ja-no-redundant-expression

✖ 10 problems (10 errors, 0 warnings)
✓ 1 fixable problem.
Try to run: $ textlint --fix [file]

それらしい指摘になりました。

textlint文章チェック結果

23行目の指摘「文中に逆接の接続助詞 “が” が二回以上使われています。」

Re:VIEWは素晴らしいツールですが、Windowsへのインストールが難しいと言われていましたが、2018年現在は簡単にインストールできます。

確かに、「○○ですが、□□いましたが、△△できます」という問題のある日本語です。

25行目の指摘「 同じ接続詞が連続して使われています。」

Re:VIEWは素晴らしいツールです。しかし、Windowsへのインストールが難しいと言われていました。しかし、2018年現在は簡単にインストールできます。

確かに、「○○です。しかし、□□いました。しかし、△△できます」という問題のある日本語です。

27行目の指摘「 “することができます”は冗長な表現です。」

Re:VIEWは素晴らしいツールです。技術用ドキュメントを簡単に記述することができます。

確かに、「記述することができます」という冗長な日本語です。

チェックする原稿は、UTF-8エンコードで改行コードはLFにするとうまくチェックしてくれました。

textlint自動修正

fixable problem指摘は、「–fix」オプションを付けると指摘内容を自動修正します。

＞ textlint --fix test.txt
C:○○･･･／test.txt
  27:35  ✔   "することができます"は冗長な表現です。"することが"を省き簡潔 な表現にすると文章が明瞭になります。参考: http://qiita.com/takahi-i/items/a93dc2ff42af6b93f6e0  preset-ja-technical-writing/ja-no-redundant-expression

✔ Fixed 1 problem
✖ Remaining 7 problems

27行目の「技術用ドキュメントを簡単に記述することができます。」が「技術用ドキュメントを簡単に記述できます。」に自動修正しました。

Re:VIEWプラグイン追加

まだ「文末が”。”で終わっていません。」という指摘が残っています。Re:VIEW構文の行が指摘されています。

textlintにRe:VIEWプラグインを追加します。

＞ npm install --save-dev textlint-plugin-review
npm WARN deprecated textlint-ast-test@1.1.4: See https://github.com/textlint/textlint/issues/455
npm WARN deprecated txt-ast-traverse@1.2.1: See https://github.com/textlint/textlint/issues/455
npm WARN text01@1.0.0 No description
npm WARN text01@1.0.0 No repository field.

+ textlint-plugin-review@0.3.3
added 3 packages in 18.375s

package.jsonを確認します。

＞ type package.json
{
  "name": "text01",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "textlint": "^10.2.1",
    "textlint-plugin-review": "^0.3.3",
    "textlint-rule-preset-ja-technical-writing": "^2.0.0"
  }
}

.textlintrcにプラグイン記述を追加します。

{
  "rules": {
    "preset-ja-technical-writing": true
  },
  "plugins": [
     "review"
   ]
}

Re:VIEW用原稿のチェック

Re:VIEWサンプル原稿をチェックします。

＞ textlint test.txt
C:○○･･･／test.txt
   1:14  error  文末が"。"で終わっていません。                        preset-ja-technical-writing/ja-no-mixed-period
   7:12  error  文末が"。"で終わっていません。                        preset-ja-technical-writing/ja-no-mixed-period
   9:29  error  文末が"。"で終わっていません。                        preset-ja-technical-writing/ja-no-mixed-period
  10:32  error  文末が"。"で終わっていません。                        preset-ja-technical-writing/ja-no-mixed-period
  16:32  error  文末が"。"で終わっていません。                        preset-ja-technical-writing/ja-no-mixed-period
  18:33  error  文末が"。"で終わっていません。                        preset-ja-technical-writing/ja-no-mixed-period
  19:42  error  文末が"。"で終わっていません。                        preset-ja-technical-writing/ja-no-mixed-period
  23:19  error  文中に逆接の接続助詞 "が" が二回以上使われています。  preset-ja-technical-writing/no-doubled-conjunctive-particle-ga
  25:53  error  同じ接続詞が連続して使われています。                  preset-ja-technical-writing/no-doubled-conjunction

✖ 9 problems (9 errors, 0 warnings)

設定に不備があるのか、Re:VIEWプラグインがうまく動作しません。

ネット検索して情報を収集しましたが、解決方法がわかりません。Re:VIEWの原稿は拡張子が.reなので、ファイル名をtest.txtからtest.reに変更してみました。

textlint 指摘

＞ textlint test.re
C:○○･･･／test.re
  10:32  error  一つの文で"、"を3つ以上使用しています                 preset-ja-technical-writing/max-ten
  23:19  error  文中に逆接の接続助詞 "が" が二回以上使われています。  preset-ja-technical-writing/no-doubled-conjunctive-particle-ga
  25:53  error  同じ接続詞が連続して使われています。                  preset-ja-technical-writing/no-doubled-conjunction

✖ 3 problems (3 errors, 0 warnings)

Re:VIEWの構文を認識して、指摘が表示されました。プラグインは、拡張子により有効になるみたいです。

Re:VIEWの構文を認識しているので、空行が出現するまでを１行として扱っています（10行目の指摘）。

Re:VIEWは、電子書籍向けの簡易なマークアップ言語で、
記述したテキストファイルをEPUBやPDFなどの形式に変換する、
ツールセットです。

まとめ

Windows10にtextlint校正ツールをインストールして、Re:VIEW日本語原稿をチェックできました。日本語技術文書向けルールもインストールして、適切に日本語チェックが行えました。

textlintで使用するルールなどについてもう少し調べてみたいと思います。