fix: fix some bugs and improve test cases (#534)

* fix: fix some bugs and improve test cases

* Apply suggestion from @ota-meshi

* update

Author: ota-meshi

.vscode/settings.json

@@ -11,7 +11,8 @@
     "markdown"
   ],
   "eslint.options": {
-    "overrideConfigFile": "./.eslintrc.for-vscode.mjs"
+    // Use a specific ESLint config file for VSCode ESLint extension
+    // "overrideConfigFile": "./.eslintrc.for-vscode.mjs"
   },
   "typescript.validate.enable": true,
   "javascript.validate.enable": false,

package.json

@@ -32,9 +32,9 @@
     "test:debug": "npm run mocha -- \"tests/src/**/*.ts\" --reporter dot",
     "update": "npm run ts -- ./tools/update.ts && npm run eslint-fix && npm run cover",
     "new": "npm run ts -- ./tools/new-rule.ts",
-    "predocs:watch": "npm run build:ts",
+    "predocs:watch": "npm run build",
     "docs:watch": "vitepress dev docs",
-    "docs:build": "npm run build:ts && vitepress build docs",
+    "docs:build": "npm run build && vitepress build docs",
     "preversion": "npm test && git add .",
     "version": "env-cmd -e version -- npm run update && git add .",
     "version:ci": "env-cmd -e version-ci -- npm run update && changeset version",
@@ -69,7 +69,6 @@
     "debug": "^4.3.2",
     "diff-sequences": "^29.0.0",
     "escape-string-regexp": "5.0.0",
-    "eslint-compat-utils": "^0.6.0",
     "natural-compare": "^1.4.0",
     "yaml-eslint-parser": "^1.2.1"
   },

src/configs/flat/base.ts

@@ -1,13 +1,13 @@
 import type { ESLint, Linter } from "eslint";
 import * as parser from "yaml-eslint-parser";
-import * as pluginModule from "../../index.js";
+import plugin from "../../index.js";
 
 export default [
   {
     plugins: {
       get yml(): ESLint.Plugin {
         // Delayed reference to avoid circular dependency
-        return pluginModule.default as unknown as ESLint.Plugin;
+        return plugin;
       },
     },
   },
@@ -23,4 +23,4 @@ export default [
       "spaced-comment": "off",
     },
   },
-] satisfies Linter.FlatConfig[];
+] satisfies Linter.Config[];

src/configs/flat/prettier.ts

@@ -22,4 +22,4 @@ export default [
       "yml/quotes": "off",
     },
   },
-] satisfies Linter.FlatConfig[];
+] satisfies Linter.Config[];

src/configs/flat/recommended.ts

@@ -17,4 +17,4 @@ export default [
       "yml/vue-custom-block/no-parsing-error": "error",
     },
   },
-] satisfies Linter.FlatConfig[];
+] satisfies Linter.Config[];

src/configs/flat/standard.ts

@@ -33,4 +33,4 @@ export default [
       "yml/vue-custom-block/no-parsing-error": "error",
     },
   },
-] satisfies Linter.FlatConfig[];
+] satisfies Linter.Config[];

src/index.ts

@@ -1,6 +1,5 @@
 import type { Linter } from "eslint";
 import type { RuleDefinition } from "@eslint/core";
-import type { RuleModule } from "./types.js";
 import { rules as ruleList } from "./utils/rules.js";
 import base from "./configs/flat/base.js";
 import recommended from "./configs/flat/recommended.js";
@@ -22,12 +21,8 @@ const configs = {
   "flat/prettier": prettier as Linter.Config[],
 };
 
-const rules = ruleList.reduce(
-  (obj, r) => {
-    obj[r.meta.docs.ruleName] = r;
-    return obj;
-  },
-  {} as { [key: string]: RuleModule },
+const rules = Object.fromEntries(
+  ruleList.map((r) => [r.meta.docs.ruleName, r]),
 ) as Record<string, RuleDefinition>;
 
 const languages = {

src/language/token-store.ts

@@ -58,20 +58,42 @@ function getLastIndex(
 /**
  * Normalizes the options for cursor methods.
  */
-function normalizeOptions(options: CursorWithSkipOptions | undefined): {
-  includeComments: boolean;
-  filter: FilterPredicate | null;
+function normalizeSkipOptions(options: CursorWithSkipOptions | undefined): {
+  filter: FilterPredicate;
   skip: number;
 } {
   if (typeof options === "number") {
-    return { includeComments: false, filter: null, skip: options };
+    return { filter: isNotComment, skip: options };
   }
   if (typeof options === "function") {
-    return { includeComments: false, filter: options, skip: 0 };
+    return {
+      filter: (n) => {
+        if (isComment(n)) {
+          return false;
+        }
+        return options(n);
+      },
+      skip: 0,
+    };
+  }
+  let filter: FilterPredicate;
+  if (options?.includeComments) {
+    filter = options?.filter ?? (() => true);
+  } else {
+    if (options?.filter) {
+      const baseFilter = options?.filter;
+      filter = (token) => {
+        if (isComment(token)) {
+          return false;
+        }
+        return baseFilter(token);
+      };
+    } else {
+      filter = isNotComment;
+    }
   }
   return {
-    includeComments: options?.includeComments ?? false,
-    filter: options?.filter ?? null,
+    filter,
     skip: options?.skip ?? 0,
   };
 }
@@ -94,7 +116,7 @@ function isNotComment(token: YAMLToken): boolean {
  * Normalizes the options for cursor methods with count.
  */
 function normalizeCountOptions(options: CursorWithCountOptions | undefined): {
-  filter: FilterPredicate | null;
+  filter: FilterPredicate;
   count: number;
 } {
   if (typeof options === "number") {
@@ -111,11 +133,13 @@ function normalizeCountOptions(options: CursorWithCountOptions | undefined): {
       count: 0,
     };
   }
-  let filter = options?.filter;
-  if (!options?.includeComments) {
-    if (filter) {
-      const baseFilter = filter;
-      filter = (token: YAMLToken) => {
+  let filter: FilterPredicate;
+  if (options?.includeComments) {
+    filter = options?.filter ?? (() => true);
+  } else {
+    if (options?.filter) {
+      const baseFilter = options?.filter;
+      filter = (token) => {
         if (isComment(token)) {
           return false;
         }
@@ -126,7 +150,7 @@ function normalizeCountOptions(options: CursorWithCountOptions | undefined): {
     }
   }
   return {
-    filter: filter ?? null,
+    filter,
     count: options?.count ?? 0,
   };
 }
@@ -165,7 +189,7 @@ export class TokenStore {
     node: YAMLSyntaxElement,
     options?: CursorWithSkipOptions,
   ): YAMLToken | null {
-    const { filter, skip } = normalizeOptions(options);
+    const { filter, skip } = normalizeSkipOptions(options);
     const startIndex = getFirstIndex(
       this.allTokens,
       this.tokenStartToIndex,
@@ -199,7 +223,7 @@ export class TokenStore {
     node: YAMLSyntaxElement,
     options?: CursorWithSkipOptions,
   ): YAMLToken | null {
-    const { filter, skip } = normalizeOptions(options);
+    const { filter, skip } = normalizeSkipOptions(options);
     const startIndex = getFirstIndex(
       this.allTokens,
       this.tokenStartToIndex,
@@ -234,7 +258,7 @@ export class TokenStore {
     right: YAMLSyntaxElement,
     options?: CursorWithSkipOptions,
   ): YAMLToken | null {
-    const { filter, skip } = normalizeOptions(options);
+    const { filter, skip } = normalizeSkipOptions(options);
     const startIndex = getFirstIndex(
       this.allTokens,
       this.tokenStartToIndex,
@@ -268,7 +292,7 @@ export class TokenStore {
     node: YAMLSyntaxElement,
     options?: CursorWithSkipOptions,
   ): YAMLToken | null {
-    const { filter, skip } = normalizeOptions(options);
+    const { filter, skip } = normalizeSkipOptions(options);
     const endIndex = getLastIndex(
       this.allTokens,
       this.tokenStartToIndex,
@@ -297,7 +321,7 @@ export class TokenStore {
     node: YAMLSyntaxElement,
     options?: CursorWithSkipOptions,
   ): YAMLToken | null {
-    const { filter, skip } = normalizeOptions(options);
+    const { filter, skip } = normalizeSkipOptions(options);
     const startIndex = getFirstIndex(
       this.allTokens,
       this.tokenStartToIndex,

src/rules/block-mapping-colon-indicator-newline.ts

@@ -1,7 +1,6 @@
 import type { AST } from "yaml-eslint-parser";
 import { createRule } from "../utils/index.js";
 import { isColon } from "../utils/ast-utils.js";
-import { getSourceCode } from "../utils/compat.js";
 
 export default createRule("block-mapping-colon-indicator-newline", {
   meta: {
@@ -26,7 +25,7 @@ export default createRule("block-mapping-colon-indicator-newline", {
     type: "layout",
   },
   create(context) {
-    const sourceCode = getSourceCode(context);
+    const sourceCode = context.sourceCode;
     if (!sourceCode.parserServices?.isYAML) {
       return {};
     }

src/rules/block-mapping-question-indicator-newline.ts

@@ -1,6 +1,5 @@
 import { createRule } from "../utils/index.js";
 import { isQuestion } from "../utils/ast-utils.js";
-import { getSourceCode } from "../utils/compat.js";
 
 export default createRule("block-mapping-question-indicator-newline", {
   meta: {
@@ -25,7 +24,7 @@ export default createRule("block-mapping-question-indicator-newline", {
     type: "layout",
   },
   create(context) {
-    const sourceCode = getSourceCode(context);
+    const sourceCode = context.sourceCode;
     if (!sourceCode.parserServices?.isYAML) {
       return {};
     }