この記事は、Qiita株式会社のカレンダー | Advent Calendar 2023 - Qiitaの13日目の記事です。
はじめに
textlintについて、皆さんはご存知ですか?
実はQiitaのエディタ機能(ベータ版)でも、使用されています!
今回は、textlintのおすすめのルールとQiitaで使用されているものも
一部公開していこうと思います!
textlintとは?
以下公式より
textlint is an open source text linting utility written in JavaScript. It is hard to lint natural language texts, but we try to resolve this issue by pluggable approach.
簡単に説明します。
textlint(テキストリント)とは、Javascriptで書かれたOSSのことで校正ルールにもとづいて文章校正を行うことができるライブラリです。
また、ルールを自作したり既に 公開されているルール と組み合わることによって
独自のルールセットを作成することができます!
導入方法
今回は設定ファイルを用いた方法を説明します。
1.プロジェクトのディレクトリでnpm の初期化処理を行います。
npm init --yes
2.初期が完了した後に、textlintのインストールを行います。
npm install textlint
3.使用するルールのインストール
今回は、同じ助詞が連続して出てくるのか確認するルールを追加します!
npm install textlint-rule-no-doubled-joshi
4.extlintの設定ファイルの作成
.textlintrcという名前の設定ファイルを作成します。
npx textlint --init
上記のコマンドか直接作成してください。
そして以下のようにルールを追記します。
{
"rules": {
"no-doubled-joshi": true,
}
}
5.textlintを実行する
npx textlint [ファイルやパス]
これで、指定したルールに基づいて文章チェックを行うことができます！
Qiitaのエディタで使用されているルール
Qiitaのエディタで使用されているルールについて、
一部紹介します！
textlint-rule-no-doubled-joshi
1つの文中に同じ助詞が連続して出てくるかの確認してくれるルールです。
文中で同じ助詞が連続していると、読み難くなりますがそれをチェックしてくれます!
textlint-rule-aws-service-name
AWSのサービス名を確認してくれるルールです!
以下のように表記揺れをチェックしてくれます！
直近でルールを追加したので、何が追加されたか気になる人はこちらを見てください！
おすすめtextlintルール3選!
textlint-rule-ja-unnatural-alphabet
不自然なアルファベットを検知してくれるルールです！
IMEの入力ミスによるtypoを見つけくれます。
OK
リリース
aiueo
NG
リイr−ス
対応でｋない
textlint-rule-ja-no-redundant-expression
冗長な表現を禁止するルールです！
「であると考えている→である」のように無い方が良い、無くても良いものを
省き文章をわかりやすくしてくれます！
OK
である
できる
NG
であると考えている
することができる
textlint-ja/textlint-rule-preset-ja-technical-writing
技術文書向けのtextlintルールプリセットになります。
これは、単一のルールではありませんが複数のルールを組み合わせたもの(プリセット)になります。
エディタ上で固めの技術書を書く方にはおすすめです!
おわりに
今回はtextlintの導入手順、Qiitaで使用されているルール、自分的なおすすめを紹介していきました！
textlintは開発する際のルールもそうですしQiitaのエディタにように
ユーザーに提供する機能にも活用することができます！
また、提供されているルールに要件を満たすものがなければルールの自作も行うことができます。
今回の記事が参考になれば幸いです。
参考資料