@tony.ganchev/eslint-plugin-header 3.4.2 → 3.4.3

package/README.md

@@ -7,7 +7,7 @@
 The native ESLint 9/10 standard header-validating plugin. A zero-bloat, drop-in
 replacement for [eslint-plugin-header](https://github.com/Stuk/eslint-plugin-header)
 with first-class Flat Config & TypeScript support. Auto-fix copyright, license,
-and banner comments in JavaScript, TypeScript, Vue, Svelte, CSS, HTML, and
+and banner comments in JavaScript, TypeScript, Vue, Svelte, CSS, HTML, YAML, and
 Markdown files. Supports _oxlint_.
 
 ## Table of Contents
@@ -33,6 +33,7 @@ Markdown files. Supports _oxlint_.
    7. [Linting Vue](#linting-vue)
    8. [Linting Svelte](#linting-svelte)
    9. [Linting Markdown](#linting-markdown)
+   10. [Linting YAML](#linting-yaml)
 5. [Comparison to Alternatives](#comparison-to-alternatives)
    1. [Compared to eslint-plugin-headers](#compared-to-eslint-plugin-headers)
       1. [Health Scans](#health-scans)
@@ -134,9 +135,10 @@ statements. Smoke tests cover this support as well.
 ### Languages
 
 Currently the plugin supports linting copyright headers in JavaScript,
-TypeScript and their JSX / TSX flavors; Vue, Svelte, CSS, HTML, and Markdown
-files. As mentioned in the previous sections, not all languages are supported
-for oxlint or ESLint older than 9. Refer to the table below for more details.
+TypeScript and their JSX / TSX flavors; Vue, Svelte, CSS, HTML, YAML, and
+Markdown files. As mentioned in the previous sections, not all languages are
+supported for oxlint or ESLint older than 9. Refer to the table below for more
+details.
 
 | Language   | ESLint 7 / 8  | ESLint 9 / 10 | oxlint |
 |------------|---------------|---------------|--------|
@@ -148,6 +150,7 @@ for oxlint or ESLint older than 9. Refer to the table below for more details.
 | Svelte     | ✅ Yes        | ✅ Yes        | ❌ No  |
 | CSS        | ❌ No         | ✅ Yes        | ❌ No  |
 | HTML       | ❌ No         | ✅ Yes        | ❌ No  |
+| YAML       | ❌ No         | ✅ Yes        | ❌ No  |
 | Markdown   | ❌ No         | ✅ Yes        | ❌ No  |
 
 ## Usage
@@ -1488,6 +1491,50 @@ Markdown (`**/*.md/*.js`). Same applies to `*.ts`, `*.jsx`, `*.tsx`, etc.
 
 As with CSS, only block comments are supported - no line- or shebang comments.
 
+### Linting YAML
+
+The rule supports linting copyright notices in YAML files. The rule works with
+the _eslint-plugin-yml_ plugin and its parser.
+
+Similar to CSS and Markdown, all you need to do to turn on header validation is
+to configure the _eslint-plugin-yml_ plugin, the correct language, and the rule:
+
+```ts
+import header from "@tony.ganchev/eslint-plugin-header";
+import yml from "eslint-plugin-yml";
+
+export default [
+    {
+        files: ["**/*.yaml", "**/*.yml"],
+        plugins: {
+            "@tony.ganchev": header,
+            yml
+        },
+        language: "yml/yaml",
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "line",
+                        lines: [" Copyright 2025 "]
+                    }
+                }
+            ]
+        }
+    }
+];
+```
+
+```yaml
+# Copyright 2025
+
+foo: bar
+```
+
+As YAML only supports line comments, be sure to use `commentType: "line"`. If
+`commentType: "block"` is used, the rule will report a violation.
+
 ## Comparison to Alternatives
 
 A number of projects have been aiming to solve problems similar to

package/lib/rules/header.js

@@ -206,7 +206,7 @@ function match(actual, expected) {
 
 /**
  * @typedef {object} Language
- * @property { BlockComment } blockComment The tokens delimiting a block
+ * @property { BlockComment } [blockComment] The tokens delimiting a block
  * comment.
  * @property { LineComment } [lineComment] The tokens delimiting a line comment
  * if such is allowed.
@@ -348,7 +348,8 @@ function getLeadingComments(sourceCode, language) {
  */
 function genCommentBody(commentType, textArray, eol, language) {
     if (commentType === commentTypeOptions.block) {
-        return language.blockComment.startDelimiter + textArray.join(eol) + language.blockComment.endDelimiter;
+        const blockComment = /** @type {BlockComment} */ (language.blockComment);
+        return blockComment.startDelimiter + textArray.join(eol) + blockComment.endDelimiter;
     } else {
         const lineStartDelimiter = /** @type {LineComment} */ (language.lineComment).startDelimiter;
         // We need one trailing EOL on line comments to ensure the fixed source
@@ -413,8 +414,15 @@ function genPrependFixer(commentType, sourceCode, headerLines, eol, numNewlines,
                 newHeader = eol + newHeader;
             }
         }
-        const numEmptyLines = leadingEmptyLines(sourceCode.text.substring(insertPos));
-        const additionalEmptyLines = Math.max(0, numNewlines - numEmptyLines);
+        const existingSourceCodeFromInsertPos = sourceCode.text.substring(insertPos);
+        const numEmptyLines = leadingEmptyLines(existingSourceCodeFromInsertPos);
+        const additionalEmptyLines = Math.max(numNewlines - numEmptyLines,
+            (commentType === commentTypeOptions.line
+                && existingSourceCodeFromInsertPos.startsWith(
+                    /** @type {{ startDelimiter: string }} */(language.lineComment).startDelimiter))
+                ? 1
+                : 0
+        );
         newHeader += eol.repeat(additionalEmptyLines);
         return fixer.insertTextBeforeRange(
             [insertPos, insertPos /* don't care */],
@@ -833,7 +841,7 @@ class CommentMatcher {
                 }
             }
 
-            const commentRange = leadingComments[this.headerLines.length - 1].range;
+            const commentRange = leadingComments[leadingComments.length - 1].range;
             const actualLeadingEmptyLines = leadingEmptyLines(sourceCode.text.substring(commentRange[1]));
             const missingEmptyLines = this.numLines - actualLeadingEmptyLines;
             if (missingEmptyLines > 0) {
@@ -849,6 +857,7 @@ class CommentMatcher {
 
             return null;
         }
+
         // if block comment pattern has more than 1 line, we also split the
         // comment
         let leadingLines = [leadingComments[0].value];
@@ -862,8 +871,9 @@ class CommentMatcher {
         let errorMessageData;
         /** @type {null | SourceLocation} */
         let errorMessageLoc = null;
-        const blockStartLen = this.language.blockComment.startDelimiter.length;
-        const blockEndLen = this.language.blockComment.endDelimiter.length;
+        const blockComment = /** @type {BlockComment} */(this.language.blockComment);
+        const blockStartLen = blockComment.startDelimiter.length;
+        const blockEndLen = blockComment.endDelimiter.length;
 
         for (let i = 0; i < this.headerLines.length; i++) {
             if (leadingLines.length - 1 < i) {
@@ -1017,7 +1027,8 @@ const headerRule = {
             // messages only applicable to header validation.
             missingHeader: "missing header",
             noNewlineAfterHeader: "not enough newlines after header: expected: {{expected}}, actual: {{actual}}",
-            unsupportedLineHeader: "line header configured but not supported for this language"
+            unsupportedBlockHeader: "block-comment header configured but not supported for this language",
+            unsupportedLineHeader: "line-comment header configured but not supported for this language"
         }
     },
 
@@ -1030,6 +1041,7 @@ const headerRule = {
 
         const newStyleOptions = transformLegacyOptions(/** @type {AllHeaderOptions} */(context.options));
         const sourceCode = contextSourceCode(context);
+        // console.log(sourceCode);
 
         /**
          * Hooks into the processing of the overall script node to do the
@@ -1051,7 +1063,7 @@ const headerRule = {
             });
             const numLines = /** @type {number} */ (options.trailingEmptyLines?.minimum);
 
-            if (!language.lineComment && (/** @type {InlineConfig} */ (options.header)).commentType === "line") {
+            if (!language.lineComment && header.commentType === "line") {
                 context.report({
                     messageId: "unsupportedLineHeader",
                     loc: {
@@ -1062,6 +1074,17 @@ const headerRule = {
                 return;
             }
 
+            if (!language.blockComment && header.commentType === "block") {
+                context.report({
+                    messageId: "unsupportedBlockHeader",
+                    loc: {
+                        start: sourceCode.getLocFromIndex(0),
+                        end: sourceCode.getLocFromIndex(1),
+                    },
+                });
+                return;
+            }
+
             const headerMatcher = new CommentMatcher(header, eol, numLines, language);
             const allowedLeadingComments = /** @type {LeadingComments} */ (options.leadingComments).comments;
             const allowedCommentsMatchers =
@@ -1205,6 +1228,13 @@ const headerRule = {
             }
         };
 
+        /** @type {Language} */
+        const yamlStyleLanguage = {
+            lineComment: {
+                startDelimiter: "#"
+            }
+        };
+
         /**
          * Tests if the source code was parsed by _@html-eslint/eslint-plugin_'s
          * parser.
@@ -1243,8 +1273,29 @@ const headerRule = {
             return isHtmlParser() || isVueParser() || isSvelteParser();
         };
 
+        /**
+         * Tests if the source code was parsed by _yaml-eslint-parser_.
+         * @returns {boolean} `true` if the source code is parsed by the parser.
+         */
+        function isYamlStyleLanguage() {
+            // YAML parser has distinct identity from JS parset but also has an
+            // identifier in its `parserServices` section and that check is
+            // faster.
+            return sourceCode.parserServices.isYAML;
+        }
+
+        const programLanguageSearchMap = [
+            { test: isHtmlStyleLanguage, language: htmlStyleLanguage },
+            { test: isYamlStyleLanguage, language: yamlStyleLanguage },
+            { test: () => true, language: jsStyleLanguage }
+        ];
+
         const hooks = {
-            Program: () => onRootNode(isHtmlStyleLanguage() ? htmlStyleLanguage : jsStyleLanguage),
+            Program: () => onRootNode(
+                /** @type {{ test: () => boolean, language: Language}} */(
+                    programLanguageSearchMap.find((item) => item.test())
+                ).language
+            ),
             StyleSheet: () => onRootNode(cssStyleLanguage),
             // eslint/markdown
             root: () => onRootNode(htmlStyleLanguage),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tony.ganchev/eslint-plugin-header",
-  "version": "3.4.2",
-  "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 JavaScript, TypeScript, Vue, Svelte, CSS, HTML, and Markdown files. Supports oxlint.",
+  "version": "3.4.3",
+  "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 JavaScript, TypeScript, Vue, Svelte, CSS, HTML, YAML, and Markdown files. Supports oxlint.",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {
@@ -21,25 +21,26 @@
     "@eslint/core": "^1.2.0",
     "@eslint/css": "^1.1.0",
     "@eslint/js": "^10.0.1",
-    "@eslint/markdown": "^7.5.1",
+    "@eslint/markdown": "^8.0.1",
     "@html-eslint/eslint-plugin": "^0.58.1",
     "@stylistic/eslint-plugin": "^5.10.0",
     "@types/estree": "^1.0.8",
     "@types/json-schema": "^7.0.15",
     "@types/node": "^25.5.2",
     "c8": "^11.0.0",
-    "eslint": "^10.1.0",
+    "eslint": "^10.2.0",
     "eslint-plugin-eslint-plugin": "^7.3.2",
     "eslint-plugin-jsdoc": "^62.9.0",
     "eslint-plugin-n": "^17.24.0",
     "eslint-plugin-svelte": "^3.17.0",
     "eslint-plugin-vue": "^10.8.0",
+    "eslint-plugin-yml": "^3.3.1",
     "globals": "^17.4.0",
     "markdownlint-cli": "^0.48.0",
     "mocha": "12.0.0-beta-10",
     "svelte-eslint-parser": "^1.6.0",
     "testdouble": "^3.20.2",
-    "typescript": "^5.9.3",
+    "typescript": "^6.0.2",
     "typescript-eslint": "^8.58.0",
     "vue-eslint-parser": "^10.4.0"
   },
@@ -84,7 +85,9 @@
     "typescript",
     "vue",
     "vuejs",
-    "vue-js"
+    "vue-js",
+    "yaml",
+    "yml"
   ],
   "repository": {
     "type": "git",

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

@@ -188,7 +188,7 @@ export type Language = {
      * The tokens delimiting a block
      * comment.
      */
-    blockComment: BlockComment;
+    blockComment?: BlockComment | undefined;
     /**
      * The tokens delimiting a line comment
      * if such is allowed.

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

@@ -1 +1 @@
-{"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;oBAiClC,CAAC,MAAM,EAAE,MAAM,CAAC;;;;;UAKf,SAAS,GAAG,OAAO,GAAG,MAAM;;;;WAC5B,MAAM;;;;WACN,KAAK;;;;SACL,cAAc;;;;;;;oBAKd,MAAM;;;;;kBAEN,MAAM;;;;;;;oBAMN,MAAM;;;;;;;kBAML,YAAY;;;;;;;;;;;;AAmwB3B,8BAA8B;AAC9B,0BADW,eAAe,CAkRxB;AAhqBF,2EAA2E;AAC3E,+BADW,MAAM,CAAC,MAAM,EAAE;IAAE,WAAW,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC,CAC3C;0BAniBkC,QAAQ;4BAAR,QAAQ;oCAC1B,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;oBAiClC,CAAC,MAAM,EAAE,MAAM,CAAC;;;;;UAKf,SAAS,GAAG,OAAO,GAAG,MAAM;;;;WAC5B,MAAM;;;;WACN,KAAK;;;;SACL,cAAc;;;;;;;oBAKd,MAAM;;;;;kBAEN,MAAM;;;;;;;oBAMN,MAAM;;;;;;;;;;;;;;;;;;;AAmxBpB,8BAA8B;AAC9B,0BADW,eAAe,CA2TxB;AA3sBF,2EAA2E;AAC3E,+BADW,MAAM,CAAC,MAAM,EAAE;IAAE,WAAW,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC,CAC3C;0BA3iBkC,QAAQ;4BAAR,QAAQ;oCAC1B,QAAQ"}