@tony.ganchev/eslint-plugin-header 3.2.5 → 3.3.0

package/lib/rules/header.schema.js

@@ -142,6 +142,28 @@ const schema = Object.freeze({
             required: ["commentType", "lines"],
             additionalProperties: false
         },
+        header: {
+            anyOf: [
+                { $ref: "#/definitions/fileBasedHeader" },
+                { $ref: "#/definitions/inlineHeader" }
+            ],
+            description: "Header comment matching rules."
+        },
+        leadingComments: {
+            type: "object",
+            properties: {
+                comments: {
+                    type: "array",
+                    items: { $ref: "#/definitions/header" },
+                    description: "The set of comment matching rules. The rule can match one or more comments against " +
+                        "these rules."
+                }
+            },
+            required: ["comments"],
+            additionalProperties: false,
+            description: "Set of comments that can appear before the header comment. Useful for pragmas used by some " +
+                "tools that expect these to be the first comment in the file."
+        },
         trailingEmptyLines: {
             type: "object",
             properties: {
@@ -156,12 +178,8 @@ const schema = Object.freeze({
         newOptions: {
             type: "object",
             properties: {
-                header: {
-                    anyOf: [
-                        { $ref: "#/definitions/fileBasedHeader" },
-                        { $ref: "#/definitions/inlineHeader" }
-                    ]
-                },
+                header: { $ref: "#/definitions/header" },
+                leadingComments: { $ref: "#/definitions/leadingComments" },
                 lineEndings: { $ref: "#/definitions/lineEndings" },
                 trailingEmptyLines: { $ref: "#/definitions/trailingEmptyLines" }
             },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tony.ganchev/eslint-plugin-header",
-  "version": "3.2.5",
+  "version": "3.3.0",
   "description": "The native ESLint 9/10 header plugin. A zero-bloat, drop-in replacement for 'eslint-plugin-header' with first-class Flat Config & TypeScript support. Auto-fix Copyright, License, and banner comments in JavaScrip and TypeScript files.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -18,19 +18,20 @@
     "CONTRIBUTING.md"
   ],
   "devDependencies": {
+    "@eslint/core": "^1.1.1",
     "@eslint/js": "^10.0.1",
     "@eslint/markdown": "^7.5.1",
-    "@stylistic/eslint-plugin": "^5.9.0",
+    "@stylistic/eslint-plugin": "^5.10.0",
     "@types/estree": "^1.0.8",
     "@types/json-schema": "^7.0.15",
-    "@types/node": "^25.3.0",
-    "c8": "^10.1.3",
-    "eslint": "^10.0.2",
-    "eslint-plugin-eslint-plugin": "^7.3.1",
+    "@types/node": "^25.3.5",
+    "c8": "^11.0.0",
+    "eslint": "^10.0.3",
+    "eslint-plugin-eslint-plugin": "^7.3.2",
     "eslint-plugin-jsdoc": "^62.7.1",
     "eslint-plugin-n": "^17.24.0",
-    "globals": "^17.3.0",
-    "markdownlint-cli": "^0.47.0",
+    "globals": "^17.4.0",
+    "markdownlint-cli": "^0.48.0",
     "mocha": "12.0.0-beta-9",
     "testdouble": "^3.20.2",
     "typescript": "^5.9.3",

package/types/lib/rules/header.d.ts

@@ -85,6 +85,18 @@ export type InlineConfig = {
      */
     lines: HeaderLine[];
 };
+/**
+ * A set of comments that can appear before
+ * the header.
+ */
+export type LeadingComments = {
+    /**
+     * The set of comments
+     * that are allowed. If none of the matching rules matches the first comment the
+     * rule assumes the first comment *is* the header.
+     */
+    comments: (FileBasedConfig | InlineConfig)[];
+};
 /**
  * Rule configuration on the handling of
  * empty lines after the header comment.
@@ -102,6 +114,12 @@ export type HeaderOptionsWithoutSettings = {
      * for the header.
      */
     header: FileBasedConfig | InlineConfig;
+    /**
+     * The set of allowed comments to
+     * precede the header. Useful to allow position-sensitive pragma comments for
+     * certain tools.
+     */
+    leadingComments?: LeadingComments | undefined;
     /**
      * Rules about empty lines
      * after the header comment.

package/types/lib/rules/header.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../../lib/rules/header.js"],"names":[],"mappings":";2BAqCa,iBAAiB;0BACjB,gBAAgB;wBAChB,cAAc;0BACd,gBAAgB;;;;;yBAIhB,IAAI,GAAG,MAAM;;;;;;;;;;aAOZ,MAAM,GAAG,MAAM;;;;;;;;;;;;yBAOhB,MAAM,GAAG,MAAM,GAAG,iBAAiB;;;;;0BAGnC,UAAU,GAAG,UAAU,EAAE;;;;;;+BAEzB,IAAI,GAAG,MAAM,GAAG,SAAS;;;;;6BAGzB;IAAE,WAAW,CAAC,EAAE,gBAAgB,CAAA;CAAE;;;;;0BAElC,OAAO,GAAG,MAAM;;;;;;;;;;UAOf,MAAM;;;;;;;;;;;;;;;iBASN,WAAW;;;;;;WACX,UAAU,EAAE;;;;;;;;;;;;;;;;;;YAcZ,eAAe,GAAG,YAAY;;;;;;;;;;;4BAO/B,4BAA4B,GAAG,cAAc;oCAK7C,CAAC,QAAQ,EAAE,MAAM,CAAC;4CAClB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC;iCAE5C,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC;yCACvC,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,CAAC;yCAEjE,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,CAAC;iDAEzD,CACV,IAAI,EAAE,WAAW,EACjB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,cAAc,CACvB;;;;+BACS,CAAC,aAAa,CAAC,GACvB,qBAAqB,GACrB,6BAA6B,GAC7B,kBAAkB,GAClB,0BAA0B,GAC1B,0BAA0B,GAC1B,kCAAkC;;;;;+BAK1B,iBAAiB,gBAAgB,CAAC;AAqb/C,8BAA8B;AAC9B,0BADW,eAAe,CAufxB;0BAjhC+B,QAAQ;4BAAR,QAAQ"}
+{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../../lib/rules/header.js"],"names":[],"mappings":";2BAsCa,iBAAiB;0BACjB,gBAAgB;wBAChB,cAAc;0BACd,gBAAgB;;;;;yBAIhB,IAAI,GAAG,MAAM;;;;;;;;;;aAOZ,MAAM,GAAG,MAAM;;;;;;;;;;;;yBAOhB,MAAM,GAAG,MAAM,GAAG,iBAAiB;;;;;0BAGnC,UAAU,GAAG,UAAU,EAAE;;;;;;+BAEzB,IAAI,GAAG,MAAM,GAAG,SAAS;;;;;6BAGzB;IAAE,WAAW,CAAC,EAAE,gBAAgB,CAAA;CAAE;;;;;0BAElC,OAAO,GAAG,MAAM;;;;;;;;;;UAOf,MAAM;;;;;;;;;;;;;;;iBASN,WAAW;;;;;;WACX,UAAU,EAAE;;;;;;;;;;;;cAQZ,CAAC,eAAe,GAAG,YAAY,CAAC,EAAE;;;;;;;;;;;;;;;;;;YAclC,eAAe,GAAG,YAAY;;;;;;;;;;;;;;;;;4BAU/B,4BAA4B,GAAG,cAAc;oCAK7C,CAAC,QAAQ,EAAE,MAAM,CAAC;4CAClB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC;iCAE5C,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC;yCACvC,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,CAAC;yCAEjE,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,CAAC;iDAEzD,CACV,IAAI,EAAE,WAAW,EACjB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,cAAc,CACvB;;;;+BACS,CAAC,aAAa,CAAC,GACvB,qBAAqB,GACrB,6BAA6B,GAC7B,kBAAkB,GAClB,0BAA0B,GAC1B,0BAA0B,GAC1B,kCAAkC;;;;;+BAK1B,iBAAiB,gBAAgB,CAAC;AAsuB/C,8BAA8B;AAC9B,0BADW,eAAe,CAyLxB;0BAhhC4D,QAAQ;4BAAR,QAAQ"}

package/types/lib/rules/header.schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"header.schema.d.ts","sourceRoot":"","sources":["../../../lib/rules/header.schema.js"],"names":[],"mappings":"gCA4BU,MAAM;AADhB;;GAEG;AACH;;;;GAIG;iCAGO,MAAM;AADhB;;GAEG;AACH;;;GAGG;AAEH,gDAAgD;AAChD,qBADW,OAAO,aAAa,EAAE,WAAW,CAwKzC"}
+{"version":3,"file":"header.schema.d.ts","sourceRoot":"","sources":["../../../lib/rules/header.schema.js"],"names":[],"mappings":"gCA4BU,MAAM;AADhB;;GAEG;AACH;;;;GAIG;iCAGO,MAAM;AADhB;;GAEG;AACH;;;GAGG;AAEH,gDAAgD;AAChD,qBADW,OAAO,aAAa,EAAE,WAAW,CA0LzC"}