マニュアルなどの文書チェックツール
RedPenをWindows10のコマンドラインから使う方法について記載する。Windows環境で動かそうとしたら2, 3引っかかったので、その解消方法メモ。あと、オマケとしてサクラエディタで編集中のファイルをチェックする方法も。
利用環境は次のとおり。
- RedPen 1.4.0
- Windows 10
- Java 1.8.0 update 45
1. インストール
Java 1.8.0以降をインストールしておく。環境変数JAVA_HOMEも設定しておくこと。
リリースページから、redpen-1.4.0.tar.gzをダウンロードして、任意のフォルダに展開する。以降、展開したフォルダをINSTALL_DIRと表記する。
2. 微調整
そのまま実行すると次の2つの問題があるので、微調整する。
- チェックメッセージが文字化けしている。
- カレントディレクトリにjsフォルダが作成される。
文字化けを解消するには、INSTALL_DIR\bin\redpen.batの12行目に
-Dfile.encoding=UTF-8
を追加する。これでチェックメッセージの文字化けが解消する (コマンドプロンプト上だと、代わりに実行ログが文字化けしてしまうけれど許容している)(完全には解決できなかったのが気持ち悪いけれど
Issueを出してみた)。
set JAVA_OPTS=%JAVA_OPTS% -Dfile.encoding=UTF-8
jsフォルダの作成を抑止するには、設定ファイルINSTALL_DIR\conf\redpen-conf-ja.xmlの
<validator name="JavaScript" />
を次のように書き換える。JavaScriptで実装されたチェックルールを使う予定がないなら、代わりに消しても良い。
<validator name="JavaScript">
<property name="script-path" value="INSTALL_DIR\js" />
</validator>
メモ:
Writing RedPen extension with JavaScript | RedPen BLOGや
RedPenのValidatorをJavaScript で書くには - ククログ(2015-08-29)を読むと、プロパティscript-pathが優先で、未指定なら環境変数REDPEN_HOME\jsを参照しそうなものだけれど、未指定だとカレントディレクトリ\jsを参照しようとして存在しないときは作成してしまうみたい (
このコミットを見ると、次のヴァージョンではログが出るだけになりそう)。詳しい原因は不明。環境変数REDPEN_HOMEはredpen.bat内で設定されているから、設定漏れではなさそう。redpen.batに
echo %REDPEN_HOME%
を追記してみたら、ちゃんとINSTALL_DIRが表示されるているし (ForkしてUnit Testを書いてみたけれどNGだったので、
Issueを出してみた)。
3. 実行確認
任意のディレクトリ (微調整の確認のため、最初はINSTALL_DIR以外がよい) でコマンドプロンプトを実行し、次のコマンドを実行する。
INSTALL_DIR\bin\redpen -c INSTALL_DIR\conf\redpen-conf-ja.xml INSTALL_DIR\sample-doc\ja\sampledoc-ja.txt
下記のような実行結果が表示されるはず。
(前略)
[2015-10-17 20:15:52.673][INFO ] cc.redpen.validator.JavaScriptValidator - JavaScript validators directory: INSTALL_DIR\js
sampledoc-ja.txt:1: ValidationError[SentenceLength], 文長("101")が最大値 "100" を超えています。 at line: 最近利用されているソフトウェアの中には複数の計算機上で動作 (分散)するものが多く存在し、このような分散ソフトウェアは複数の計算機で動作することで大量のデータを扱えたり,高負荷な状況に対処できたりします。
(以下略)
(オマケ) サクラエディタで編集中のファイルのチェック
[ツール] > [外部コマンドを実行]で、下記の通り設定して[実行]ボタンを押すと、編集中のファイルをチェックできる。一度実行すれば、Ctrl+F, Enterでチェックできて便利。
名前: "INSTALL_DIR\bin\redpen.bat" -c "INSTALL_DIR\conf\redpen-conf-ja.xml" "$F"
標準出力を得る: チェックボックスをオンにして"UTF-8"を選ぶ。
標準出力リダイレクト先: アウトプットウィンドウ
ちなみに、アウトプットウィンドウ上だと実行ログもチェックメッセージも文字化けしない。