QiitaMarkdowntextlintQiitaCLI

Qiita の記事を Qiita CLI で管理できるようになったので 導入した textlint rule

はじめに

Qiita の記事を GitHub 等レポジトリで管理出来る Qiita CLI が β リリースされています。 Qiita の記事が GitHub 等で管理出来るようになったので導入したいと考えていた textlint を導入しました。 その 導入した textlint の rule をこの記事にまとめました。

導入した textlint rule

:::note warn 導入途中の textlint-rule も記載しています。 :::

textlint-rule/textlint-rule-no-todo

  • todo を禁止する rule です

textlint-ja/textlint-rule-no-synonyms

  • 同義語を表記ゆれをチェックする rule です
    • 私は表記揺れが若干多いタイプなので導入しています

textlint/textlint-filter-rule-comments

  • textlint の rule を一部で無視する設定のために利用します

bun913/textlint-rule-aws-service-name

  • AWS Service 名を check する task です

textlint-ja/textlint-rule-no-mixed-zenkaku-and-hankaku-alphabet

  • 全角と半角アルファベットの混在をチェックする rule です

textlint-rule/textlint-rule-period-in-list-item

  • list−item の末尾の取り扱いにいて調整するための rule です

textlint-ja/textlint-rule-preset-ja-spacing

  • スペース周りのスタイルを統一する rule です

textlint-ja/textlint-rule-preset-ja-technical-writing

  • 技術文書向けの textlint rule です

References