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

package/README.md

@@ -7,8 +7,8 @@
 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, CSS, HTML, and Markdown files.
-Supports _oxlint_.
+and banner comments in JavaScript, TypeScript, Vue, Svelte, CSS, HTML, and
+Markdown files. Supports _oxlint_.
 
 ## Table of Contents
 
@@ -30,11 +30,14 @@ Supports _oxlint_.
    4. [Examples](#examples)
    5. [Linting CSS](#linting-css)
    6. [Linting HTML](#linting-html)
-   7. [Linting Markdown](#linting-markdown)
+   7. [Linting Vue](#linting-vue)
+   8. [Linting Svelte](#linting-svelte)
+   9. [Linting Markdown](#linting-markdown)
 5. [Comparison to Alternatives](#comparison-to-alternatives)
    1. [Compared to eslint-plugin-headers](#compared-to-eslint-plugin-headers)
       1. [Health Scans](#health-scans)
    2. [Compared to eslint-plugin-license-header](#compared-to-eslint-plugin-license-header)
+   3. [Compared to eslint-plugin-notice](#compared-to-eslint-plugin-notice)
 6. [Versioning](#versioning)
    1. [What is a Feature?](#what-is-a-feature)
    2. [What is Backward-compatibility?](#what-is-backward-compatibility)
@@ -117,7 +120,7 @@ copyright headers in CSS, HTML, or Markdown rely on APIs introduced with ESLint
 The plugin works with latest version of **oxlint** too. We have a smoke-test
 running to confirm the plugin works with the latest version of oxlint. Features
 relying on the use of non-standard parsers such as linting headers in CSS, HTML,
-or Markdown cannot be supported.
+Vue, or Markdown cannot be supported.
 
 ### Configuration Formats
 
@@ -131,9 +134,9 @@ statements. Smoke tests cover this support as well.
 ### Languages
 
 Currently the plugin supports linting copyright headers in JavaScript,
-TypeScript and their JSX / TSX flavors; 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, 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 |
 |------------|---------------|---------------|--------|
@@ -141,6 +144,8 @@ or ESLint older than 9. Refer to the table below for more details.
 | TypeScript | ✅ Yes        | ✅ Yes        | ✅ Yes |
 | JSX        | ✅ Yes        | ✅ Yes        | ✅ Yes |
 | TSX        | ✅ Yes        | ✅ Yes        | ✅ Yes |
+| Vue        | ✅ Yes        | ✅ Yes        | ❌ No  |
+| Svelte     | ✅ Yes        | ✅ Yes        | ❌ No  |
 | CSS        | ❌ No         | ✅ Yes        | ❌ No  |
 | HTML       | ❌ No         | ✅ Yes        | ❌ No  |
 | Markdown   | ❌ No         | ✅ Yes        | ❌ No  |
@@ -1328,6 +1333,103 @@ export default [
 
 As with CSS, only block comments are supported - no line- or shebang comments.
 
+### Linting Vue
+
+The rule supports linting copyright notices in Vue files. The rule works with
+the _eslint-plugin-vue_ plugin and its parser.
+
+To turn on header validation for Vue files, configure the parser, the plugin,
+and the rule:
+
+```ts
+import header from "@tony.ganchev/eslint-plugin-header";
+import vueParser from "vue-eslint-parser";
+import vuePlugin from "eslint-plugin-vue";
+
+export default [
+    {
+        files: ["**/*.vue"],
+        plugins: {
+            "@tony.ganchev": header,
+            vue: vuePlugin
+        },
+        languageOptions: {
+            parser: vueParser
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: [" Copyright 2025 "]
+                    }
+                }
+            ]
+        }
+    }
+];
+```
+
+```vue
+<!-- Copyright 2025 -->
+<template>
+    <div>Hello, world!</div>
+</template>
+```
+
+As with HTML and CSS, only block comments are supported at the top of the file -
+no line- or shebang comments.
+
+### Linting Svelte
+
+The rule supports linting copyright notices in Svelte files. The rule works with
+the _eslint-plugin-svelte_ plugin and its parser.
+
+To turn on header validation for Svelte files, configure the parser and the rule:
+
+```ts
+import header from "@tony.ganchev/eslint-plugin-header";
+import svelteParser from "svelte-eslint-parser";
+import sveltePlugin from "eslint-plugin-svelte";
+
+export default [
+    {
+        files: ["**/*.svelte"],
+        plugins: {
+            "@tony.ganchev": header,
+            svelte: sveltePlugin
+        },
+        languageOptions: {
+            parser: svelteParser
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: [" Copyright 2025 "]
+                    }
+                }
+            ]
+        }
+    }
+];
+```
+
+```svelte
+<!-- Copyright 2025 -->
+<script>
+    let name = 'world';
+</script>
+
+<h1>Hello {name}!</h1>
+```
+
+As with Vue, HTML and CSS, only block comments are supported at the top of the
+file - no line- or shebang comments.
+
 ### Linting Markdown
 
 The rule supports copyright comments in Markdown syntax in both _commonmark_ and
@@ -1403,12 +1505,16 @@ _eslint-plugin-header_ and all plugins that already use the latter can migrate
 to the fork right away. At the same time, it provides improved user experience
 and windows support.
 
-eslint-plugin-headers is not a drop-in replacement. It offers additional
-features. Some of them, such as support for Vue templates do not have an
-analogue in the current version of _\@tony.ganchev/eslint-plugin-header_ while
-others such as `{year}` variable placeholders are redundant in the world of
-ESLint 9's flat, JavaScript-based configuration as [already pointed out in this
-document](#providing-to-year-in-auto-fix).
+_eslint-plugin-headers_ is not a drop-in replacement. It offers additional
+features that are not first-level use-cases for
+_\@tony.ganchev/eslint-plugin-header_. One example is support for `{year}`
+variable placeholders which are redundant with ESLint's JavaScript-based
+configuration as [already pointed out in this document](#providing-to-year-in-auto-fix).
+JSDoc support can be achieved with regular expressions and the overall
+configuration capabilities of _\@tony.ganchev/eslint-plugin-header_. It is worth
+noting that the source code of _\@tony.ganchev/eslint-plugin-header_ already
+uses JSDoc-style comments for its own header which are in turn validated using
+_\@tony.ganchev/eslint-plugin-header/header_ rule.
 
 The configuration format philosophy of the two plugin differs.
 _\@tony.ganchev/eslint-plugin-header_ supports both the legacy model inherited
@@ -1475,6 +1581,30 @@ We have prepared a detailed
 [migration guide](docs/migrate-from-license-header.md) for anyone eager to
 migrate to _\@tony.ganchev/eslint-plugin-header_.
 
+### Compared to [eslint-plugin-notice](https://github.com/earl-man/eslint-plugin-notice)
+
+_eslint-plugin-notice_ is another alternative that uses a template-based approach
+(powered by Lodash templates) to manage headers. This makes it quite powerful for
+dynamic content but also brings in more dependencies and a more complex
+configuration schema that doesn't always feel "native" to the new ESLint Flat
+Config era.
+
+Key differences:
+
+- **Philosophy**: _\@tony.ganchev/eslint-plugin-header_ focuses on a zero-bloat,
+  native ESLint feel with first-class support for Flat Config and TypeScript.
+- **ESLint 9/10**: Our plugin is built from the ground up to support the latest
+  ESLint versions and their core features.
+- **Languages**: We provide native support for linting headers in HTML, CSS,
+  and Markdown via their respective ESLint ecosystem plugins.
+- **Simplicity**: No need for external template engines or complex variable
+  mappings. Use standard JavaScript template literals in your `eslint.config.ts`
+  to handle dynamic years or other variables.
+
+We have prepared a detailed
+[migration guide](docs/migrate-from-notice.md) for anyone eager to
+migrate to _\@tony.ganchev/eslint-plugin-header_.
+
 ## Versioning
 
 The project follows standard [NPM semantic versioning policy](

package/lib/comment-parser.js

@@ -37,10 +37,8 @@ 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 Content to parse.
- * @param {Language} language The language
- * configuration.
- * @returns {[CommentType, string[]]} Comment type and
- * content.
+ * @param {Language} language The language configuration.
+ * @returns {[CommentType, string[]]} Comment type and content.
  * @throws {Error} If `commentText` starts with an unrecognized comment token.
  */
 module.exports = function commentParser(commentText, language) {

package/lib/rules/header.js

@@ -1205,13 +1205,46 @@ const headerRule = {
             }
         };
 
+        /**
+         * Tests if the source code was parsed by _@html-eslint/eslint-plugin_'s
+         * parser.
+         * @returns {boolean} `true` if the source code is parsed by the parser.
+         */
+        function isHtmlParser() {
+            return sourceCode.constructor.name === "HTMLSourceCode";
+        }
+
+        /**
+         * Tests if the source code was parsed by _vue-eslint-parser_.
+         * @returns {boolean} `true` if the source code is parsed by the parser.
+         */
+        function isVueParser() {
+            // Vue parser mimic JS parser identity but has a
+            // template section under its AST.
+            return "templateBody" in sourceCode.ast;
+        }
+
+        /**
+         * Tests if the source code was parsed by _svelte-eslint-parser_.
+         * @returns {boolean} `true` if the source code is parsed by the parser.
+         */
+        function isSvelteParser() {
+            // Svelte parser mimic JS parser identity but has an
+            // identifier in its `parserServices` section.
+            return sourceCode.parserServices.isSvelte;
+        }
+
+        /**
+         * Tests if the source code is parsed by a HTML-style language parser.
+         * @returns {boolean} `true` if the source code is parsed by a
+         * HTML-style language parser.
+         */
+        function isHtmlStyleLanguage() {
+            return isHtmlParser() || isVueParser() || isSvelteParser();
+        };
+
         const hooks = {
-            Program: () =>
-                onRootNode(
-                    sourceCode.constructor.name === "HTMLSourceCode"
-                        ? htmlStyleLanguage
-                        : jsStyleLanguage
-                ),
+            Program: () => onRootNode(isHtmlStyleLanguage() ? htmlStyleLanguage : jsStyleLanguage),
             StyleSheet: () => onRootNode(cssStyleLanguage),
             // eslint/markdown
             root: () => onRootNode(htmlStyleLanguage),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tony.ganchev/eslint-plugin-header",
-  "version": "3.4.0",
-  "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, TypeScript, CSS, HTML, and Markdown files. Supports oxlint.",
+  "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.",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {
@@ -32,12 +32,16 @@
     "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",
     "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-eslint": "^8.58.0"
+    "typescript-eslint": "^8.58.0",
+    "vue-eslint-parser": "^10.4.0"
   },
   "peerDependencies": {
     "eslint": ">=7.7.0"
@@ -74,7 +78,13 @@
     "oxc",
     "react",
     "source-header",
-    "typescript"
+    "svelte",
+    "sveltejs",
+    "svelte-js",
+    "typescript",
+    "vue",
+    "vuejs",
+    "vue-js"
   ],
   "repository": {
     "type": "git",

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":"AA6CiB,uCAPN,MAAM,YACN,QAAQ,GAEN,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC,CA4BnC;;8BAxCyC,gBAAgB;iCAAhB,gBAAgB"}
+{"version":3,"file":"comment-parser.d.ts","sourceRoot":"","sources":["../../lib/comment-parser.js"],"names":[],"mappings":"AA2CiB,uCALN,MAAM,YACN,QAAQ,GACN,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC,CA2BnC;;8BAtCyC,gBAAgB;iCAAhB,gBAAgB"}

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,CAiPxB;AA/nBF,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;;;;;;;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"}