@tony.ganchev/eslint-plugin-header 3.1.1

package/.eslintrc.yml

@@ -0,0 +1,94 @@
+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"]

package/.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '14.x'
+    - name: Install dependencies
+      run: npm ci
+    - run: npm test

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# 3.1.1
+
+* Fix detecting header below shebang comment with Windows EOL (#30)
+
+# 3.1.0
+
+* Update to eslint 7.7.0
+* Add a third option to specify number of linebreaks after the header. (#29)
+
+# 3.0.0
+
+* Allow regexp in multiline arrays (#23)
+* Add `template` option for regexps, for `eslint --fix` (#23)
+* Update eslint to v5.12.0 (#19)
+
+# 2.0.0
+
+* Use the OS's line endings (`\n` on *nix, `\r\n` on Windows) when parsing and fixing comments. This can be configured with the `lineEndings` option. Major version bump as this could be a breaking change for projects.
+
+# 1.2.0
+
+* Add auto fix functionality (eslint `--fix` option) (#12)
+
+# 1.1.0
+
+* Ignore shebangs above header comments to support ESLint 4+ (#11)
+
+# 1.0.0
+
+* Allow RegExp patterns in addition to strings (#2, #4)
+* Fix line comment length mismatch issue (#3)
+
+# 0.1.0
+
+* Add config option to read header from file
+
+# 0.0.2
+
+* Initial release

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2015-present Stuart Knightley 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.

package/README.md

@@ -0,0 +1,207 @@
+This is a fork of https://github.com/Stuk/eslint-plugin-header intended to make the plugin work with ESLint v9
+
+eslint-plugin-header
+====================
+
+ESLint plugin to ensure that files begin with given comment.
+
+Often you will want to have a copyright notice at the top of every file. This ESLint plugin checks that the first comment in every file has the contents defined in the rule settings.
+
+## Usage
+
+This rule takes 1, 2 or 3 arguments with an optional settings object.
+
+### 1 argument
+
+In the 1 argument form the argument is the filename of a file that contains the comment(s) that should appear at the top of every file:
+
+```json
+{
+    "plugins": [
+        "header"
+    ],
+    "rules": {
+        "header/header": [2, "config/header.js"]
+    }
+}
+```
+
+config/header.js:
+
+```js
+// Copyright 2015
+// My company
+```
+
+Due to limitations in eslint plugins, the file is read relative to the working directory that eslint is executed in. If you run eslint from elsewhere in your tree then the header file will not be found.
+
+### 2 arguments
+
+In the 2 argument form the first must be either `"block"` or `"line"` to indicate what style of comment should be used. The second is either a string (including newlines) of the comment, or an array of each line of the comment.
+
+```json
+{
+    "plugins": [
+        "header"
+    ],
+    "rules": {
+        "header/header": [2, "block", "Copyright 2015\nMy Company"]
+    }
+}
+```
+
+### 3 arguments
+
+The optional third argument which defaults to 1 specifies the number of newlines that are enforced after the header.
+
+Zero newlines:
+```json
+{
+    "plugins": [
+        "header"
+    ],
+    "rules": {
+        "header/header": [2, "block", [" Copyright now","My Company "], 0]
+    }
+}
+```
+```js
+/* Copyright now
+My Company */ console.log(1)
+```
+
+One newline (default)
+```json
+{
+    "plugins": [
+        "header"
+    ],
+    "rules": {
+        "header/header": [2, "block", [" Copyright now","My Company "], 1]
+    }
+}
+```
+```js
+/* Copyright now
+My Company */
+console.log(1)
+```
+
+two newlines
+```json
+{
+    "plugins": [
+        "header"
+    ],
+    "rules": {
+        "header/header": [2, "block", [" Copyright now","My Company "], 2]
+    }
+}
+```
+```js
+/* Copyright now
+My Company */
+
+console.log(1)
+```
+
+#### Regular expressions
+
+Instead of a string to be checked for exact matching you can also supply a regular expression. Be aware that you have to escape backslashes:
+
+```json
+{
+    "plugins": [
+        "header"
+    ],
+    "rules": {
+        "header/header": [2, "block", [
+            {"pattern": " Copyright \\d{4}"},
+            "My Company"
+        ]]
+    }
+}
+```
+
+This would match:
+
+```js
+/* Copyright 2808
+My Company*/
+```
+
+When you use a regular expression `pattern`, you can also provide a `template` property, to provide the comment value when using `eslint --fix`:
+
+```json
+{
+    "plugins": [
+        "header"
+    ],
+    "rules": {
+        "header/header": [2, "block", [
+            {"pattern": " Copyright \\d{4}", "template": " Copyright 2019"}, 
+            "My Company"
+        ]]
+    }
+}
+```
+
+### Line Endings
+
+The rule works with both unix and windows line endings. For ESLint `--fix`, the rule will use the line ending format of the current operating system (via the node `os` package). This setting can be overwritten as follows:
+```json
+"rules": {
+    "header/header": [2, "block", ["Copyright 2018", "My Company"], {"lineEndings": "windows"}]
+}
+```
+Possible values are `unix` for `\n` and `windows` for `\r\n` line endings.
+
+## Examples
+
+The following examples are all valid.
+
+`"block", "Copyright 2015, My Company"`:
+
+```js
+/*Copyright 2015, My Company*/
+console.log(1);
+```
+
+`"line", ["Copyright 2015", "My Company"]]`:
+
+```js
+//Copyright 2015
+//My Company
+console.log(1)
+```
+
+`"line", [{pattern: "^Copyright \\d{4}$"}, {pattern: "^My Company$"}]]`:
+
+```js
+//Copyright 2017
+//My Company
+console.log(1)
+```
+
+### With more decoration
+
+```json
+"header/header": [2, "block", [
+    "************************",
+    " * Copyright 2015",
+    " * My Company",
+    " ************************"
+]
+```
+
+```js
+/*************************
+ * Copyright 2015
+ * My Company
+ *************************/
+ console.log(1);
+```
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+module.exports = {
+    rules: {
+        "header": require("./lib/rules/header")
+    },
+    rulesConfig: {
+        "header": 0
+    }
+};

package/lib/comment-parser.js

@@ -0,0 +1,24 @@
+"use strict";
+
+// This is a really simple and dumb parser, that looks just for a
+// single kind of comment. It won't detect multiple block comments.
+
+module.exports = function commentParser(text) {
+    text = text.trim();
+
+    if (text.substr(0, 2) === "//") {
+        return [
+            "line",
+            text.split(/\r?\n/).map(function(line) {
+                return line.substr(2);
+            })
+        ];
+    } else if (
+        text.substr(0, 2) === "/*" &&
+        text.substr(-2) === "*/"
+    ) {
+        return ["block", text.substring(2, text.length - 2)];
+    } else {
+        throw new Error("Could not parse comment file: the file must contain either just line comments (//) or a single block comment (/* ... */)");
+    }
+};

package/lib/rules/header.js

@@ -0,0 +1,265 @@
+"use strict";
+
+var fs = require("fs");
+var commentParser = require("../comment-parser");
+var os = require("os");
+
+function isPattern(object) {
+    return typeof object === "object" && Object.prototype.hasOwnProperty.call(object, "pattern");
+}
+
+function match(actual, expected) {
+    if (expected.test) {
+        return expected.test(actual);
+    } else {
+        return expected === actual;
+    }
+}
+
+function excludeShebangs(comments) {
+    return comments.filter(function(comment) {
+        return comment.type !== "Shebang";
+    });
+}
+
+// Returns either the first block comment or the first set of line comments that
+// are ONLY separated by a single newline. Note that this does not actually
+// check if they are at the start of the file since that is already checked by
+// hasHeader().
+function getLeadingComments(context, node) {
+    var all = excludeShebangs(context.getSourceCode().getAllComments(node.body.length ? node.body[0] : node));
+    if (all[0].type.toLowerCase() === "block") {
+        return [all[0]];
+    }
+    for (var i = 1; i < all.length; ++i) {
+        var txt = context.getSourceCode().getText().slice(all[i - 1].range[1], all[i].range[0]);
+        if (!txt.match(/^(\r\n|\r|\n)$/)) {
+            break;
+        }
+    }
+    return all.slice(0, i);
+}
+
+function genCommentBody(commentType, textArray, eol, numNewlines) {
+    var eols = eol.repeat(numNewlines);
+    if (commentType === "block") {
+        return "/*" + textArray.join(eol) + "*/" + eols;
+    } else {
+        return "//" + textArray.join(eol + "//") + eols;
+    }
+}
+
+function genCommentsRange(context, comments, eol) {
+    var start = comments[0].range[0];
+    var end = comments.slice(-1)[0].range[1];
+    if (context.getSourceCode().text[end] === eol) {
+        end += eol.length;
+    }
+    return [start, end];
+}
+
+function genPrependFixer(commentType, node, headerLines, eol, numNewlines) {
+    return function(fixer) {
+        return fixer.insertTextBefore(
+            node,
+            genCommentBody(commentType, headerLines, eol, numNewlines)
+        );
+    };
+}
+
+function genReplaceFixer(commentType, context, leadingComments, headerLines, eol, numNewlines) {
+    return function(fixer) {
+        return fixer.replaceTextRange(
+            genCommentsRange(context, leadingComments, eol),
+            genCommentBody(commentType, headerLines, eol, numNewlines)
+        );
+    };
+}
+
+function findSettings(options) {
+    var lastOption = options.length > 0 ? options[options.length - 1] : null;
+    if (typeof lastOption === "object" && !Array.isArray(lastOption) && lastOption !== null
+        && !Object.prototype.hasOwnProperty.call(lastOption, "pattern")) {
+        return lastOption;
+    }
+    return null;
+}
+
+function getEOL(options) {
+    var settings = findSettings(options);
+    if (settings && settings.lineEndings === "unix") {
+        return "\n";
+    }
+    if (settings && settings.lineEndings === "windows") {
+        return "\r\n";
+    }
+    return os.EOL;
+}
+
+function hasHeader(src) {
+    if (src.substr(0, 2) === "#!") {
+        var m = src.match(/(\r\n|\r|\n)/);
+        if (m) {
+            src = src.slice(m.index + m[0].length);
+        }
+    }
+    return src.substr(0, 2) === "/*" || src.substr(0, 2) === "//";
+}
+
+function matchesLineEndings(src, num) {
+    for (var j = 0; j < num; ++j) {
+        var m = src.match(/^(\r\n|\r|\n)/);
+        if (m) {
+            src = src.slice(m.index + m[0].length);
+        } else {
+            return false;
+        }
+    }
+    return true;
+}
+
+module.exports = {
+    meta: {
+        type: "layout",
+        fixable: "whitespace",
+        schema: false
+    },
+    create: function(context) {
+        var options = context.options;
+        var numNewlines = options.length > 2 ? options[2] : 1;
+        var eol = getEOL(options);
+
+        // If just one option then read comment from file
+        if (options.length === 1 || (options.length === 2 && findSettings(options))) {
+            var text = fs.readFileSync(context.options[0], "utf8");
+            options = commentParser(text);
+        }
+
+        var commentType = options[0].toLowerCase();
+        var headerLines, fixLines = [];
+        // If any of the lines are regular expressions, then we can't
+        // automatically fix them. We set this to true below once we
+        // ensure none of the lines are of type RegExp
+        var canFix = false;
+        if (Array.isArray(options[1])) {
+            canFix = true;
+            headerLines = options[1].map(function(line) {
+                var isRegex = isPattern(line);
+                // Can only fix regex option if a template is also provided
+                if (isRegex && !line.template) {
+                    canFix = false;
+                }
+                fixLines.push(line.template || line);
+                return isRegex ? new RegExp(line.pattern) : line;
+            });
+        } else if (isPattern(options[1])) {
+            var line = options[1];
+            headerLines = [new RegExp(line.pattern)];
+            fixLines.push(line.template || line);
+            // Same as above for regex and template
+            canFix = !!line.template;
+        } else {
+            canFix = true;
+            headerLines = options[1].split(/\r?\n/);
+            fixLines = headerLines;
+        }
+
+        return {
+            Program: function(node) {
+                if (!hasHeader(context.getSourceCode().getText())) {
+                    context.report({
+                        loc: node.loc,
+                        message: "missing header",
+                        fix: genPrependFixer(commentType, node, fixLines, eol, numNewlines)
+                    });
+                } else {
+                    var leadingComments = getLeadingComments(context, node);
+
+                    if (!leadingComments.length) {
+                        context.report({
+                            loc: node.loc,
+                            message: "missing header",
+                            fix: canFix ? genPrependFixer(commentType, node, fixLines, eol, numNewlines) : null
+                        });
+                    } else if (leadingComments[0].type.toLowerCase() !== commentType) {
+                        context.report({
+                            loc: node.loc,
+                            message: "header should be a {{commentType}} comment",
+                            data: {
+                                commentType: commentType
+                            },
+                            fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                        });
+                    } else {
+                        if (commentType === "line") {
+                            if (leadingComments.length < headerLines.length) {
+                                context.report({
+                                    loc: node.loc,
+                                    message: "incorrect header",
+                                    fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                                });
+                                return;
+                            }
+                            for (var i = 0; i < headerLines.length; i++) {
+                                if (!match(leadingComments[i].value, headerLines[i])) {
+                                    context.report({
+                                        loc: node.loc,
+                                        message: "incorrect header",
+                                        fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                                    });
+                                    return;
+                                }
+                            }
+
+                            var postLineHeader = context.getSourceCode().text.substr(leadingComments[headerLines.length - 1].range[1], numNewlines * 2);
+                            if (!matchesLineEndings(postLineHeader, numNewlines)) {
+                                context.report({
+                                    loc: node.loc,
+                                    message: "no newline after header",
+                                    fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                                });
+                            }
+
+                        } else {
+                            // if block comment pattern has more than 1 line, we also split the comment
+                            var leadingLines = [leadingComments[0].value];
+                            if (headerLines.length > 1) {
+                                leadingLines = leadingComments[0].value.split(/\r?\n/);
+                            }
+
+                            var hasError = false;
+                            if (leadingLines.length > headerLines.length) {
+                                hasError = true;
+                            }
+                            for (i = 0; !hasError && i < headerLines.length; i++) {
+                                if (!match(leadingLines[i], headerLines[i])) {
+                                    hasError = true;
+                                }
+                            }
+
+                            if (hasError) {
+                                if (canFix && headerLines.length > 1) {
+                                    fixLines = [fixLines.join(eol)];
+                                }
+                                context.report({
+                                    loc: node.loc,
+                                    message: "incorrect header",
+                                    fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                                });
+                            } else {
+                                var postBlockHeader = context.getSourceCode().text.substr(leadingComments[0].range[1], numNewlines * 2);
+                                if (!matchesLineEndings(postBlockHeader, numNewlines)) {
+                                    context.report({
+                                        loc: node.loc,
+                                        message: "no newline after header",
+                                        fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                                    });
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        };
+    }
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@tony.ganchev/eslint-plugin-header",
+  "version": "3.1.1",
+  "description": "ESLint plugin to ensure that files begin with given comment",
+  "main": "index.js",
+  "scripts": {
+    "test": "npm run lint && npm run unit",
+    "unit": "mocha tests/lib/*.js tests/lib/**/*.js",
+    "lint": "eslint ."
+  },
+  "devDependencies": {
+    "eslint": "^7.7.0",
+    "mocha": "^8.1.1"
+  },
+  "peerDependencies": {
+    "eslint": ">=7.7.0"
+  },
+  "keywords": [
+    "eslint",
+    "eslintplugin"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tonyganchev/eslint-plugin-header.git"
+  },
+  "author": "Stuart Knightley",
+  "license": "MIT",
+  "contributors": [
+    "Tony Ganchev"
+  ]
+}

package/tests/lib/comment-parser-test.js

@@ -0,0 +1,23 @@
+/* eslint-env mocha */
+"use strict";
+
+var assert = require("assert");
+var commentParser = require("../../lib/comment-parser");
+
+describe("comment parser", function() {
+    it("parses block comments", function() {
+        var result = commentParser("/* pass1\n pass2 */  ");
+        assert.deepEqual(result, ["block", " pass1\n pass2 "]);
+    });
+
+    it("throws an error when a block comment isn't ended", function() {
+        assert.throws(function() {
+            commentParser("/* fail");
+        });
+    });
+
+    it("parses line comments", function() {
+        var result = commentParser("// pass1\n// pass2\n  ");
+        assert.deepEqual(result, ["line", [" pass1", " pass2"]]);
+    });
+});

package/tests/lib/rules/header.js

@@ -0,0 +1,285 @@
+"use strict";
+
+var rule = require("../../../lib/rules/header");
+var RuleTester = require("eslint").RuleTester;
+
+var ruleTester = new RuleTester();
+ruleTester.run("header", rule, {
+    valid: [
+        {
+            code: "/*Copyright 2015, My Company*/\nconsole.log(1);",
+            options: ["block", "Copyright 2015, My Company"]
+        },
+        {
+            code: "//Copyright 2015, My Company\nconsole.log(1);",
+            options: ["line", "Copyright 2015, My Company"]
+        },
+        {
+            code: "/*Copyright 2015, My Company*/",
+            options: ["block", "Copyright 2015, My Company", 0]
+        },
+        {
+            code: "//Copyright 2015\n//My Company\nconsole.log(1)",
+            options: ["line", "Copyright 2015\nMy Company"]
+        },
+        {
+            code: "//Copyright 2015\n//My Company\nconsole.log(1)",
+            options: ["line", ["Copyright 2015", "My Company"]]
+        },
+        {
+            code: "/*Copyright 2015\nMy Company*/\nconsole.log(1)",
+            options: ["block", ["Copyright 2015", "My Company"]]
+        },
+        {
+            code: "/*************************\n * Copyright 2015\n * My Company\n *************************/\nconsole.log(1)",
+            options: ["block", [
+                "************************",
+                " * Copyright 2015",
+                " * My Company",
+                " ************************"
+            ]]
+        },
+        {
+            code: "/*\nCopyright 2015\nMy Company\n*/\nconsole.log(1)",
+            options: ["tests/support/block.js"]
+        },
+        {
+            code: "// Copyright 2015\n// My Company\nconsole.log(1)",
+            options: ["tests/support/line.js"]
+        },
+        {
+            code: "//Copyright 2015\n//My Company\n/* DOCS */",
+            options: ["line", "Copyright 2015\nMy Company"]
+        },
+        {
+            code: "// Copyright 2017",
+            options: ["line", {pattern: "^ Copyright \\d+$"}, 0]
+        },
+        {
+            code: "// Copyright 2017\n// Author: abc@example.com",
+            options: ["line", [{pattern: "^ Copyright \\d+$"}, {pattern: "^ Author: \\w+@\\w+\\.\\w+$"}], 0]
+        },
+        {
+            code: "/* Copyright 2017\n Author: abc@example.com */",
+            options: ["block", {pattern: "^ Copyright \\d{4}\\n Author: \\w+@\\w+\\.\\w+ $"}, 0]
+        },
+        {
+            code: "#!/usr/bin/env node\n/**\n * Copyright\n */",
+            options: ["block", [
+                "*",
+                " * Copyright",
+                " "
+            ], 0]
+        },
+        {
+            code: "// Copyright 2015\r\n// My Company\r\nconsole.log(1)",
+            options: ["tests/support/line.js"]
+        },
+        {
+            code: "//Copyright 2018\r\n//My Company\r\n/* DOCS */",
+            options: ["line", ["Copyright 2018", "My Company"]]
+        },
+        {
+            code: "/*Copyright 2018\r\nMy Company*/\r\nconsole.log(1)",
+            options: ["block", ["Copyright 2018", "My Company"], {"lineEndings": "windows"}]
+        },
+        {
+            code: "/*Copyright 2018\nMy Company*/\nconsole.log(1)",
+            options: ["block", ["Copyright 2018", "My Company"], {"lineEndings": "unix"}]
+        },
+        {
+            code: "/*************************\n * Copyright 2015\n * My Company\n *************************/\nconsole.log(1)",
+            options: ["block", [
+                "************************",
+                { pattern: " \\* Copyright \\d{4}" },
+                " * My Company",
+                " ************************"
+            ]]
+        },
+        {
+            code: "/*Copyright 2020, My Company*/\nconsole.log(1);",
+            options: ["block", "Copyright 2020, My Company", 1],
+        },
+        {
+            code: "/*Copyright 2020, My Company*/\n\nconsole.log(1);",
+            options: ["block", "Copyright 2020, My Company", 2],
+        },
+        {
+            code: "/*Copyright 2020, My Company*/\n\n// Log number one\nconsole.log(1);",
+            options: ["block", "Copyright 2020, My Company", 2],
+        },
+        {
+            code: "/*Copyright 2020, My Company*/\n\n/*Log number one*/\nconsole.log(1);",
+            options: ["block", "Copyright 2020, My Company", 2],
+        },
+        {
+            code: "/**\n * Copyright 2020\n * My Company\n **/\n\n/*Log number one*/\nconsole.log(1);",
+            options: ["block", "*\n * Copyright 2020\n * My Company\n *", 2],
+        },
+        {
+            code: "#!/usr/bin/env node\r\n/**\r\n * Copyright\r\n */",
+            options: ["block", [
+                "*",
+                " * Copyright",
+                " "
+            ], 0]
+        }
+    ],
+    invalid: [
+        {
+            code: "console.log(1);",
+            options: ["block", "Copyright 2015, My Company"],
+            errors: [
+                {message: "missing header"}
+            ],
+            output: "/*Copyright 2015, My Company*/\nconsole.log(1);"
+        },
+        {
+            code: "//Copyright 2014, My Company\nconsole.log(1);",
+            options: ["block", "Copyright 2015, My Company"],
+            errors: [
+                {message: "header should be a block comment"}
+            ],
+            output: "/*Copyright 2015, My Company*/\nconsole.log(1);"
+        },
+        {
+            code: "/*Copyright 2014, My Company*/\nconsole.log(1);",
+            options: ["line", "Copyright 2015, My Company"],
+            errors: [
+                {message: "header should be a line comment"}
+            ],
+            output: "//Copyright 2015, My Company\nconsole.log(1);"
+        },
+        {
+            code: "/*Copyright 2014, My Company*/\nconsole.log(1);",
+            options: ["block", "Copyright 2015, My Company"],
+            errors: [
+                {message: "incorrect header"}
+            ],
+            output: "/*Copyright 2015, My Company*/\nconsole.log(1);"
+        },
+        {
+            // Test extra line in comment
+            code: "/*Copyright 2015\nMy Company\nExtra*/\nconsole.log(1);",
+            options: ["block", ["Copyright 2015", "My Company"]],
+            errors: [
+                {message: "incorrect header"}
+            ],
+            output: "/*Copyright 2015\nMy Company*/\nconsole.log(1);"
+        },
+        {
+            code: "/*Copyright 2015\n*/\nconsole.log(1);",
+            options: ["block", ["Copyright 2015", "My Company"]],
+            errors: [
+                {message: "incorrect header"}
+            ],
+            output: "/*Copyright 2015\nMy Company*/\nconsole.log(1);"
+        },
+        {
+            code: "//Copyright 2014\n//My Company\nconsole.log(1)",
+            options: ["line", "Copyright 2015\nMy Company"],
+            errors: [
+                {message: "incorrect header"}
+            ],
+            output: "//Copyright 2015\n//My Company\nconsole.log(1)"
+        },
+        {
+            code: "//Copyright 2015",
+            options: ["line", "Copyright 2015\nMy Company"],
+            errors: [
+                {message: "incorrect header"}
+            ],
+            output: "//Copyright 2015\n//My Company\n"
+        },
+        {
+            code: "// Copyright 2017 trailing",
+            options: ["line", {pattern: "^ Copyright \\d+$"}],
+            errors: [
+                {message: "incorrect header"}
+            ]
+        },
+        {
+            code: "// Copyright 2017 trailing",
+            options: ["line", {pattern: "^ Copyright \\d+$", template: " Copyright 2018"}],
+            errors: [
+                {message: "incorrect header"}
+            ],
+            output: "// Copyright 2018\n"
+        },
+        {
+            code: "// Copyright 2017 trailing\n// Someone",
+            options: ["line", [{pattern: "^ Copyright \\d+$", template: " Copyright 2018"}, " My Company"]],
+            errors: [
+                {message: "incorrect header"}
+            ],
+            output: "// Copyright 2018\n// My Company\n"
+        },
+        {
+            code: "// Copyright 2017\n// Author: ab-c@example.com",
+            options: ["line", [{pattern: "Copyright \\d+"}, {pattern: "^ Author: \\w+@\\w+\\.\\w+$"}]],
+            errors: [
+                {message: "incorrect header"}
+            ]
+        },
+        {
+            code: "/* Copyright 2017-01-02\n Author: abc@example.com */",
+            options: ["block", {pattern: "^ Copyright \\d+\\n Author: \\w+@\\w+\\.\\w+ $"}],
+            errors: [
+                {message: "incorrect header"}
+            ]
+        },
+        {
+            code: "/*************************\n * Copyright 2015\n * All your base are belong to us!\n *************************/\nconsole.log(1)",
+            options: ["block", [
+                "************************",
+                { pattern: " \\* Copyright \\d{4}", template: " * Copyright 2019" },
+                " * My Company",
+                " ************************"
+            ]],
+            errors: [
+                {message: "incorrect header"}
+            ],
+            output: "/*************************\n * Copyright 2019\n * My Company\n *************************/\nconsole.log(1)"
+        },
+        {
+            code: "/*Copyright 2020, My Company*/console.log(1);",
+            options: ["block", "Copyright 2020, My Company", 2],
+            errors: [
+                {message: "no newline after header"}
+            ],
+            output: "/*Copyright 2020, My Company*/\n\nconsole.log(1);"
+        },
+        {
+            code: "/*Copyright 2020, My Company*/console.log(1);",
+            options: ["block", "Copyright 2020, My Company", 1],
+            errors: [
+                {message: "no newline after header"}
+            ],
+            output: "/*Copyright 2020, My Company*/\nconsole.log(1);"
+        },
+        {
+            code: "//Copyright 2020\n//My Company\nconsole.log(1);",
+            options: ["line", ["Copyright 2020", "My Company"], 2],
+            errors: [
+                {message: "no newline after header"}
+            ],
+            output: "//Copyright 2020\n//My Company\n\nconsole.log(1);"
+        },
+        {
+            code: "/*Copyright 2020, My Company*/\nconsole.log(1);\n//Comment\nconsole.log(2);\n//Comment",
+            options: ["block", "Copyright 2020, My Company", 2],
+            errors: [
+                {message: "no newline after header"}
+            ],
+            output: "/*Copyright 2020, My Company*/\n\nconsole.log(1);\n//Comment\nconsole.log(2);\n//Comment"
+        },
+        {
+            code: "//Copyright 2020\n//My Company\nconsole.log(1);\n//Comment\nconsole.log(2);\n//Comment",
+            options: ["line", ["Copyright 2020", "My Company"], 2],
+            errors: [
+                {message: "no newline after header"}
+            ],
+            output: "//Copyright 2020\n//My Company\n\nconsole.log(1);\n//Comment\nconsole.log(2);\n//Comment"
+        }
+    ]
+});

package/tests/support/block.js

@@ -0,0 +1,4 @@
+/*
+Copyright 2015
+My Company
+*/

package/tests/support/line.js

@@ -0,0 +1,2 @@
+// Copyright 2015
+// My Company