@textlint-ja/textlint-rule-preset-ai-writing
Version:
textlintプリセット：AIっぽい記述パターンを検出し、より自然な日本語表現を促すルール集
419 lines (315 loc) • 14.2 kB
Markdown
# @textlint-ja/textlint-rule-preset-ai-writing
AIが生成した文章によく見られる記述パターンを検出します。
より自然な日本語表現を促すtextlintルールプリセットです。
## 原則
表現を縛るのではなく、構造を縛ることで、より自然な表現にすることを目的としています。
## Install
Install with [npm](https://www.npmjs.com/package/@textlint-ja/textlint-rule-preset-ai-writing):
npm install @textlint-ja/textlint-rule-preset-ai-writing
## Requirements
- [textlint 15.1.0](https://github.com/textlint/textlint/releases/tag/v15.1.0)以降が必要です
## Usage
Via `.textlintrc`(Recommended)
```json
{
"rules": {
"@textlint-ja/preset-ai-writing": true
}
}
```
### MCPサーバとしての利用
このプリセットは、AIが書いた文章をAIがチェックして改善するワークフローに最適化されています。
textlint v14.8.0以降では、MCPサーバとして利用することで、Claude CodeやVSCode CopilotなどのAIツールと連携できます。
```bash
# MCPサーバとして起動
npx textlint --mcp
```
MCPサーバの詳しい設定方法は [textlint MCP documentation](https://textlint.org/docs/mcp/) を参照してください。
このMCPサーバ機能を使うことで、AIツールとtextlintを組み合わせた次のようなフィードバックループが実現できます。
1. AIツールが文章を生成する
2. 生成した文章をtextlint MCPサーバでチェックする
3. チェック結果をもとにAIツールが改善提案や修正を行う
このようなサイクルを想定したルールセットが含まれています。
## バージョニング方針
このプリセットは次のバージョニングでアップデートします。
- patch（パッチバージョン）: ルールの修正
- エラーメッセージの改善
- 既存ルールの検出精度向上
- バグ修正
- 注意: ルール修正によりエラーが増える場合もありますが、これもpatchとして扱います
- minor（マイナーバージョン）: ルールの追加
- 新しいルールの追加
- 新しいオプションの追加
- major（メジャーバージョン）: ルールの削除
- 既存ルールの削除
- 破壊的変更
ルール修正（patch）でもエラー数は変動する可能性があります。更新時はpackage-lock.jsonやyarn.lockなどのロックファイルの利用を推奨します。
## 含まれるルール
### no-ai-list-formatting
リストアイテムで機械的な印象を与える可能性のある記述パターンを検出します。
#### 検出される例
```markdown
- **重要**: これは重要な項目です
- **注意**: 注意が必要な項目です
- ✅ 完了した項目
- ❌ 失敗した項目
- 💡 アイデア項目
- 🔥 ホットな話題
- 🚀 開始準備完了
- ⭐ 重要項目
- 🎯 目標設定
- 📝 メモ項目
```
#### より自然な表現
```markdown
- 重要な項目: これは重要な項目です
- 注意事項: 注意が必要な項目です
- 完了した項目
- 失敗した項目
- アイデア項目
- 注目の話題
- 開始準備完了
- 重要項目
- 目標設定
- メモ項目
```
#### オプション
- `allows`: 指定したパターンにマッチする場合、エラーを報告しません
- 文字列: `"許可したいテキスト"`
- 正規表現: `"/パターン/フラグ"` (例: `"/重要.*/i"`)
- `disableBoldListItems`: `true`にすると強調リストアイテムの検出を無効にする
- `disableEmojiListItems`: `true`にすると絵文字リストアイテムの検出を無効にする
### no-ai-hype-expressions
AIライティングで過度に使用されがちな誇張表現やハイプ的な表現を検出します。
#### 検出される例
```markdown
革命的な技術で業界を変えます。
これはゲームチェンジャーです。
世界初のソリューションを提供します。
究極のパフォーマンスを実現します。
完全に問題を解決します。
すべての課題を解決します。
最高の品質を保証します。
魔法のように動作します。
奇跡的な結果を生み出します。
可能性を解き放つソリューションです。
AIを民主化するプラットフォームです。
業務をスーパーチャージします。
業界を再定義する革新です。
未来を変える技術です。
パラダイムシフトを起こします。
不可避の変化が起こります。
次世代のソリューションです。
```
#### より自然な表現
```markdown
効果的な技術で業界に変化をもたらします。
これは大きな変化をもたらすでしょう。
新しいソリューションを提供します。
高いパフォーマンスを実現します。
多くの問題を解決します。
主要な課題を解決します。
高い品質を保証します。
スムーズに動作します。
優れた結果を生み出します。
新たな機会を創出するソリューションです。
AIを利用しやすくするプラットフォームです。
業務を効率化します。
業界に新しい視点をもたらす革新です。
将来に影響を与える技術です。
大きな変化を起こします。
重要な変化が起こるでしょう。
新しいソリューションです。
```
#### オプション
- `allows`: 指定したパターンにマッチする場合、エラーを報告しません
- 文字列: `"許可したいテキスト"`
- 正規表現: `"/パターン/フラグ"` (例: `"/革命的な.*/"`)
- `disableAbsolutenessPatterns`: `true`にすると絶対性・完全性を演出する表現の検出を無効にする
- `disableAbstractPatterns`: `true`にすると抽象的・感覚的効果を演出する表現の検出を無効にする
- `disabledPredictivePatterns`: `true`にすると権威的・予言的な表現の検出を無効にする
### no-ai-emphasis-patterns
AIが機械的に生成しがちな強調パターンを検出します。
#### 検出される例
```markdown
これは**非常に**重要な項目です。
**注意**してください。
# **重要なお知らせ**
## **太字**の見出し
```
#### より自然な表現
```markdown
これは重要な項目です。
注意してください。
# 重要なお知らせ
## 太字の見出し
```
#### オプション
- `allows`: 指定したパターンにマッチする場合、エラーを報告しません
- `disableEmojiEmphasisPatterns`: `true`にすると絵文字と太字の組み合わせパターンの検出を無効にする
- `disableInfoPatterns`: `true`にすると情報系プレフィックスパターンの検出を無効にする
- `disableHeadingEmphasisPatterns`: `true`にすると見出し内の太字パターンの検出を無効にする
### no-ai-colon-continuation
コロンの直後にブロック要素が続く英語的なパターンを検出します。日本語として自然な表現を促進するルールです。
このルールは形態素解析（kuromojin）を使用して、コロンの前の文が述語（動詞・形容詞・助動詞）で終わっているかを判定します。「使用方法:」のような名詞で終わる表現は自然な日本語として許可され、「実行します:」のような述語で終わる表現のみを検出します。
#### 検出される例
````markdown
実行します:
```bash
command
```
説明します:
- 項目1
- 項目2
例えば:
- 具体的な例
````
#### より自然な表現
````markdown
実行方法は以下の通りです。
```bash
command
```
説明の内容は以下の通りです。
- 項目1
- 項目2
たとえば、次のような例があります。
- 具体的な例
例:
- 具体的な例
````
#### オプション
- `allows`: 指定したパターンにマッチする場合、エラーを報告しません
- 文字列: `"許可したいテキスト"`
- 正規表現: `"/パターン/フラグ"` (例: `"/使用方法.*/i"`)
- `disableCodeBlock`: `true`にするとコロン後のコードブロック検出を無効にする
- `disableList`: `true`にするとコロン後のリスト検出を無効にする
- `disableQuote`: `true`にするとコロン後の引用検出を無効にする
- `disableTable`: `true`にするとコロン後のテーブル検出を無効にする
### ai-tech-writing-guideline
テクニカルライティングのベストプラクティスに基づいて、文書品質の改善提案を行います。
詳細なガイドラインについては [docs/tech-writing-guidelines.md](./docs/tech-writing-guidelines.md) を参照してください。
#### 検出される内容
- 簡潔性: 冗長表現の排除
```
まず最初に → まず
〜することができます → 〜します
```
- 明確性: 能動態の使用推奨（受動態から能動態への変更提案）
- 具体性: 抽象的表現の具体化（「高速な」→「50ms未満の」など）
- 一貫性: 用語と表現の統一（同一対象への異なる用語使用の検出）
- 構造化: 文の長さと情報整理（長い文の分割提案など）
#### オプション
- `allows`: 指定したパターンにマッチする場合、エラーを報告しません
- `severity`: `"info"`にするとサジェストとして扱う
- `disableRedundancyGuidance`: `true`にすると冗長性の検出を無効にする
- `disableVoiceGuidance`: `true`にすると能動態・受動態の検出を無効にする
- `disableClarityGuidance`: `true`にすると明確性の検出を無効にする
- `disableConsistencyGuidance`: `true`にすると一貫性の検出を無効にする
- `disableStructureGuidance`: `true`にすると構造化の検出を無効にする
- `enableDocumentAnalysis`: `true`にすると文書全体の分析を有効にする
#### 推奨する組み合わせ
このルールは [textlint-rule-preset-ja-technical-writing](https://github.com/textlint-ja/textlint-rule-preset-ja-technical-writing) との組み合わせを推奨します。
```json
{
"rules": {
"preset-ja-technical-writing": true,
"@textlint-ja/preset-ai-writing": {
"ai-tech-writing-guideline": {
"severity": "info"
}
}
}
}
```
この構成では、`ja-technical-writing` で確実な問題を修正し、`ai-tech-writing-guideline` でさらなる改善提案を受け取ることができます。
## Options
各ルールに対して個別にオプションを設定できます。
```json
{
"rules": {
"@textlint-ja/preset-ai-writing": {
"no-ai-list-formatting": {
"allows": ["許可したいテキスト", "/正規表現パターン/i"],
"disableBoldListItems": false,
"disableEmojiListItems": false
},
"no-ai-hype-expressions": {
"allows": ["許可したいテキスト", "/正規表現パターン/"],
"disableAbsolutenessPatterns": false,
"disableAbstractPatterns": false,
"disabledPredictivePatterns": false
},
"no-ai-emphasis-patterns": {
"allows": ["許可したいテキスト", "/正規表現パターン/"],
"disableEmojiEmphasisPatterns": false,
"disableInfoPatterns": false,
"disableHeadingEmphasisPatterns": false
},
"no-ai-colon-continuation": {
"allows": ["許可したいテキスト", "/正規表現パターン/"],
"disableCodeBlock": false,
"disableList": false,
"disableQuote": false,
"disableTable": false
},
"ai-tech-writing-guideline": {
"severity": "info", // サジェストとして扱う
"allows": ["許可したいテキスト", "/正規表現パターン/"],
"disableRedundancyGuidance": false,
"disableVoiceGuidance": false,
"disableClarityGuidance": false,
"disableConsistencyGuidance": false,
"disableStructureGuidance": false,
"enableDocumentAnalysis": true
}
}
}
}
```
### 正規表現パターンの使用例
`allows`オプションでは、[regexp-string-matcher](https://github.com/textlint/regexp-string-matcher)の形式で正規表現パターンを指定できます。
#### 基本的な使い方
```json
{
"allows": [
"特定の文字列", // 完全一致
"/パターン/", // 正規表現（基本）
"/パターン/i", // 大文字小文字を無視
"/パターン/m" // 複数行マッチ
]
}
```
#### 実用例
```json
{
"allows": [
"/重要.*/", // 「重要」で始まる任意の文字列
"/\\*\\*注意\\*\\*/", // **注意** (特殊文字をエスケープ)
"/TODO.*/i", // TODO で始まる文字列（大文字小文字無視）
"/\\d{4}-\\d{2}-\\d{2}/" // 日付形式 (YYYY-MM-DD)
]
}
```
Via CLI
```
textlint --rule @textlint-ja/no-ai-writing README.md
```
## Changelog
See [Releases page](https://github.com/textlint-ja/textlint-rule-no-ai-writing/releases).
## Running tests
Install devDependencies and Run `npm test`:
npm i -d && npm test
## Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, [please create an issue](https://github.com/textlint-ja/textlint-rule-no-ai-writing/issues).
1. Fork it
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Author
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu