@tony.ganchev/eslint-plugin-header 3.1.3 → 3.1.4

package/.github/workflows/npm-publish.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 10
+          node-version: 24
       - run: npm ci
       - run: npm test
 
@@ -25,7 +25,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 24
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm publish

package/.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Use Node.js
       uses: actions/setup-node@v1
       with:
-        node-version: '14.x'
+        node-version: '24.x'
     - name: Install dependencies
       run: npm ci
     - run: npm test

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 3.1.3
+
+* Detailed ESLint 9 validation schema.
+
+# 3.1.2
+
+* Support ESLint 9.
+
 # 3.1.1
 
 * Fix detecting header below shebang comment with Windows EOL (#30)

package/eslint.config.mjs

@@ -0,0 +1,168 @@
+import { defineConfig } from "eslint/config";
+import globals from "globals";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+import jsdoc from "eslint-plugin-jsdoc";
+
+const filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
+const compat = new FlatCompat({
+    baseDirectory: dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+const jsRules = {
+    extends: [
+        ...compat.extends("eslint:recommended"),
+    ],
+    rules: {
+        indent: [2, 4, {
+            SwitchCase: 1,
+        }],
+
+        "brace-style": [2, "1tbs"],
+
+        camelcase: [2, {
+            properties: "never",
+        }],
+
+        "callback-return": [2, ["cb", "callback", "next"]],
+        "comma-spacing": 2,
+        "comma-style": [2, "last"],
+        "consistent-return": 2,
+        curly: [2, "all"],
+        "default-case": 2,
+
+        "dot-notation": [2, {
+            allowKeywords: true,
+        }],
+
+        "eol-last": 2,
+        eqeqeq: 2,
+        "func-style": [2, "declaration"],
+        "guard-for-in": 2,
+
+        "key-spacing": [2, {
+            beforeColon: false,
+            afterColon: true,
+        }],
+
+        "new-cap": 2,
+        "new-parens": 2,
+        "no-alert": 2,
+        "no-array-constructor": 2,
+        "no-caller": 2,
+        "no-console": 0,
+        "no-delete-var": 2,
+        "no-eval": 2,
+        "no-extend-native": 2,
+        "no-extra-bind": 2,
+        "no-fallthrough": 2,
+        "no-floating-decimal": 2,
+        "no-implied-eval": 2,
+        "no-invalid-this": 2,
+        "no-iterator": 2,
+        "no-label-var": 2,
+        "no-labels": 2,
+        "no-lone-blocks": 2,
+        "no-loop-func": 2,
+        "no-mixed-spaces-and-tabs": [2, false],
+        "no-multi-spaces": 2,
+        "no-multi-str": 2,
+        "no-native-reassign": 2,
+        "no-nested-ternary": 2,
+        "no-new": 2,
+        "no-new-func": 2,
+        "no-new-object": 2,
+        "no-new-wrappers": 2,
+        "no-octal": 2,
+        "no-octal-escape": 2,
+        "no-process-exit": 2,
+        "no-proto": 2,
+        "no-redeclare": 2,
+        "no-return-assign": 2,
+        "no-script-url": 2,
+        "no-sequences": 2,
+        "no-shadow": 2,
+        "no-shadow-restricted-names": 2,
+        "no-spaced-func": 2,
+        "no-trailing-spaces": 2,
+        "no-undef": 2,
+        "no-undef-init": 2,
+        "no-undefined": 2,
+        "no-underscore-dangle": 2,
+        "no-unused-expressions": 2,
+
+        "no-unused-vars": [2, {
+            vars: "all",
+            args: "after-used",
+        }],
+
+        "no-use-before-define": 2,
+        "no-with": 2,
+        quotes: [2, "double"],
+        radix: 2,
+        semi: 2,
+
+        "semi-spacing": [2, {
+            before: false,
+            after: true,
+        }],
+
+        "keyword-spacing": [2, {
+            after: true,
+        }],
+
+        "space-before-blocks": 2,
+        "space-before-function-paren": [2, "never"],
+        "space-infix-ops": 2,
+
+        "space-unary-ops": [2, {
+            words: true,
+            nonwords: false,
+        }],
+
+        "spaced-comment": [2, "always", {
+            exceptions: ["-"],
+        }],
+
+        strict: [2, "global"],
+
+        "wrap-iife": 2,
+        yoda: [2, "never"],
+        "no-catch-shadow": 0,
+        "no-mixed-requires": 2,
+        "no-new-require": 2,
+        "no-path-concat": 2,
+        "global-strict": [0, "always"],
+        "handle-callback-err": [2, "err"],
+    }
+};
+
+export default defineConfig([
+    jsdoc.configs["flat/recommended"],
+    {
+        files: ["lib/**/*.js"],
+        languageOptions: {
+            sourceType: "commonjs",
+            globals: {
+                ...globals.node,
+            },
+        },
+        ...jsRules,
+    },
+    {
+        files: ["tests/**/*.js"],
+        languageOptions: {
+            sourceType: "script",
+            globals: {
+                ...globals.node,
+                ...globals.mocha,
+            },
+        },
+        ...jsRules,
+    },
+]);

package/lib/rules/header.js

@@ -215,7 +215,7 @@ module.exports = {
     },
     create: function(context) {
         var options = context.options;
-        var numNewlines = options.length > 2 ? options[2] : 1;
+        var numNewlines = options.length > 2 && typeof options[2] === "number" ? options[2] : 1;
         var eol = getEOL(options);
 
         // If just one option then read comment from file

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tony.ganchev/eslint-plugin-header",
-  "version": "3.1.3",
-  "description": "ESLint plugin to ensure that files begin with given comment",
+  "version": "3.1.4",
+  "description": "ESLint plugin to ensure files begin with a given comment, usually a copyright or license notice.",
   "main": "index.js",
   "scripts": {
     "test": "npm run lint && npm run unit",
@@ -9,8 +9,11 @@
     "lint": "eslint ."
   },
   "devDependencies": {
-    "eslint": "^7.7.0",
-    "mocha": "^8.1.1"
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.32.0",
+    "eslint": "^9.32.0",
+    "eslint-plugin-jsdoc": "^52.0.4",
+    "mocha": "^11.7.1"
   },
   "peerDependencies": {
     "eslint": ">=7.7.0"

package/.eslintrc.yml

@@ -1,94 +0,0 @@
-root: true
-
-env:
-    node: true
-
-extends:
-    "eslint:recommended"
-
-rules:
-    indent: [2, 4, {SwitchCase: 1}]
-    brace-style: [2, "1tbs"]
-    camelcase: [2, { properties: "never" }]
-    callback-return: [2, ["cb", "callback", "next"]]
-    comma-spacing: 2
-    comma-style: [2, "last"]
-    consistent-return: 2
-    curly: [2, "all"]
-    default-case: 2
-    dot-notation: [2, { allowKeywords: true }]
-    eol-last: 2
-    eqeqeq: 2
-    func-style: [2, "declaration"]
-    guard-for-in: 2
-    key-spacing: [2, { beforeColon: false, afterColon: true }]
-    new-cap: 2
-    new-parens: 2
-    no-alert: 2
-    no-array-constructor: 2
-    no-caller: 2
-    no-console: 0
-    no-delete-var: 2
-    no-eval: 2
-    no-extend-native: 2
-    no-extra-bind: 2
-    no-fallthrough: 2
-    no-floating-decimal: 2
-    no-implied-eval: 2
-    no-invalid-this: 2
-    no-iterator: 2
-    no-label-var: 2
-    no-labels: 2
-    no-lone-blocks: 2
-    no-loop-func: 2
-    no-mixed-spaces-and-tabs: [2, false]
-    no-multi-spaces: 2
-    no-multi-str: 2
-    no-native-reassign: 2
-    no-nested-ternary: 2
-    no-new: 2
-    no-new-func: 2
-    no-new-object: 2
-    no-new-wrappers: 2
-    no-octal: 2
-    no-octal-escape: 2
-    no-process-exit: 2
-    no-proto: 2
-    no-redeclare: 2
-    no-return-assign: 2
-    no-script-url: 2
-    no-sequences: 2
-    no-shadow: 2
-    no-shadow-restricted-names: 2
-    no-spaced-func: 2
-    no-trailing-spaces: 2
-    no-undef: 2
-    no-undef-init: 2
-    no-undefined: 2
-    no-underscore-dangle: 2
-    no-unused-expressions: 2
-    no-unused-vars: [2, {vars: "all", args: "after-used"}]
-    no-use-before-define: 2
-    no-with: 2
-    quotes: [2, "double"]
-    radix: 2
-    semi: 2
-    semi-spacing: [2, {before: false, after: true}]
-    keyword-spacing: [2, {"after": true }]
-    space-before-blocks: 2
-    space-before-function-paren: [2, "never"]
-    space-infix-ops: 2
-    space-unary-ops: [2, {words: true, nonwords: false}]
-    spaced-comment: [2, "always", { exceptions: ["-"]}]
-    strict: [2, "global"]
-    valid-jsdoc: [2, { prefer: { "return": "returns"}}]
-    wrap-iife: 2
-    yoda: [2, "never"]
-
-    # Previously on by default in node environment
-    no-catch-shadow: 0
-    no-mixed-requires: 2
-    no-new-require: 2
-    no-path-concat: 2
-    global-strict: [0, "always"]
-    handle-callback-err: [2, "err"]