@tony.ganchev/eslint-plugin-header 3.2.0 → 3.2.1

package/lib/rules/header.schema.js

@@ -41,6 +41,7 @@ const commentTypeOptions = Object.freeze({
     line: "line"
 });
 
+/** @type {import('json-schema').JSONSchema4} */
 const schema = Object.freeze({
     $ref: "#/definitions/options",
     definitions: {

package/package.json

@@ -1,33 +1,47 @@
 {
   "name": "@tony.ganchev/eslint-plugin-header",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "ESLint plugin to ensure files begin with a given comment, usually a copyright or license notice.",
   "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.js"
+    }
+  },
   "files": [
-    "/lib/**/*.js",
-    "!/lib/rules/test-utils.js"
+    "lib/**/*.js",
+    "index.d.ts*",
+    "types",
+    "!lib/rules/test-utils.js"
   ],
   "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",
-    "e2e": "npx mocha --timeout 60000 tests/e2e/*.js"
+    "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/js": "^9.39.2",
     "@eslint/markdown": "^7.5.1",
-    "@stylistic/eslint-plugin": "^5.7.0",
+    "@stylistic/eslint-plugin": "^5.7.1",
+    "@types/node": "^25.2.1",
     "eslint": "^9.39.2",
     "eslint-plugin-eslint-plugin": "^7.3.0",
-    "eslint-plugin-jsdoc": "^62.1.0",
+    "eslint-plugin-jsdoc": "^62.5.2",
     "eslint-plugin-n": "^17.23.2",
     "markdownlint-cli": "^0.47.0",
-    "mocha": "^12.0.0-beta-5",
+    "mocha": "^12.0.0-beta-6",
     "nyc": "^17.1.0",
-    "testdouble": "^3.20.2"
+    "testdouble": "^3.20.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0"
   },
   "peerDependencies": {
     "eslint": ">=7.7.0"
@@ -38,7 +52,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/tonyganchev/eslint-plugin-header.git"
+    "url": "git+https://github.com/tonyganchev/eslint-plugin-header.git"
   },
   "author": "Stuart Knightley",
   "license": "MIT",

package/types/index.d.ts

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

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.js"],"names":[],"mappings":";AA4BA,6CAA6C;AAC7C,gCADW,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,CAKvC"}

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

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

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

@@ -0,0 +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"}

package/types/lib/rules/eslint-utils.d.ts

@@ -0,0 +1,10 @@
+declare namespace _exports {
+    export { RuleContext, SourceCode };
+}
+declare namespace _exports {
+    function contextSourceCode(context: RuleContext): SourceCode;
+}
+export = _exports;
+type RuleContext = import("eslint").Rule.RuleContext;
+type SourceCode = import("eslint").SourceCode;
+//# sourceMappingURL=eslint-utils.d.ts.map

package/types/lib/rules/eslint-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint-utils.d.ts","sourceRoot":"","sources":["../../../lib/rules/eslint-utils.js"],"names":[],"mappings":";;;;IAsCuB,oCAHR,WAAW,GACT,UAAU,CAItB;;;mBAbQ,OAAO,QAAQ,EAAE,IAAI,CAAC,WAAW;kBACjC,OAAO,QAAQ,EAAE,UAAU"}

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

@@ -0,0 +1,100 @@
+export { headerRule as header };
+/**
+ * Import type definitions.
+ */
+export type Fix = import("eslint").Rule.Fix;
+/**
+ * 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.
+ */
+export type HeaderLinePattern = {
+    pattern: string | RegExp;
+    template?: string;
+};
+/**
+ * Local type definitions.
+ */
+export type HeaderLine = string | RegExp | HeaderLinePattern;
+/**
+ * Local type definitions.
+ */
+export type HeaderLines = HeaderLine | HeaderLine[];
+/**
+ * Local type definitions.
+ */
+export type LineEndingOption = "os" | "unix" | "windows";
+/**
+ * Local type definitions.
+ */
+export type HeaderSettings = {
+    lineEndings?: LineEndingOption;
+};
+/**
+ * Local type definitions.
+ */
+export type CommentType = "block" | "line";
+/**
+ * Local type definitions.
+ */
+export type FileBasedConfig = {
+    file: string;
+    encoding?: BufferEncoding;
+};
+/**
+ * Local type definitions.
+ */
+export type InlineConfig = {
+    commentType: CommentType;
+    lines: HeaderLine[];
+};
+/**
+ * Local type definitions.
+ */
+export type TrailingEmptyLines = {
+    minimum?: number;
+};
+/**
+ * Local type definitions.
+ */
+export type HeaderOptions = {
+    header: FileBasedConfig | InlineConfig;
+    trailingEmptyLines?: TrailingEmptyLines;
+} & HeaderSettings;
+/**
+ * Local type definitions.
+ */
+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];
+/**
+ * Local type definitions.
+ */
+export type HeaderRuleConfig = import("eslint").Linter.RuleEntry<AllHeaderOptions>;
+/** @type {import('eslint').Rule.RuleModule} */
+declare const headerRule: import("eslint").Rule.RuleModule;
+//# sourceMappingURL=header.d.ts.map

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

@@ -0,0 +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,CA+dzC"}

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

@@ -0,0 +1,4 @@
+export const description: "";
+export const recommended: true;
+export const url: string;
+//# sourceMappingURL=header.docs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"header.docs.d.ts","sourceRoot":"","sources":["../../../lib/rules/header.docs.js"],"names":[],"mappings":""}

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

@@ -0,0 +1,20 @@
+export type lineEndingOptions = string;
+/**
+ * @enum {string}
+ */
+export const lineEndingOptions: Readonly<{
+    os: "os";
+    unix: "unix";
+    windows: "windows";
+}>;
+export type commentTypeOptions = string;
+/**
+ * @enum {string}
+ */
+export const commentTypeOptions: Readonly<{
+    block: "block";
+    line: "line";
+}>;
+/** @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

@@ -0,0 +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"}

package/types/lib/rules/test-utils.d.ts

@@ -0,0 +1,10 @@
+declare namespace _exports {
+    export { InvalidTestCase, TestCaseError };
+}
+declare namespace _exports {
+    function generateInvalidTestCaseNames(invalidTests: InvalidTestCase[]): InvalidTestCase[];
+}
+export = _exports;
+type InvalidTestCase = import("eslint").RuleTester.InvalidTestCase;
+type TestCaseError = import("eslint").RuleTester.TestCaseError;
+//# sourceMappingURL=test-utils.d.ts.map

package/types/lib/rules/test-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../../lib/rules/test-utils.js"],"names":[],"mappings":";;;;IA4EkC,oDAJnB,eAAe,EAAE,GACf,eAAe,EAAE,CA2C7B;;;uBAvFQ,OAAO,QAAQ,EAAE,UAAU,CAAC,eAAe;qBAC3C,OAAO,QAAQ,EAAE,UAAU,CAAC,aAAa"}