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

package/CONTRIBUTING.md

@@ -45,20 +45,20 @@ There are two product lines as of today:
 After cloning the repository you can try to do a full CI/CD run:
 
 ```bash
-$ npm install
+$ pnpm install
 ...
-$ npm run test
+$ pnpm run test
 ...
 ```
 
 It will run a number of other npm scripts that together verify the code:
 
-| script          | Description                                                |
-|-----------------|------------------------------------------------------------|
-| `npm run lint`  | Lints the source and docs.                                 |
-| `npm run unit`  | Runs all mocha unit tests.                                 |
-| `npm run build` | Generates TypeScript bindings. Prerequisite for E2E tests. |
-| `npm run e2e`   | Runs E2E smoke tests for all supported versions of ESLint. |
+| script       | Description                                                   |
+|--------------|---------------------------------------------------------------|
+| `pnpm lint`  | Lints the source and docs.                                    |
+| `pnpm unit`  | Runs all mocha unit tests.                                    |
+| `pnpm build` | Generates TypeScript bindings. Prerequisite for E2E tests.    |
+| `pnpm e2e`   | Runs E2E smoke tests for all supported versions of ESLint.    |
 
 ## Development
 

package/LICENSE.md

@@ -1,6 +1,7 @@
 # MIT License
 
-Copyright (c) 2015-present Stuart Knightley, Tony Ganchev and contributors
+Copyright (c) 2015-present Stuart Knightley and contributors
+Copyright (c) 2024-present Tony Ganchev
 
 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

package/index.d.ts

@@ -1,8 +1,8 @@
-/*
- * MIT License
- *
- * Copyright (c) 2026-present Tony Ganchev and contributors
- *
+/**
+ * @file Entry point `index.js` type definitions to support TypeScript-based
+ * ESLint configuration. Ensures only the public interfaces are exposed.
+ * @copyright Copyright (c) 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

package/index.js

@@ -1,8 +1,8 @@
-/*
- * MIT License
- *
- * Copyright (c) 2015-present Stuart Knightley, Tony Ganchev, and contributors
- *
+/**
+ * @file Entry point for the plugin.
+ * @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
@@ -26,7 +26,7 @@
 
 const { header } = require("./lib/rules/header");
 
-/** @type {import('eslint').ESLint.Plugin} */
+/** @type {import("eslint").ESLint.Plugin} */
 const pluginDefinition = {
     rules: {
         header

package/lib/comment-parser.js

@@ -1,8 +1,8 @@
-/*
- * MIT License
- *
- * Copyright (c) 2015-present Stuart Knightley, Tony Ganchev, and contributors
- *
+/**
+ * @file Parsing utility for JavaScript comments to get text content and type.
+ * @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
@@ -32,9 +32,10 @@ const assert = require("node:assert");
  *
  * This is a really simple and dumb parser, that looks just for a
  * single kind of comment. It won't detect multiple block comments.
- * @param {string} commentText comment text.
- * @returns {['block' | 'line', string[]]} comment type and comment content
- *                                         broken into lines.
+ * @param {string} commentText Content to parse.
+ * @returns {[import("./rules/header").CommentType, string[]]} Comment type and
+ * comment content broken into lines.
+ * @throws {Error} If `commentText` starts with an unrecognized comment token.
  */
 module.exports = function commentParser(commentText) {
     assert.strictEqual(typeof commentText, "string");

package/lib/rules/eslint-utils.js

@@ -1,8 +1,8 @@
-/*
- * MIT License
- *
- * Copyright (c) 2025-present Tony Ganchev and contributors
- *
+/**
+ * @file Utilities to bridge incompatible versions of ESLint APIs. Currently it
+ * wraps methods removed in ESLint 10 but required for ESLint 7.
+ * @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
@@ -25,8 +25,8 @@
 "use strict";
 
 /**
- * @typedef {import('eslint').Rule.RuleContext} RuleContext
- * @typedef {import('eslint').SourceCode} SourceCode
+ * @typedef {import("eslint").Rule.RuleContext} RuleContext
+ * @typedef {import("eslint").SourceCode} SourceCode
  */
 
 module.exports = {
@@ -34,9 +34,9 @@ module.exports = {
      * Provides compatibility wrapper for ESLint 7 through 10 for getting the
      * full source code object from the execution context.
      * @param {RuleContext} context ESLint execution context.
-     * @returns {SourceCode} the source-code object.
+     * @returns {SourceCode} The source-code object.
      */
-    contextSourceCode: function(context) {
+    contextSourceCode: function (context) {
         return context.sourceCode
             || /** @type {RuleContext & { getSourceCode: () => SourceCode }} */(context).getSourceCode();
     }

package/lib/rules/header.docs.js

@@ -1,8 +1,8 @@
-/*
- * MIT License
- *
- * Copyright (c) 2025-present Tony Ganchev and contributors
- *
+/**
+ * @file Constants to use when constructing the metadata of the `header` rule.
+ * It aims to reduce the size of the already large main header.js.
+ * @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,7 +22,6 @@
  * SOFTWARE.
  */
 
-
 "use strict";
 
 exports.description = "The rule validates that the source file starts with a specific header comment pattern.";