Tweak AST traversal to support ESLint 10. Update dev dependencies.

Author: robmisasi

docs/rules/header-format.md

@@ -1,4 +1,6 @@
-# Verifies the content and format of a file's leading comment block (`headers/header-format`)
+# headers/header-format
+
+📝 Verifies the content and format of a file's leading comment block.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 

eslint.config.js eslint.config.mjseslint.config.js renamed to eslint.config.mjs

@@ -1,7 +1,18 @@
-const js = require("@eslint/js");
-const eslintPlugin = require("eslint-plugin-eslint-plugin");
-const nodePlugin = require("eslint-plugin-n");
-const globals = require("globals");
+import js from "@eslint/js";
+import eslintPlugin from "eslint-plugin-eslint-plugin";
+import nodePlugin from "eslint-plugin-n";
+import globals from "globals";
+
+const configConfig = {
+  name: "eslint-config",
+  files: ["eslint.config.mjs"],
+  languageOptions: {
+    globals: {
+      ...globals.node,
+    },
+    sourceType: "module",
+  },
+};
 
 const srcConfig = {
   name: "lib",
@@ -25,10 +36,11 @@ const testConfig = {
   },
 };
 
-module.exports = [
+export default [
   js.configs.recommended,
-  eslintPlugin.configs["flat/recommended"],
+  eslintPlugin.configs.recommended,
   nodePlugin.configs["flat/recommended"],
+  configConfig,
   srcConfig,
   testConfig,
 ];

lib/rules/header-format.js

@@ -54,7 +54,12 @@ function hasHeaderComment(program, context) {
     return vueHasHeaderComment(program);
   }
 
-  const firstComments = context.sourceCode.getCommentsBefore(program);
+  const firstProgramToken = context.sourceCode.getFirstToken(program);
+  if (!firstProgramToken) {
+    return false;
+  }
+
+  const firstComments = context.sourceCode.getCommentsBefore(firstProgramToken);
   if (firstComments.length === 0) {
     return false;
   } else if (
@@ -241,40 +246,56 @@ module.exports = {
       trailingNewlinesMismatch: "Mismatched trailing newlines",
     },
     fixable: "code",
+    defaultOptions: [
+      { style: "jsdoc", preservePragmas: true, enableVueSupport: false },
+    ],
     schema: [
       {
         type: "object",
         properties: {
           source: {
+            description: "The source of the header content.",
             enum: ["file", "string"],
           },
           style: {
+            description:
+              "The style to apply when formatting the header content.",
             enum: ["line", "jsdoc"],
-            default: "jsdoc",
           },
           content: {
+            description: "The header content.",
             type: "string",
           },
           path: {
+            description: "The path to a file containing the header content.",
             type: "string",
           },
           preservePragmas: {
+            description:
+              "The value indicating whether to preserve pragmas/directives in the leading comment.",
             type: "boolean",
-            default: true,
           },
           blockPrefix: {
+            description: "The string prefixed to the header comment block.",
             type: "string",
           },
           blockSuffix: {
+            description: "The string suffixed to the header comment block.",
             type: "string",
           },
           linePrefix: {
+            description:
+              "The string prefixed to each line of the header comment block.",
             type: "string",
           },
           trailingNewlines: {
+            description:
+              "The number of validated newline characters which follow the header comment block.",
             type: "number",
           },
           variables: {
+            description:
+              "A mapping of keys and values interpolated into the header comment block.",
             type: "object",
             patternProperties: {
               "^.+$": {
@@ -284,6 +305,8 @@ module.exports = {
             additionalProperties: false,
           },
           patterns: {
+            description:
+              "A mapping of keys to regular expressions and default values to validate in the header comment block.",
             type: "object",
             patternProperties: {
               "^\\w+$": {
@@ -302,8 +325,9 @@ module.exports = {
             additionalProperties: false,
           },
           enableVueSupport: {
+            description:
+              "A value indicating whether to enable support for linting .vue files.",
             type: "boolean",
-            default: false,
           },
         },
         required: ["source"],
@@ -419,16 +443,16 @@ module.exports = {
     return {
       Program: function (node) {
         if (!hasHeaderComment(node, context)) {
-          const missingHeaderinsertionPoint = getMissingHeaderInsertionNode(
+          const missingHeaderInsertionPoint = getMissingHeaderInsertionNode(
             context,
             node,
           );
           context.report({
-            node: missingHeaderinsertionPoint,
+            node: missingHeaderInsertionPoint,
             messageId: "missingHeader",
             fix: getFixerFn(function (fixer) {
               return fixer.insertTextBefore(
-                missingHeaderinsertionPoint,
+                missingHeaderInsertionPoint,
                 appendNewlines(
                   headerFormatter.format(style),
                   sourceEol,