@tony.ganchev/eslint-plugin-header 3.1.11 → 3.1.12

package/README.md

@@ -10,17 +10,18 @@ defined in the rule settings.
 ## Table of Contents
 
 1. [Scope and Acknowledgements](#scope-and-acknowledgements)
-2. [Usage](#usage)
+2. [Compatibility](#compatibility)
+3. [Usage](#usage)
    1. [File-based Configuration](#file-based-configuration)
    2. [Inline Configuration](#inline-configuration)
       1. [Header Contents Configuration](#header-contents-configuration)
       2. [Trailing Empty Lines Configuration](#trailing-empty-lines-configuration)
       3. [Line Endings](#line-endings)
-3. [Examples](#examples)
-4. [Versioning](#versioning)
+4. [Examples](#examples)
+5. [Versioning](#versioning)
    1. [What is a Feature?](#what-is-a-feature)
    2. [What is Backward-compatibility?](#what-is-backward-compatibility)
-5. [License](#license)
+6. [License](#license)
 
 ## Scope and Acknowledgements
 
@@ -39,6 +40,11 @@ It addresses the following issus:
   forward. This would come at the expense of plugin compatibility and the
   portability of fixes to the upstream repository.
 
+## Compatibility
+
+The plugin supports ESLint 7 / 8 / 9 / 10rc0 (check package.json for details).
+Both flat config and legacy, hierarchical config can be used.
+
 ## Usage
 
 This rule takes between 1 and 4 arguments after the rule validation severity.

package/lib/rules/eslint-utils.js

@@ -0,0 +1,42 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025-present Tony Ganchev and contributors
+ *
+ * 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
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+"use strict";
+
+/**
+ * @typedef {import('eslint').Rule.RuleContext} RuleContext
+ * @typedef {import('eslint').SourceCode} SourceCode
+ */
+
+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.
+     */
+    contextSourceCode: function(context) {
+        return context.sourceCode || context.getSourceCode();
+    }
+};

package/lib/rules/header.js

@@ -28,6 +28,7 @@ const assert = require("assert");
 const fs = require("fs");
 const os = require("os");
 const commentParser = require("../comment-parser");
+const { contextSourceCode } = require("./eslint-utils");
 const { description, recommended, url } = require("./header.docs");
 const { commentTypeOptions, lineEndingOptions, schema } = require("./header.schema");
 
@@ -110,13 +111,14 @@ function excludeShebangs(comments) {
  * @returns {Comment[]} lines that constitute the leading comment.
  */
 function getLeadingComments(context, node) {
-    const all = excludeShebangs(context.sourceCode.getAllComments(node.body.length ? node.body[0] : node));
+    const sourceCode = contextSourceCode(context);
+    const all = excludeShebangs(sourceCode.getAllComments(node.body.length ? node.body[0] : node));
     if (all[0].type.toLowerCase() === commentTypeOptions.block) {
         return [all[0]];
     }
     let i = 1;
     for (; i < all.length; ++i) {
-        const txt = context.sourceCode.text.slice(all[i - 1].range[1], all[i].range[0]);
+        const txt = sourceCode.text.slice(all[i - 1].range[1], all[i].range[0]);
         if (!txt.match(/^(\r\n|\r|\n)$/)) {
             break;
         }
@@ -187,14 +189,15 @@ function genPrependFixer(commentType, context, headerLines, eol, numNewlines) {
     return function(fixer) {
         let insertPos = 0;
         let newHeader = genCommentBody(commentType, headerLines, eol, numNewlines);
-        if (context.sourceCode.text.startsWith("#!")) {
-            const firstNewLinePos = context.sourceCode.text.indexOf("\n");
-            insertPos = firstNewLinePos === -1 ? context.sourceCode.text.length : firstNewLinePos + 1;
+        const sourceCode = contextSourceCode(context);
+        if (sourceCode.text.startsWith("#!")) {
+            const firstNewLinePos = sourceCode.text.indexOf("\n");
+            insertPos = firstNewLinePos === -1 ? sourceCode.text.length : firstNewLinePos + 1;
             if (firstNewLinePos === -1) {
                 newHeader = eol + newHeader;
             }
         }
-        const numEmptyLines = leadingEmptyLines(context.sourceCode.text.substring(insertPos));
+        const numEmptyLines = leadingEmptyLines(sourceCode.text.substring(insertPos));
         const additionalEmptyLines = Math.max(0, numNewlines - numEmptyLines);
         newHeader += eol.repeat(additionalEmptyLines);
         return fixer.insertTextBeforeRange(
@@ -219,7 +222,7 @@ function genPrependFixer(commentType, context, headerLines, eol, numNewlines) {
 function genReplaceFixer(commentType, context, leadingComments, headerLines, eol, numNewlines) {
     return function(fixer) {
         const commentRange = genCommentsRange(leadingComments);
-        const emptyLines = leadingEmptyLines(context.sourceCode.text.substring(commentRange[1]));
+        const emptyLines = leadingEmptyLines(contextSourceCode(context).text.substring(commentRange[1]));
         const missingNewlines = Math.max(0, numNewlines - emptyLines);
         const eols = eol.repeat(missingNewlines);
         return fixer.replaceTextRange(
@@ -397,8 +400,9 @@ module.exports = {
              * @returns {void}
              */
             Program: function(node) {
-                if (!hasHeader(context.sourceCode.text)) {
-                    const hasShebang = context.sourceCode.text.startsWith("#!");
+                const sourceCode = contextSourceCode(context);
+                if (!hasHeader(sourceCode.text)) {
+                    const hasShebang = sourceCode.text.startsWith("#!");
                     const line = hasShebang ? 2 : 1;
                     context.report({
                         loc: {
@@ -577,8 +581,8 @@ module.exports = {
                         }
                     }
 
-                    const actualLeadingEmptyLines = leadingEmptyLines(
-                        context.sourceCode.text.substring(leadingComments[headerLines.length - 1].range[1]));
+                    const actualLeadingEmptyLines =
+                        leadingEmptyLines(sourceCode.text.substring(leadingComments[headerLines.length - 1].range[1]));
                     const missingEmptyLines = numNewlines - actualLeadingEmptyLines;
                     if (missingEmptyLines > 0) {
                         context.report({
@@ -717,8 +721,8 @@ module.exports = {
                     return;
                 }
 
-                const actualLeadingEmptyLines = leadingEmptyLines(
-                    context.sourceCode.text.substring(leadingComments[0].range[1]));
+                const actualLeadingEmptyLines =
+                    leadingEmptyLines(sourceCode.text.substring(leadingComments[0].range[1]));
                 const missingEmptyLines = numNewlines - actualLeadingEmptyLines;
                 if (missingEmptyLines > 0) {
                     context.report({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tony.ganchev/eslint-plugin-header",
-  "version": "3.1.11",
+  "version": "3.1.12",
   "description": "ESLint plugin to ensure files begin with a given comment, usually a copyright or license notice.",
   "main": "index.js",
   "files": [
@@ -11,19 +11,21 @@
     "eslint": "npx eslint .",
     "lint": "npm run eslint && npm run markdownlint",
     "markdownlint": "npx markdownlint-cli *.md",
-    "test": "npm run lint && npm run unit",
-    "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"
+    "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"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.39.1",
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.2",
     "@eslint/markdown": "^7.5.1",
-    "@stylistic/eslint-plugin": "^5.5.0",
-    "eslint": "^9.39.1",
-    "eslint-plugin-eslint-plugin": "^7.2.0",
-    "eslint-plugin-jsdoc": "^61.1.12",
-    "eslint-plugin-n": "^17.23.1",
-    "mocha": "^11.7.5",
+    "@stylistic/eslint-plugin": "^5.7.0",
+    "eslint": "^9.39.2",
+    "eslint-plugin-eslint-plugin": "^7.3.0",
+    "eslint-plugin-jsdoc": "^62.1.0",
+    "eslint-plugin-n": "^17.23.2",
+    "markdownlint-cli": "^0.47.0",
+    "mocha": "^12.0.0-beta-5",
     "nyc": "^17.1.0",
     "testdouble": "^3.20.2"
   },
@@ -40,7 +42,7 @@
   },
   "author": "Stuart Knightley",
   "license": "MIT",
-  "contributors": [
+  "maintainers": [
     "Tony Ganchev"
   ]
 }