emacs の flycheck で textlint を利用し、日本語の自動校正を行う

• Windows 7/10 pro
• nodejs 10.5.0
• textlint 10.2.1
• emacs 25.2.1/26.1

textlint は npm で提供されているため、nodejs をインストールする。 ここでは textlint だけのために nodejs をインストールするため、インストーラーは使用しない。 すでにインストール済みの場合、この作業は不要である。

1. nodejsの公式 より、[other download] を選択
2. [Windows Binary (.zip)] より、[64bit] を選択
3. [node-v10.5.0-win-x64.zip] を適当な場所(例えば %HOME%\app\node-v10.5.0-win-x64)に展開¹

4. (オプション) 以下の手順で Proxy を設定する

   PS > cd $Env:HOME\app\node-v10.5.0-win-x64
   PS > .\npm config set proxy http://proxy.example.com:8080
   PS > .\npm config set https-proxy https://proxy.example.com:8080
   

1. textlint をインストール (ちょっと時間かかる)

   PS > .\npm install -g textlint
   

2. ルールプリセットのインストール (ちょっと時間かかる)^{3, 4}

   PS > .\npm install -g textlint textlint-rule-preset-japanese textlint-rule-preset-jtf-style
   

3. 設定ファイルを作成

   PS > cd $Env:HOME
   PS > .\app\node-v10.5.0-win-x64\textlint --init
   

4. 作成された設定ファイル [~/.textlintrc] を開き、以下のように編集

   {
       "rules": {
           "preset-japanese": true,
           "preset-jtf-style": true    
       }
   }
   

5. テスト用の test.md を utf-8 で以下のように作成^{5, 6}

   我輩は猫である。
   この文章を校正してください、お願いします, ダメ?、そこをなんとか、して欲しいところです
   

6. テストを実行

   PS > .\app\node-v10.5.0-win-x64\textlint --version
   v10.2.1
   PS > .\app\node-v10.5.0-win-x64\textlint test.md
   
   HOME\test.md
   1:5   error    本文: "である"調 と "ですます"調 が混在 => "である。" がである調
         Total:
         である  : 1
         ですます: 1                                                                                                   preset-japanese/no-mix-dearu-desumasu
   2:21  ✓ error  句読点には全角の「、」と「。」を使います。和文の句読点としてピリオド(.)とカンマ(,)を使用しません。  preset-jtf-style/1.2.1.句点(。)と読点(、)
   2:25  ✓ error  疑問符(？)を使用する場合は「全角」で表記します。                                                    preset-jtf-style/4.2.2.疑問符(？)
   
   ✖ 3 problems (3 errors, 0 warnings)
   ✓ 2 fixable problems.
   Try to run: $ textlint --fix [file]
   

init.el を以下のように設定する。

;; add PATH
(setenv "PATH"
  (concat
   "~/app/node-v10.5.0-win-x64;"

   (getenv "PATH")))
(setq exec-path (parse-colon-path (getenv "PATH")))

;; flycheck for textlint
(require 'flycheck)
(flycheck-define-checker textlint
  "A linter for prose."
  :command ("textlint" "--format" "unix" source-inplace)
 :error-patterns
  ((warning line-start (file-name) ":" line ":" column ": "
        (id (one-or-more (not (any " "))))
        (message (one-or-more not-newline)
         (zero-or-more "\n" (any " ") (one-or-more not-newline)))
        line-end))
  :modes (text-mode markdown-mode))

(add-to-list 'flycheck-checkers 'textlint)
(add-hook 'markdown-mode-hook 'flycheck-mode)

• debian 9.4
• nodejs 10.5.0
• textlint 10.2.1
• emacs 25.1.1

textlint は npm で提供されているため、nodejs をインストールする。 Debian Stretch で提供されている nodejs ではバージョンが古く、npm も提供されないため、公式サイトからダウンロードしてくる必要がある。 ここでは textlint だけのために nodejs をインストールするため、パッケージは使用しない⁷。 すでにインストール済みの場合、この作業は不要である。

1. nodejsの公式 より、[other download] を選択
2. [Linux Binaries (x64)] より、[64bit] を選択
3. [node-v10.5.0-linux-x64.tar.xz] を適当な場所(例えば ~\app\node-v10.5.0-linux-x64)に展開¹

4. (オプション) 以下の手順で Proxy を設定する

   $ cd ~/app/node-v10.5.0-linux-x64/bin
   $ ./node npm config set proxy http://proxy.example.com:8080
   $ ./node npm config set https-proxy https://proxy.example.com:8080
   

1. textlint をインストール (ちょっと時間かかる)

   $ ./node npm install -g textlint
   

2. ルールプリセットのインストール (ちょっと時間かかる³)

   $ ./node npm install -g textlint-rule-preset-japanese textlint-rule-preset-jtf-style
   

3. 設定ファイルを作成

   $ cd ~
   $ ./app/node-v10.5.0-linux-x64/bin/node ./app/node-v10.5.0-linux-x64/bin/textlint --init
   

4. 作成された設定ファイル [~/.textlintrc] を開き、以下のように編集

   {
       "rules": {
           "preset-japanese": true,
           "preset-jtf-style": true    
       }
   }
   

5. テスト用の test.md を utf-8 で以下のように作成^{5, 6}

   我輩は猫である。
   この文章を校正してください、お願いします, ダメ?、そこをなんとか、して欲しいところです
   

6. テストを実行

     $ ./app/node-v10.5.0-linux-x64/bin/node ./app/node-v10.5.0-linux-x64/bin/textlint --version
     v10.2.1
     $ ./app/node-v10.5.0-linux-x64/bin/node ./app/node-v10.5.0-linux-x64/bin/textlint test.md
   
     /home/clothoid/test.md
     1:5   error    本文を敬体(ですます調)に統一して下さい。
            本文の文体は、敬体(ですます調)あるいは常体(である調)のどちらかで統一します。
            "である。"が常体(である調)です。                                               preset-jtf-style/1.1.1.本文
     1:5   error    本文: "である"調 と "ですます"調 が混在 => "である。" がである調
   
       Total:
       である  : 1
       ですます: 1                                                                             preset-japanese/no-mix-dearu-desumasu
   2:21  ✓ error  全角のピリオドとカンマは使用しません。                                      preset-jtf-style/1.2.2.ピリオド(.)とカンマ(,)
   2:24  ✓ error  疑問符(？)を使用する場合は「全角」で表記します。                            preset-jtf-style/4.2.2.疑問符(？)
   
     ✖ 4 problems (4 errors, 0 warnings)
     ✓ 2 fixable problems.
     Try to run: $ textlint --fix [file]
   

7. PATH の追加

   $ export PATH=$PATH:~/app/node-v10.5.0-linux-x64/bin/
   

init.el を以下のように設定する。

;; flycheck for textlint
(require 'flycheck)
(flycheck-define-checker
 textlint
 "A linter for prose."
 :command ("textlint" "--format" "unix" source-inplace)
 :error-patterns
 ((warning line-start (file-name) ":" line ":" column ": "
           (id (one-or-more (not (any " "))))
           (message (one-or-more not-newline)
                    (zero-or-more "\n" (any " ") (one-or-more not-newline)))
           line-end))
 :modes (text-mode markdown-mode))

(add-to-list 'flycheck-checkers 'textlint)
(add-hook 'markdown-mode-hook 'flycheck-mode)