fix: StringSourceを使用してコードブロックを除外し、エラー件数の一致を改善

- textlint-util-to-stringのStringSourceを使用してコードブロック(Code, InlineCode)を除外
- analyzeDocumentQuality関数を修正して全体とカテゴリのエラー件数を一致させる
- originalIndexFromIndexを使用して正確な位置マッピングを実装
- README.mdの例文がコードブロック内で正しく除外されることを確認

Author: azu

.textlintrc

@@ -0,0 +1,9 @@
+{
+  "rules": {
+    "preset-ai-writing": {
+      "ai-tech-writing-guideline": {
+        "severity": "info"
+      }
+    }
+  }
+}

README.md

@@ -40,8 +40,17 @@ AIが機械的に生成しがちな強調パターンを検出します。
 テクニカルライティングのベストプラクティスに基づいて、文書品質の改善提案を行います。
 詳細なガイドラインについては [docs/tech-writing-guidelines.md](./docs/tech-writing-guidelines.md) を参照してください。
 
+#### 推奨する組み合わせ
+このルールは [textlint-rule-preset-ja-technical-writing](https://github.com/textlint-ja/textlint-rule-preset-ja-technical-writing) との組み合わせを推奨します。
+`ja-technical-writing` はfalse positiveが少ない確実なルールセットで、基本的な日本語技術文書の品質を担保します。
+本ルール（`ai-tech-writing-guideline`）は、より高度な文書品質向上のためのサジェストとして使用することを想定しています。
+
 #### 検出される内容
-- 簡潔性: 冗長表現の排除（「まず」→「まず」など）
+- 簡潔性: 冗長表現の排除
+  ```
+  まず最初に → まず
+  〜することができます → 〜します
+  ```
 - 明確性: 能動態の使用推奨（受動態から能動態への変更提案）
 - 具体性: 抽象的表現の具体化（「高速な」→「50ms未満の」など）
 - 一貫性: 用語と表現の統一（同一対象への異なる用語使用の検出）
@@ -190,6 +199,25 @@ Via `.textlintrc`(Recommended)
 }
 ```
 
+### 推奨構成: ja-technical-writing との組み合わせ
+
+基本的な日本語技術文書の品質担保と、より高度な文書品質向上の組み合わせ:
+
+```json
+{
+    "rules": {
+        "preset-ja-technical-writing": true,
+        "preset-ai-writing": {
+            "ai-tech-writing-guideline": {
+                "severity": "info"
+            }
+        }
+    }
+}
+```
+
+この構成では、`ja-technical-writing` で確実な問題を修正し、`ai-tech-writing-guideline` でさらなる改善提案を受け取ることができます。
+
 ## Options
 
 各ルールに対して個別にオプションを設定できます。

package-lock.json

@@ -68,7 +68,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@textlint/regexp-string-matcher": "^2.0.2"
+    "@textlint/regexp-string-matcher": "^2.0.2",
+    "textlint-util-to-string": "^3.3.4"
   },
   "packageManager": "[email protected]+sha512.8ab88f10f224a0c614cb717a7f7c30499014f77134120e9c1f0211ea3cf3397592cbe483feb38e0c4b3be1c54e347292c76a1b5edb94a3289d5448484ab8ac81"
 }

package.json

@@ -1,5 +1,6 @@
 import type { TextlintRuleModule } from "@textlint/types";
 import { matchPatterns } from "@textlint/regexp-string-matcher";
+import { StringSource } from "textlint-util-to-string";
 
 /**
  * テクニカルライティングガイドラインに基づく文書品質改善ルール
@@ -23,7 +24,7 @@ export interface Options {
 }
 
 const rule: TextlintRuleModule<Options> = (context, options = {}) => {
-    const { Syntax, report, getSource, locator } = context;
+    const { Syntax, report, locator } = context;
     const allows = options.allows ?? [];
     const disableRedundancyGuidance = options.disableRedundancyGuidance ?? false;
     const disableVoiceGuidance = options.disableVoiceGuidance ?? false;
@@ -188,8 +189,8 @@ const rule: TextlintRuleModule<Options> = (context, options = {}) => {
         [Syntax.Document](node) {
             // 文書全体の分析を実行（enableDocumentAnalysisがtrueの場合）
             if (enableDocumentAnalysis) {
-                const documentText = getSource(node);
-                const totalIssues = analyzeDocumentQuality(documentText);
+                const source = new StringSource(node);
+                const totalIssues = analyzeDocumentQuality(source.toString());
 
                 if (totalIssues > 0) {
                     report(node, {
@@ -199,7 +200,8 @@ const rule: TextlintRuleModule<Options> = (context, options = {}) => {
             }
         },
         [Syntax.Paragraph](node) {
-            const text = getSource(node);
+            const source = new StringSource(node);
+            const text = source.toString();
 
             // 許可パターンのチェック
             if (allows.length > 0) {
@@ -222,15 +224,19 @@ const rule: TextlintRuleModule<Options> = (context, options = {}) => {
                 const matches = text.matchAll(pattern);
                 for (const match of matches) {
                     const index = match.index ?? 0;
-                    const matchRange = [index, index + match[0].length] as const;
+                    const originalPosition = source.originalIndexFromIndex(index);
+                    const originalEndPosition = source.originalIndexFromIndex(index + match[0].length);
 
                     // カテゴリ別のメトリクスを更新
                     documentQualityMetrics[category as keyof typeof documentQualityMetrics]++;
 
-                    report(node, {
-                        message: message,
-                        padding: locator.range(matchRange)
-                    });
+                    if (originalPosition !== undefined && originalEndPosition !== undefined) {
+                        const matchRange = [originalPosition, originalEndPosition] as const;
+                        report(node, {
+                            message: message,
+                            padding: locator.range(matchRange)
+                        });
+                    }
                 }
             }
         }
@@ -239,15 +245,17 @@ const rule: TextlintRuleModule<Options> = (context, options = {}) => {
     // 文書全体の品質分析関数
     function analyzeDocumentQuality(text: string): number {
         let totalIssues = 0;
-        const allPatterns = [
-            ...redundancyGuidance,
-            ...voiceGuidance,
-            ...clarityGuidance,
-            ...consistencyGuidance,
-            ...structureGuidance
+
+        // コードブロックを除外して分析するためのパターンリスト
+        const guidancePatterns = [
+            ...(disableRedundancyGuidance ? [] : redundancyGuidance),
+            ...(disableVoiceGuidance ? [] : voiceGuidance),
+            ...(disableClarityGuidance ? [] : clarityGuidance),
+            ...(disableConsistencyGuidance ? [] : consistencyGuidance),
+            ...(disableStructureGuidance ? [] : structureGuidance)
         ];
 
-        for (const { pattern } of allPatterns) {
+        for (const { pattern } of guidancePatterns) {
             const matches = text.matchAll(pattern);
             totalIssues += Array.from(matches).length;
         }