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

package/index.js

@@ -1,3 +1,27 @@
+/*
+ * MIT License
+ *
+ * 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.
+ */
+
 "use strict";
 
 module.exports = {

package/lib/comment-parser.js

@@ -1,10 +1,39 @@
-"use strict";
+/*
+ * MIT License
+ *
+ * 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.
+ */
 
-// This is a really simple and dumb parser, that looks just for a
-// single kind of comment. It won't detect multiple block comments.
+"use strict";
 
-module.exports = function commentParser(text) {
-    text = text.trim();
+/**
+ * Parses a line or block comment and returns the type of comment and an array of content lines.
+ *
+ * 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 comment text.
+ * @returns {['block' | 'line', string[]]} comment type and comment content broken into lines.
+ */
+module.exports = function commentParser(commentText) {
+    const text = commentText.trim();
 
     if (text.substr(0, 2) === "//") {
         return [

package/lib/rules/header.js

@@ -1,13 +1,85 @@
+/*
+ * MIT License
+ *
+ * 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.
+ */
+
 "use strict";
 
+/**
+ * Import type definitions.
+ * @typedef {import('estree').Comment} Comment
+ * @typedef {import('estree').Program} Program
+ * @typedef {import('eslint').Rule.Fix} Fix
+ * @typedef {import('eslint').Rule.NodeListener} NodeListener
+ * @typedef {import('eslint').Rule.ReportFixer} ReportFixer
+ * @typedef {import('eslint').Rule.RuleFixer} RuleFixer
+ * @typedef {import('eslint').Rule.RuleTextEdit} RuleTextEdit
+ * @typedef {import('eslint').Rule.RuleTextEditor} RuleTextEditor
+ * @typedef {import('eslint').Rule.RuleContext} RuleContext
+ */
+
+/**
+ * @enum {string}
+ */
+const lineEndingOptions = Object.freeze({
+    unix: "unix", // \n
+    windows: "windows", // \n
+});
+
+/**
+ * @enum {string}
+ */
+const commentTypeOptions = Object.freeze({
+    block: "block",
+    line: "line"
+});
+
+/**
+ * Local type defintions.
+ * @typedef {string | { pattern: string, template?: string }} HeaderLine
+ * @typedef {(HeaderLine | HeaderLine[])} HeaderLines
+ * @typedef {{ lineEndings: ('unix' | 'windows') }} HeaderSettings
+ * @typedef {([string] | [string, HeaderSettings] | [('block' | 'line') | HeaderLines ] | [('block' | 'line') | HeaderLines | HeaderSettings] | [('block' | 'line') | HeaderLines | number ] | [('block' | 'line') | HeaderLines | number | HeaderSettings])} HeaderOptions
+ */
+
 var fs = require("fs");
 var commentParser = require("../comment-parser");
 var os = require("os");
 
+/**
+ * Tests if the passed line configuration string or object is a pattern definition.
+ * @param {HeaderLine} object line configuration object or string
+ * @returns {boolean} `true` if the line configuration is a pattern-dfining object or `false` otherwise.
+ */
 function isPattern(object) {
     return typeof object === "object" && Object.prototype.hasOwnProperty.call(object, "pattern");
 }
 
+/**
+ * Utility over a line config argument to match an expected string either against a regex or for full match against a string.
+ * @param {HeaderLine} actual the string to test.
+ * @param {string} expected The string or regex to test again.
+ * @returns {boolean} `true` if the passed string matches the expected line config or `false` otherwise.
+ */
 function match(actual, expected) {
     if (expected.test) {
         return expected.test(actual);
@@ -16,19 +88,29 @@ function match(actual, expected) {
     }
 }
 
+/**
+ * Remove Unix she-bangs from the list of comments.
+ * @param {Comment[]} comments the list of comment lines.
+ * @returns {Comment[]} the list of comments with containing all incomming comments from `comments` with the shebang comments omitted.
+ */
 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().
+/**
+ * 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()`.
+ * @param {RuleContext} context ESLint execution environment.
+ * @param {Program} node ESLint AST treee node being processed.
+ * @returns {Comment[]} lines that constitute the leading comment.
+ */
 function getLeadingComments(context, node) {
     var all = excludeShebangs(context.getSourceCode().getAllComments(node.body.length ? node.body[0] : node));
-    if (all[0].type.toLowerCase() === "block") {
+    if (all[0].type.toLowerCase() === commentTypeOptions.block) {
         return [all[0]];
     }
     for (var i = 1; i < all.length; ++i) {
@@ -40,24 +122,50 @@ function getLeadingComments(context, node) {
     return all.slice(0, i);
 }
 
+/**
+ * Generate a comment including trailing spaces out of a number of comment body lines.
+ * @param {'block' | 'line'} commentType the type of comment to generate.
+ * @param {string[]} textArray list of lines of the comment content.
+ * @param {'\n' | '\r\n'} eol end-of-line characters.
+ * @param {number} numNewlines number of trailing lines after the comment.
+ * @returns {string} resulting comment.
+ */
 function genCommentBody(commentType, textArray, eol, numNewlines) {
     var eols = eol.repeat(numNewlines);
-    if (commentType === "block") {
+    if (commentType === commentTypeOptions.block) {
         return "/*" + textArray.join(eol) + "*/" + eols;
     } else {
         return "//" + textArray.join(eol + "//") + eols;
     }
 }
 
+/**
+ * ...
+ * @param {RuleContext} context ESLint rule execution context.
+ * @param {string[]} comments list of comments.
+ * @param {'\n' | '\r\n'} eol end-of-line characters
+ * @returns {[number, number]} resulting range.
+ */
 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) {
+    const sourceCode = context.getSourceCode().text;
+    const headerTrailingChars = sourceCode.substring(end, end + eol.length);
+    if (headerTrailingChars === eol) {
         end += eol.length;
     }
     return [start, end];
 }
 
+/**
+ * Factory for fixer that adds a missing header.
+ * @param {'block' | 'line'} commentType type of comment to use.
+ * @param {Program} node ESLint AST program node.
+ * @param {string[]} headerLines lines of the header comment.
+ * @param {'\n' | '\r\n'} eol end-of-line characters
+ * @param {number} numNewlines number of trailing lines after the comment.
+ * @returns {ReportFixer} the fixer.
+ */
 function genPrependFixer(commentType, node, headerLines, eol, numNewlines) {
     return function(fixer) {
         return fixer.insertTextBefore(
@@ -67,6 +175,16 @@ function genPrependFixer(commentType, node, headerLines, eol, numNewlines) {
     };
 }
 
+/**
+ * Factory for fixer that replaces an incorrect header.
+ * @param {'block' | 'line'} commentType type of comment to use.
+ * @param {RuleContext} context ESLint rule execution context.
+ * @param {Comment[]} leadingComments comment elements to replace.
+ * @param {string[]} headerLines lines of the header comment.
+ * @param {'\n' | '\r\n'} eol end-of-line characters
+ * @param {number} numNewlines number of trailing lines after the comment.
+ * @returns {(fixer: RuleTextEditor) => RuleTextEdit | RuleTextEdit[] | null} the fixer.
+ */
 function genReplaceFixer(commentType, context, leadingComments, headerLines, eol, numNewlines) {
     return function(fixer) {
         return fixer.replaceTextRange(
@@ -76,6 +194,11 @@ function genReplaceFixer(commentType, context, leadingComments, headerLines, eol
     };
 }
 
+/**
+ * Finds the option parameter within the list of rule config options.
+ * @param {HeaderOptions} options the config options passed to the rule.
+ * @returns {HeaderSettings | null} the settings parameter or `null` if no such is defined.
+ */
 function findSettings(options) {
     var lastOption = options.length > 0 ? options[options.length - 1] : null;
     if (typeof lastOption === "object" && !Array.isArray(lastOption) && lastOption !== null
@@ -85,17 +208,30 @@ function findSettings(options) {
     return null;
 }
 
+/**
+ * Returns the used line-termination characters per the rule's config if any or else based on the runtime environments.
+ * @param {HeaderOptions} options rule configuration.
+ * @returns {'\n' | '\r\n'} the correct line ending characters for the environment.
+ */
 function getEOL(options) {
     var settings = findSettings(options);
-    if (settings && settings.lineEndings === "unix") {
-        return "\n";
-    }
-    if (settings && settings.lineEndings === "windows") {
-        return "\r\n";
+    if (settings) {
+        if (settings.lineEndings === lineEndingOptions.unix) {
+            return "\n";
+        }
+        if (settings.lineEndings === lineEndingOptions.windows) {
+            return "\r\n";
+        }
     }
     return os.EOL;
 }
 
+/**
+ * Tests if the first line in the source code (after a Unix she-bang) is a comment. Does not tolerate empty lines before the first match.
+ * @param {string} src source code to test.
+ * @returns {boolean} `true` if there is a comment or `false` otherwise.
+ */
+// TODO: check if it is valid to have the copyright notice separated by an empty line from the shebang.
 function hasHeader(src) {
     if (src.substr(0, 2) === "#!") {
         var m = src.match(/(\r\n|\r|\n)/);
@@ -106,6 +242,12 @@ function hasHeader(src) {
     return src.substr(0, 2) === "/*" || src.substr(0, 2) === "//";
 }
 
+/**
+ * Ensures that the right amount of empty lines trail the header.
+ * @param {string} src source to validate.
+ * @param {number} num expected number of trailing empty lines.
+ * @returns {boolean} `true` if the `num` number of empty lines are appended at the end or `false` otherwise.
+ */
 function matchesLineEndings(src, num) {
     for (var j = 0; j < num; ++j) {
         var m = src.match(/^(\r\n|\r|\n)/);
@@ -127,7 +269,7 @@ module.exports = {
             definitions: {
                 commentType: {
                     type: "string",
-                    enum: ["block", "line"]
+                    enum: [commentTypeOptions.block, commentTypeOptions.line]
                 },
                 line: {
                     anyOf: [
@@ -171,7 +313,7 @@ module.exports = {
                     properties: {
                         lineEndings: {
                             type: "string",
-                            enum: ["unix", "windows"]
+                            enum: [lineEndingOptions.unix, lineEndingOptions.windows]
                         }
                     },
                     additionalProperties: false
@@ -213,9 +355,14 @@ module.exports = {
             }
         }
     },
+    /**
+     * Rule creation function.
+     * @param {RuleContext} context ESLint rule execution context.
+     * @returns {NodeListener} the rule definition.
+     */
     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
@@ -280,7 +427,7 @@ module.exports = {
                             fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
                         });
                     } else {
-                        if (commentType === "line") {
+                        if (commentType === commentTypeOptions.line) {
                             if (leadingComments.length < headerLines.length) {
                                 context.report({
                                     loc: node.loc,
@@ -321,8 +468,11 @@ module.exports = {
                                 hasError = true;
                             }
                             for (i = 0; !hasError && i < headerLines.length; i++) {
-                                if (!match(leadingLines[i], headerLines[i])) {
+                                const leadingLine = leadingLines[i];
+                                const headerLine = headerLines[i];
+                                if (!match(leadingLine, headerLine)) {
                                     hasError = true;
+                                    break;
                                 }
                             }
 

package/package.json

@@ -1,16 +1,25 @@
 {
   "name": "@tony.ganchev/eslint-plugin-header",
-  "version": "3.1.3",
-  "description": "ESLint plugin to ensure that files begin with given comment",
+  "version": "3.1.5",
+  "description": "ESLint plugin to ensure files begin with a given comment, usually a copyright or license notice.",
   "main": "index.js",
+  "files": [
+    "/lib/**/*.js",
+    "!/lib/rules/test-utils.js"
+  ],
   "scripts": {
     "test": "npm run lint && npm run unit",
-    "unit": "mocha tests/lib/*.js tests/lib/**/*.js",
+    "unit": "nyc --reporter=html --reporter=text --reporter=text-summary mocha tests/lib/**/*.js",
     "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",
+    "nyc": "^17.1.0",
+    "testdouble": "^3.20.2"
   },
   "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"]

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

@@ -1,33 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 10
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.github/workflows/test.yml

@@ -1,22 +0,0 @@
-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

@@ -1,39 +0,0 @@
-# 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/tests/lib/comment-parser-test.js

@@ -1,23 +0,0 @@
-/* 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

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

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

package/tests/support/line.js

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