@tony.ganchev/eslint-plugin-header 3.1.13 → 3.2.1

package/README.md

@@ -51,53 +51,66 @@ statements.
 
 ## Usage
 
-This rule takes between 1 and 4 arguments after the rule validation severity.
-
-The configuration can take any of the following forms:
-
-- File-based Configuration
-  - `[<severity>, "<file>"]` - read the header template from a file.
-  - `[<severity>, "<file>", {<settings>}]` - read the header template from a
-    file with additional settings.
-- Inline Configuration
-  - `"<severity>", "<comment-type>", <header-contents>` - define the header
-    contents inline.
-  - `[<severity>, "<comment-type>", <header-contents>, {<settings>}]` - define
-    the header contents inline and pass additional settings.
-  - `[<severity>, "<comment-type>", <header-contents>, <n-empty-lines>]` -
-    define the header contents inline and an expected number of empty lines
-    after the header.
-  - `[<severity>, "<comment-type>", <header-contents>, <n-empty-lines>,
-    {<settings>}]` - define the header contents inline and an expected number of
-    empty lines after the header and pass additional settings.
-
-For TypesScript-based flat ESLint configuration, the following type is provided:
+The plugin and its _header_ rule goes through evolution of its configuration in
+the 3.2.x release. We introduced a new single object-based configuration format
+that is easier to evolve in the future to add more capabilities.
+
+The legacy configuration format inherited from
+[eslint-plugin-header](https://github.com/Stuk/eslint-plugin-header) is still
+supported and you can learn how to use it in a
+[dedicated document](legacy-config.md). For information on how to switch from
+the legacy configuration format to the new style, follow our
+[migration guide](migrate-config.md). The current document from this point on
+will cover only the new configuration format.
+
+This _header_ rule takes a single object as configuration, after the severity
+level. At the very least, the object should contain a `header` field describing
+the expected header to match in the source files.
+
+For TypesScript-based flat ESLint configuration, two types are provided:
 
 - `HeaderRuleConfig` defines the overall rule configuration for the `header`
   rule and includes severity level and supports both the modern object-based
   configuration and the legacy array-based configuration.
+- `HeaderOptions` helper type that defines the structure of the configuration
+  object used in the modern configuration style that is used in this document.
+  It can be used to either simplify auto-completion since this type is not mixed
+  with a large number of named tuple types, or it can be used when the config
+  object is defined outside of the definition of a specific rule.
 
 ### File-based Configuration
 
-In this configuration mode, the first argument is a string pointing to a JS
-file containing the header contents. The rule would expect an exact match to be
-found in the source code.
+In this configuration mode, the header template is read from a file.
+
+_eslint.config.ts_:
 
-The second argument can be a settings object that will be covered later in this
-document.
+```ts
+import header, {
+    HeaderOptions, HeaderRuleConfig
+} from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
 
-```json
-{
-    "plugins": [
-        "header"
-    ],
-    "rules": {
-        "header/header": [2, "config/header.js"]
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        file: "config/header.js"
+                    }
+                } as HeaderOptions
+            ] as HeaderRuleConfig
+        }
     }
-}
+]);
 ```
 
-config/header.js:
+_config/header.js_:
 
 ```js
 // Copyright 2015
@@ -110,14 +123,16 @@ tree then the header file will not be found.
 
 ### Inline Configuration
 
-The inline configuration expects at least two arguments to be given:
+In this configuration mode, the matching rules for the header are given inline.
+The `header` field should contain the following nested properties:
 
-- _comment-type_ which is either `"block"` or `"line"` to indicate what style
+- `commentType` which is either `"block"` or `"line"` to indicate what style
   of comment should be used.
-- _header-contents_ which defines the lines of the header. It can be either a
+- `line` which defines the lines of the header. It can be either a
   single multiline string / regular expression with the full contents of the
   header comment or an array with comment lines or regular expressions matching
-  each line.
+  each line. It can also include template replacement strings to enable ESLint's
+  auto-fix capabilities.
 
 #### Header Contents Configuration
 
@@ -134,16 +149,29 @@ All of the following configurations will match the header:
 
 - **Single string**:
 
-    ```json
-    {
-        "rules": {
-            "header/header": [
-                2,
-                "block",
-                "\n * Copyright (c) 2015\n * My Company\n "
-            ]
+    ```ts
+    import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+    import { defineConfig } from "eslint/config";
+
+    export default defineConfig([
+        {
+            files: ["**/*.js"],
+            plugins: {
+                "@tony.ganchev": header
+            },
+            rules: {
+                "@tony.ganchev/header": [
+                    "error",
+                    {
+                        header: {
+                            commentType: "block",
+                            lines: ["\n * Copyright (c) 2015\n * My Company\n "]
+                        }
+                    } as HeaderOptions
+                ]
+            }
         }
-    }
+    ]);
     ```
 
     Note that the above would work for both Windows and POSIX systems even
@@ -159,61 +187,164 @@ All of the following configurations will match the header:
 
 - **Single regular expression**:
 
-    ```json
-    {
-        "rules": {
-            "header/header": [
-                2,
-                "block",
-                {
-                    "pattern":
-                        "\\n \\* Copyright \\(c\\) 2015\\n \\* My Company\\n "
-                }
-            ]
+    You can match the whole header with a regular expression. To do it, simply
+    pass a `RegExp` object in place of a string.
+
+    ```ts
+    import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+    import { defineConfig } from "eslint/config";
+
+    export default defineConfig([
+        {
+            files: ["**/*.js"],
+            plugins: {
+                "@tony.ganchev": header
+            },
+            rules: {
+                "@tony.ganchev/header": [
+                    "error",
+                    {
+                        header: {
+                            commentType: "block",
+                            lines: [
+                                /\n \* Copyright \(c\) 2015\n \* Company\n /
+                            ]
+                        }
+                    } as HeaderOptions
+                ]
+            }
         }
-    }
+    ]);
+    ```
+
+    If you still use hierarchical configuration, you can define the regular
+    expression as a string.
+
+    ```ts
+    import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+    import { defineConfig } from "eslint/config";
+
+    export default defineConfig([
+        {
+            files: ["**/*.js"],
+            plugins: {
+                "@tony.ganchev": header
+            },
+            rules: {
+                "@tony.ganchev/header": [
+                    "error",
+                    {
+                        header: {
+                            commentType: "block",
+                            lines: [
+                                { pattern: "\\n \\* Copyright \\(c\\) 2015"
+                                    + "\\n \\* My Company\\n "}
+                            ]
+                        }
+                    } as HeaderOptions
+                ]
+            }
+        }
+    ]);
     ```
 
     Notice the double escaping of the braces. Since these pattern strings into
     `RegExp` objects, the backslashes need to be present in the string instead
     of disappear as escape characters.
 
+    You can pass a `RegExp` object to the `pattern` field. This is necessary if
+    you want to add an aut-fix for the line as we will explain further in this
+    document.
+
+    ```ts
+    import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+    import { defineConfig } from "eslint/config";
+
+    export default defineConfig([
+        {
+            files: ["**/*.js"],
+            plugins: {
+                "@tony.ganchev": header
+            },
+            rules: {
+                "@tony.ganchev/header": [
+                    "error",
+                    {
+                        header: {
+                            commentType: "block",
+                            lines: [
+                                { pattern: /Copyright \(c\) 20\d{2}/ }
+                            ]
+                        }
+                    } as HeaderOptions
+                ]
+            }
+        }
+    ]);
+    ```
+
 - **Array of strings**:
 
-    ```json
-    {
-        "rules": {
-            "header/header": [
-                2,
-                "block",
-                [
-                    "",
-                    " * Copyright (c) 2015",
-                    " * My Company",
-                    " "
+    ```ts
+    import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+    import { defineConfig } from "eslint/config";
+
+    export default defineConfig([
+        {
+            files: ["**/*.js"],
+            plugins: {
+                "@tony.ganchev": header
+            },
+            rules: {
+                "@tony.ganchev/header": [
+                    "error",
+                    {
+                        header: {
+                            commentType: "block",
+                            lines: [
+                                "",
+                                " * Copyright (c) 2015",
+                                " * My Company",
+                                " "
+                            ]
+                        }
+                    } as HeaderOptions
                 ]
-            ]
+            }
         }
-    }
+    ]);
     ```
 
 - **Array of strings and/or patterns**:
 
-    ```json
-    {
-        "rules": {
-            "header/header": [
-                2,
-                "block",
-                [
-                    "",
-                    { "pattern": " \\* Copyright \\(c\\) 2015" },
-                    " * My Company",
-                    " "
+    ```ts
+    import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+    import { defineConfig } from "eslint/config";
+
+    export default defineConfig([
+        {
+            files: ["**/*.js"],
+            plugins: {
+                "@tony.ganchev": header
+            },
+            rules: {
+                "@tony.ganchev/header": [
+                    "error",
+                    {
+                        header: {
+                            commentType: "block",
+                            lines: [
+                                "",
+                                / \* Copyright \(c\) 2015/,
+                                " * My Company",
+                                " "
+                            ]
+                        }
+                    } as HeaderOptions
                 ]
-            ]
+            }
         }
-    }
+    ]);
     ```
 
 Regular expressions allow for a number of improvements in the maintainability
@@ -241,21 +372,34 @@ support:
 
 We can use a regular expression to support all of these cases for your header:
 
-```json
-{
-    "rules": {
-        "header/header": [
-            2,
-            "block",
-            [
-                "",
-                { "pattern": " \\* Copyright \\(c\\) (\\d{4}-)?\\d{4}" },
-                " * My Company",
-                " "
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: [
+                            "",
+                            / \* Copyright \(c\) (\d{4}-)?\d{4}/,
+                            " * My Company",
+                            " "
+                        ]
+                    }
+                } as HeaderOptions
             ]
-        ]
+        }
     }
-}
+]);
 ```
 
 Note on auto-fixes i.e. `eslint --fix`: whenever strings are used to define the
@@ -264,22 +408,35 @@ to replace a header comment that did not pass validation. This is not possible
 with regular expressions. For regular expression pattern-objects, a second
 property `template` adds a replacement string.
 
-```json
-{
-    "rules": {
-        "header/header": [
-            2,
-            "line",
-            [
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
                 {
-                    "pattern": " Copyright \\(c\\) (\\d{4}-)?\\d{4}",
-                    "template": " Copyright 2025",
-                },
-                " My Company"
+                    header: {
+                        commentType: "line",
+                        lines: [
+                            {
+                                pattern: / Copyright \(c\) (\d{4}-)?\d{4}/,
+                                template: " Copyright 2025",
+                            },
+                            " My Company"
+                        ]
+                    }
+                } as HeaderOptions
             ]
-        ]
+        }
     }
-}
+]);
 ```
 
 There are a number of things to consider:
@@ -297,23 +454,35 @@ number of newlines that are enforced after the header.
 
 Zero newlines:
 
-```json
-{
-    "plugins": [
-        "header"
-    ],
-    "rules": {
-        "header/header": [
-            2,
-            "block",
-            [
-                " Copyright now",
-                "My Company "
-            ],
-            0
-        ]
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: [
+                            " Copyright now",
+                            "My Company "
+                        ],
+                    },
+                    trailingEmptyLines: {
+                        minimum: 0
+                    }
+                } as HeaderOptions
+            ]
+        }
     }
-}
+]);
 ```
 
 ```js
@@ -323,23 +492,35 @@ My Company */ console.log(1)
 
 One newline (default):
 
-```json
-{
-    "plugins": [
-        "header"
-    ],
-    "rules": {
-        "header/header": [
-            2,
-            "block",
-            [
-                " Copyright now",
-                "My Company "
-            ],
-            1
-        ]
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: [
+                            " Copyright now",
+                            "My Company "
+                        ],
+                    },
+                    trailingEmptyLines: {
+                        minimum: 1
+                    }
+                } as HeaderOptions
+            ]
+        }
     }
-}
+]);
 ```
 
 ```js
@@ -350,23 +531,35 @@ console.log(1)
 
 Two newlines:
 
-```json
-{
-    "plugins": [
-        "header"
-    ],
-    "rules": {
-        "header/header": [
-            2,
-            "block",
-            [
-                " Copyright now",
-                "My Company "
-            ],
-            2
-        ]
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: [
+                            " Copyright now",
+                            "My Company "
+                        ]
+                    },
+                    trailingEmptyLines: {
+                        minimum: 2
+                    }
+                } as HeaderOptions
+            ]
+        }
     }
-}
+]);
 ```
 
 ```js
@@ -382,36 +575,99 @@ The rule works with both Unix/POSIX and Windows line endings. For ESLint
 `--fix`, the rule will use the line ending format of the current operating
 system (via Node's `os` package). This setting can be overwritten as follows:
 
-```json
-"rules": {
-    "header/header": [
-        2,
-        "block",
-        [
-            "Copyright 2018",
-            "My Company"
-        ],
-        {
-            "lineEndings": "windows"
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: [
+                            "Copyright 2018",
+                            "My Company"
+                        ]
+                    },
+                    lineEndings: "windows"
+                } as HeaderOptions
+            ]
         }
-    ]
-}
+    }
+]);
 ```
 
 Possible values are `"unix"` for `\n` and `"windows"` for `\r\n` line endings.
+The default value is `"os"` which means assume the system-specific line endings.
 
 ## Examples
 
 The following examples are all valid.
 
-`"block", "Copyright 2015, My Company"`:
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: ["Copyright 2015, My Company"]
+                    }
+                } as HeaderOptions
+            ]
+        }
+    }
+]);
+```
 
 ```js
 /*Copyright 2015, My Company*/
 console.log(1);
 ```
 
-`"line", ["Copyright 2015", "My Company"]]`:
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "line",
+                        lines: [
+                            "Copyright 2015",
+                            "My Company"
+                        ]
+                    }
+                } as HeaderOptions
+            ]
+        }
+    }
+]);
+```
 
 ```js
 //Copyright 2015
@@ -419,7 +675,33 @@ console.log(1);
 console.log(1)
 ```
 
-`"line", [{pattern: "^Copyright \\d{4}$"}, {pattern: "^My Company$"}]]`:
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "line",
+                        lines: [
+                            /^Copyright \d{4}$/,
+                            /^My Company$/
+                        ]
+                    }
+                } as HeaderOptions
+            ]
+        }
+    }
+]);
+```
 
 ```js
 //Copyright 2017
@@ -429,13 +711,34 @@ console.log(1)
 
 With more decoration:
 
-```json
-"header/header": [2, "block", [
-    "************************",
-    " * Copyright 2015",
-    " * My Company",
-    " ************************"
-]]
+```ts
+import header, { HeaderOptions } from "@tony.ganchev/eslint-plugin-header";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    {
+        files: ["**/*.js"],
+        plugins: {
+            "@tony.ganchev": header
+        },
+        rules: {
+            "@tony.ganchev/header": [
+                "error",
+                {
+                    header: {
+                        commentType: "block",
+                        lines: [
+                            "************************",
+                            " * Copyright 2015",
+                            " * My Company",
+                            " ************************"
+                        ]
+                    }
+                } as HeaderOptions
+            ]
+        }
+    }
+]);
 ```
 
 ```js