feat: use locator for improving error location

Author: azu

package.json

@@ -45,20 +45,20 @@
     "trailingComma": "none"
   },
   "devDependencies": {
-    "@textlint/types": "^12.1.1",
-    "@types/node": "^17.0.34",
-    "lint-staged": "^12.4.1",
-    "prettier": "^2.6.2",
-    "textlint-scripts": "^12.1.1",
-    "textlint-tester": "^12.1.1",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.6.4"
+    "@textlint/types": "^13.3.2",
+    "@types/node": "^18.15.10",
+    "lint-staged": "^13.2.0",
+    "prettier": "^2.8.7",
+    "textlint-scripts": "^13.3.2",
+    "textlint-tester": "^13.3.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.2"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@textlint/regexp-string-matcher": "^2.0.1",
-    "textlint-rule-helper": "^2.2.1"
+    "@textlint/regexp-string-matcher": "^2.0.2",
+    "textlint-rule-helper": "^2.3.0"
   }
 }

src/textlint-rule-pattern.ts

@@ -56,7 +56,7 @@ const replace = (text: string, captures: string[]) => {
     });
 };
 const report: TextlintRuleReporter<Options> = (context, options) => {
-    const { Syntax, report, RuleError, fixer, getSource } = context;
+    const { Syntax, report, RuleError, fixer, getSource, locator } = context;
     const patterns = options?.patterns ?? [];
     const helper = new RuleHelper(context);
     const reportIfError = (node: TxtNode) => {
@@ -83,15 +83,15 @@ const report: TextlintRuleReporter<Options> = (context, options) => {
                     report(
                         node,
                         new RuleError(pattern.message, {
-                            index: index,
+                            padding: locator.range([index, index + match.length]),
                             fix: fixer.replaceTextRange([index, index + match.length], replaceText)
                         })
                     );
                 } else {
                     report(
                         node,
                         new RuleError(pattern.message, {
-                            index: index
+                            padding: locator.range([index, index + match.length])
                         })
                     );
                 }

test/textlint-rule-pattern.test.ts

@@ -51,7 +51,7 @@ tester.run("textlint-rule-pattern", rule, {
             errors: [
                 {
                     message: "No todo",
-                    index: 0
+                    range: [0, 5]
                 }
             ]
         },
@@ -109,15 +109,15 @@ Next is Code Block.
             errors: [
                 {
                     message: "Must to use YYYY-MM-DD instead of YYYY/MM/DD",
-                    index: 2
+                    range: [2, 12]
                 },
                 {
                     message: "Must to use YYYY-MM-DD instead of YYYY/MM/DD",
-                    index: 15
+                    range: [15, 25]
                 },
                 {
                     message: "Must to use YYYY-MM-DD instead of YYYY/MM/DD",
-                    index: 28
+                    range: [28, 38]
                 }
             ]
         }