@tony.ganchev/eslint-plugin-header 3.2.4 → 3.2.6

package/lib/rules/header.schema.js

@@ -1,8 +1,8 @@
-/*
- * MIT License
- *
- * Copyright (c) 2025-present Tony Ganchev and contributors
- *
+/**
+ * @file Schema definition for `header` rule.
+ * @copyright Copyright (c) 2015-present Stuart Knightley and contributors
+ * @copyright Copyright (c) 2025-2026 Tony Ganchev
+ * @license MIT
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the “Software”), to deal
  * in the Software without restriction, including without limitation the rights
@@ -22,6 +22,7 @@
  * SOFTWARE.
  */
 
+
 "use strict";
 
 /**
@@ -41,7 +42,7 @@ const commentTypeOptions = Object.freeze({
     line: "line"
 });
 
-/** @type {import('json-schema').JSONSchema4} */
+/** @type {import("json-schema").JSONSchema4} */
 const schema = Object.freeze({
     $ref: "#/definitions/options",
     definitions: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tony.ganchev/eslint-plugin-header",
-  "version": "3.2.4",
+  "version": "3.2.6",
   "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",
@@ -17,38 +17,29 @@
     "types",
     "CONTRIBUTING.md"
   ],
-  "scripts": {
-    "build": "npx tsc",
-    "e2e": "npm run build && npx mocha --timeout 60000 tests/e2e/*.js",
-    "eslint": "npx eslint .",
-    "lint": "npm run eslint && npm run markdownlint",
-    "markdownlint": "npx markdownlint-cli *.md",
-    "test": "npm run lint && npm run unit && npm run e2e",
-    "unit": "npx nyc --reporter=html --reporter=text --reporter=text-summary --reporter=lcov --check-coverage=true --statements=100 --branches=100 --lines=100 --functions=100 mocha tests/lib/*.js tests/lib/**/*.js"
-  },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/core": "^1.1.1",
     "@eslint/js": "^10.0.1",
     "@eslint/markdown": "^7.5.1",
-    "@stylistic/eslint-plugin": "^5.8.0",
-    "@types/node": "^25.2.3",
-    "eslint": "^10.0.0",
-    "eslint-plugin-eslint-plugin": "^7.3.0",
-    "eslint-plugin-jsdoc": "^62.5.4",
-    "eslint-plugin-n": "^17.23.2",
-    "markdownlint-cli": "^0.47.0",
-    "mocha": "^12.0.0-beta-9",
-    "nyc": "^17.1.0",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@types/estree": "^1.0.8",
+    "@types/json-schema": "^7.0.15",
+    "@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.4.0",
+    "markdownlint-cli": "^0.48.0",
+    "mocha": "12.0.0-beta-9",
     "testdouble": "^3.20.2",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.56.0"
+    "typescript-eslint": "^8.56.1"
   },
   "peerDependencies": {
     "eslint": ">=7.7.0"
   },
-  "overrides": {
-    "eslint": "^10.0.0"
-  },
   "keywords": [
     "eslint",
     "eslint-plugin",
@@ -86,5 +77,14 @@
   "contributors": [
     "Josh Kelley",
     "Stuart Knightley"
-  ]
-}
+  ],
+  "scripts": {
+    "build": "tsc",
+    "e2e": "pnpm build && mocha --timeout 60000 tests/e2e/*.js",
+    "eslint": "eslint .",
+    "lint": "pnpm eslint && pnpm markdownlint",
+    "markdownlint": "markdownlint *.md",
+    "test": "pnpm lint && pnpm unit && pnpm e2e",
+    "unit": "c8 --reporter=html --reporter=text --reporter=text-summary --reporter=lcov --check-coverage --100 mocha tests/lib/*.js tests/lib/**/*.js"
+  }
+}

package/types/index.d.ts

@@ -1,4 +1,4 @@
 export = pluginDefinition;
-/** @type {import('eslint').ESLint.Plugin} */
+/** @type {import("eslint").ESLint.Plugin} */
 declare const pluginDefinition: import("eslint").ESLint.Plugin;
 //# sourceMappingURL=index.d.ts.map

package/types/lib/comment-parser.d.ts

@@ -1,3 +1,3 @@
-declare function _exports(commentText: string): ["block" | "line", string[]];
+declare function _exports(commentText: string): [import("./rules/header").CommentType, string[]];
 export = _exports;
 //# sourceMappingURL=comment-parser.d.ts.map

package/types/lib/comment-parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"comment-parser.d.ts","sourceRoot":"","sources":["../../lib/comment-parser.js"],"names":[],"mappings":"AAsCiB,uCAJN,MAAM,GACJ,CAAC,OAAO,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,CAmBxC"}
+{"version":3,"file":"comment-parser.d.ts","sourceRoot":"","sources":["../../lib/comment-parser.js"],"names":[],"mappings":"AAuCiB,uCALN,MAAM,GACJ,CAAC,OAAO,gBAAgB,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAoB5D"}

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

@@ -1,100 +1,135 @@
 export { headerRule as header };
+export type NodeListener = Rule.NodeListener;
+export type ReportFixer = Rule.ReportFixer;
+export type RuleFixer = Rule.RuleFixer;
+export type RuleContext = Rule.RuleContext;
 /**
- * Import type definitions.
+ * The sequence of characters that define
+ * the end of a line.
  */
-export type Fix = import("eslint").Rule.Fix;
+export type LineEnding = "\n" | "\r\n";
 /**
- * Import type definitions.
- */
-export type NodeListener = import("eslint").Rule.NodeListener;
-/**
- * Import type definitions.
- */
-export type ReportFixer = import("eslint").Rule.ReportFixer;
-/**
- * Import type definitions.
- */
-export type RuleFixer = import("eslint").Rule.RuleFixer;
-/**
- * Import type definitions.
- */
-export type RuleContext = import("eslint").Rule.RuleContext;
-/**
- * Import type definitions.
- */
-export type Comment = import("estree").Comment;
-/**
- * Import type definitions.
- */
-export type Program = import("estree").Program;
-/**
- * Import type definitions.
- */
-export type SourceLocation = import("estree").SourceLocation;
-/**
- * Local type definitions.
+ * Matching rule for a line from the header
+ * using regular expression and optionally providing an auto-fix replacement.
  */
 export type HeaderLinePattern = {
+    /**
+     * A regular expression that should match
+     * the header line.
+     */
     pattern: string | RegExp;
-    template?: string;
+    /**
+     * When set, if the actual header line does not
+     * match `pattern`, this value is to be used when running auto-fix.
+     */
+    template?: string | undefined;
 };
 /**
- * Local type definitions.
+ * Matching rule for
+ * a single line of the header comment or the header comment as a whole if only
+ * one used.
  */
 export type HeaderLine = string | RegExp | HeaderLinePattern;
 /**
- * Local type definitions.
+ * The set of header comment-
+ * matching rules.
  */
 export type HeaderLines = HeaderLine | HeaderLine[];
 /**
- * Local type definitions.
+ * Defines what EOL
+ * characters to expect - either forced to be Windows / POSIX-compatible, or
+ * defaulting to whatever the OS expects.
  */
 export type LineEndingOption = "os" | "unix" | "windows";
 /**
- * Local type definitions.
+ * How to treat
+ * line endings.
  */
 export type HeaderSettings = {
     lineEndings?: LineEndingOption;
 };
 /**
- * Local type definitions.
+ * The expected type of comment to use
+ * for the header.
  */
 export type CommentType = "block" | "line";
 /**
- * Local type definitions.
+ * Header content configuration defined in a
+ * separate JavaScript template file.
  */
 export type FileBasedConfig = {
+    /**
+     * Template file path relative to the directory
+     * from which ESLint runs.
+     */
     file: string;
-    encoding?: BufferEncoding;
+    /**
+     * Encoding to use when reading the
+     * file. If omitted, `"utf8"` will be assumed.
+     */
+    encoding?: BufferEncoding | undefined;
 };
 /**
- * Local type definitions.
+ * Header content configuration defined inline
+ * within the ESLint configuration.
  */
 export type InlineConfig = {
+    /**
+     * The type of comment to expect.
+     */
     commentType: CommentType;
+    /**
+     * Matching rules for lines. If only one rule
+     * is provided, the rule would attempt to match either the first line ar all
+     * lines together.
+     */
     lines: HeaderLine[];
 };
 /**
- * Local type definitions.
+ * Rule configuration on the handling of
+ * empty lines after the header comment.
  */
 export type TrailingEmptyLines = {
-    minimum?: number;
+    /**
+     * If set, the rule would check that at least
+     * a `minimum` number of EOL characters trail the header.
+     */
+    minimum?: number | undefined;
+};
+export type HeaderOptionsWithoutSettings = {
+    /**
+     * The text matching rules
+     * for the header.
+     */
+    header: FileBasedConfig | InlineConfig;
+    /**
+     * Rules about empty lines
+     * after the header comment.
+     */
+    trailingEmptyLines?: TrailingEmptyLines | undefined;
 };
 /**
- * Local type definitions.
+ * Modern
+ * object-based rule configuration.
  */
-export type HeaderOptions = {
-    header: FileBasedConfig | InlineConfig;
-    trailingEmptyLines?: TrailingEmptyLines;
-} & HeaderSettings;
+export type HeaderOptions = HeaderOptionsWithoutSettings & HeaderSettings;
+export type LegacyFileBasedConfig = [template: string];
+export type LegacyFileBasedSettingsConfig = [template: string, settings: HeaderSettings];
+export type LegacyInlineConfig = [type: CommentType, lines: HeaderLines];
+export type LegacyInlineSettingsConfig = [type: CommentType, lines: HeaderLines, settings: HeaderSettings];
+export type LegacyInlineMinLinesConfig = [type: CommentType, lines: HeaderLines, minLines: number];
+export type LegacyInlineMinLinesSettingsConfig = [type: CommentType, lines: HeaderLines, minLines: number, settings: HeaderSettings];
 /**
- * Local type definitions.
+ * Full possible rule configuration options.
  */
-export type AllHeaderOptions = [HeaderOptions] | [template: string] | [template: string, settings: HeaderSettings] | [type: CommentType, lines: HeaderLines] | [type: CommentType, lines: HeaderLines, settings: HeaderSettings] | [type: CommentType, lines: HeaderLines, minLines: number] | [type: CommentType, lines: HeaderLines, minLines: number, settings: HeaderSettings];
+export type AllHeaderOptions = [HeaderOptions] | LegacyFileBasedConfig | LegacyFileBasedSettingsConfig | LegacyInlineConfig | LegacyInlineSettingsConfig | LegacyInlineMinLinesConfig | LegacyInlineMinLinesSettingsConfig;
 /**
- * Local type definitions.
+ * Rule
+ * configuration array including severity.
  */
-export type HeaderRuleConfig = import("eslint").Linter.RuleEntry<AllHeaderOptions>;
-/** @type {import('eslint').Rule.RuleModule} */
-declare const headerRule: import("eslint").Rule.RuleModule;
+export type HeaderRuleConfig = Linter.RuleEntry<AllHeaderOptions>;
+/** @type {Rule.RuleModule} */
+declare const headerRule: Rule.RuleModule;
+import type { Rule } from "eslint";
+import type { Linter } from "eslint";
 //# sourceMappingURL=header.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../../lib/rules/header.js"],"names":[],"mappings":";;;;kBAoCa,OAAO,QAAQ,EAAE,IAAI,CAAC,GAAG;;;;2BACzB,OAAO,QAAQ,EAAE,IAAI,CAAC,YAAY;;;;0BAClC,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW;;;;wBACjC,OAAO,QAAQ,EAAE,IAAI,CAAC,SAAS;;;;0BAC/B,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW;;;;sBACjC,OAAO,QAAQ,EAAE,OAAO;;;;sBACxB,OAAO,QAAQ,EAAE,OAAO;;;;6BACxB,OAAO,QAAQ,EAAE,cAAc;;;;gCAK/B;IAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE;;;;yBAC/C,MAAM,GAAG,MAAM,GAAG,iBAAiB;;;;0BACnC,UAAU,GAAG,UAAU,EAAE;;;;+BACzB,IAAI,GAAG,MAAM,GAAG,SAAS;;;;6BACzB;IAAE,WAAW,CAAC,EAAE,gBAAgB,CAAA;CAAE;;;;0BAClC,OAAO,GAAG,MAAM;;;;8BAChB;IACL,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,cAAc,CAAA;CAC5B;;;;2BAEQ;IACL,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,UAAU,EAAE,CAAA;CACtB;;;;iCAEQ;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE;;;;4BACpB;IACL,MAAM,EAAE,eAAe,GAAG,YAAY,CAAC;IACvC,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CAC1C,GACC,cAAc;;;;+BAEP,CAAC,aAAa,CAAC,GAC3B,CAAI,QAAQ,EAAE,MAAM,CAAC,GACrB,CAAI,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,GAC/C,CAAI,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,GAC1C,CAAI,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,CAAC,GACpE,CAAI,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,CAAC,GAC5D,CACM,IAAI,EAAE,WAAW,EACjB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,cAAc,CAC1B;;;;+BAEQ,OAAO,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC;AAqbhE,+CAA+C;AAC/C,0BADW,OAAO,QAAQ,EAAE,IAAI,CAAC,UAAU,CA8dzC"}
+{"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;;;;;;;;;;;;;;;;;;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;AA0sB/C,8BAA8B;AAC9B,0BADW,eAAe,CAuHxB;0BAv6B4D,QAAQ;4BAAR,QAAQ"}

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

@@ -15,6 +15,6 @@ export const commentTypeOptions: Readonly<{
     block: "block";
     line: "line";
 }>;
-/** @type {import('json-schema').JSONSchema4} */
+/** @type {import("json-schema").JSONSchema4} */
 export const schema: import("json-schema").JSONSchema4;
 //# sourceMappingURL=header.schema.d.ts.map

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":"gCA2BU,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,CAwKzC"}