textlintでmdxファイルをチェックする方法

textlintでmdxファイル内のテキストをチェックする方法

textlintでのmarkdownチェック処理の際に、 MDX ファイルも一緒にチェックしたいというお話

textlintではデフォルトでMarkdownとplain textをサポートしている。
(他のファイルについてはpluginを導入する必要がある)

このデフォルトで動くMarkdownチェック処理に対して mdx ファイルもチェックするように設定すれば良い。

具体的には、下記の記述を .textlintrc に加えることでMDXファイル内の記述もチェックされるようになる。

  "plugins": {
    "@textlint/markdown": {
      "extensions": [".mdx"]
    }
  }

最初 mdx はサポートされていないのかと思いpluginを自作するところまで行ってしまったが、pluginを自作している最中にドキュメントを色々と読み漁っているところで、下記の記述に出くわして気づいた次第。

(これはもう完全に、ちゃんと調べろ案件ですね。。。プラグイン作成中、他のプラグインのソースコードを読んでいるときに拡張子を追加できるような設計になっていたので、途中から「あーこれはーもしやーmdxを追加すればよいだけでは...？」という思いをひしひしと全身で感じ始めるという体験をしました)

結論: ドキュメントはちゃんと読みましょう。