textlintをtypescriptのコメントに適用する。

自然言語に対してlintをかけることができるtextlintというのがあるらしいです。
とりあえずこれをtypescriptのコメントに対して適用できるプラグインを書いてみました。
※ まだやってみた程度なので、どの程度うまく動くかわからないです。tsconfig.jsonも全く参照していません。

ソースはこちら。
https://github.com/ktkn304/textlint-plugin-typescript

使い方

とりあえず作ってみた程度のものなのでnpmには登録していません。
以下のようにgithubから直接インストールしてください。

yarn install https://github.com/ktkn304/textlint-plugin-typescript.git

つぎにtextlintの設定ファイル(.textlintrc)を以下のように書き換えます。
※ ルールはお好みで追加してください。

.textlintrc

{
    "plugins": [
        "typescript"
    ]
}

あとはtextlintを実行すればts, tsxファイルのコメントもチェックしてくれます。

出力例:

$ yarn lint
yarn run v1.22.4
$ textlint src/**

textlint-test/src/sample.ts
  20:11  ✓ error  原則として、全角文字と半角文字の間にスペースを入れません。  ja-spacing/ja-space-between-half-and-full-width

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

error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

参照

textlintについて

• Qiitaやはてブロに投稿するようなユーザーはみんなtextlintを使うと捗るぞ！