Copyright header recognition does not work with CLI scripts

[bennycode]

I have a CLI tool written in TypeScript which needs to have a Shebang in the top of the file. Thus the copyright header has to follow afterwards and this is not recognized with my config:

    "header/header": [
      "error",
      "block",
      [
        {
          "pattern": "Copyright",
          "template": "Copyright Test"
        }
      ],
      2
    ],

cli.ts

#!/usr/bin/env node

/*
 * Copyright (C) 2021
 */

// Some code here...

[bennycode]

@Stuk I've seen in your code that you are skipping comments of type "Shebang":

eslint-plugin-header/lib/rules/header.js

Lines 19 to 23 in d1e2575

	function excludeShebangs(comments) {
	return comments.filter(function(comment) {
	return comment.type !== "Shebang";
	});
	}

But in your commentParser.js there is no return with that type. Only "line" and "block" are returned:

eslint-plugin-header/lib/comment-parser.js

Lines 6 to 24 in d1e2575

	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 (/* ... */)");
	}
	};

I am using Node v16 and Windows 10 and version 3.1.1 of "eslint-plugin-header". I also saw that you recently added a test case (46db23a) for it but it doesn't work for me.

[bennycode]

When using the fix option, the plugin also adds my header template multiple times in this case:

[slorber]

Can confirm had the same issue.

It used to work fine in 3.0.0, but it is broken in 3.1.1

This works with 3.0.0: https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-init/bin/index.js

But it fails in 3.1.1:

[tonyganchev]

I had a similar issue (I only tested 3.1.1). Turns out the shebang is accepted if there is no empty line between the shebang and the copyright comment.

[tonyganchev]

To everyone still struggling with issues, related to shebangs in scripts: versions 3.1.6 and onward of the forked @tony.ganchev/eslint-plugin-header contain a fix to the issue of repetitive comments added by the autofix.

The problem was that the rule expects that the header follows immediately on the next line after the shebang but the fix adds the fix immediately before the first non-comment parsed token.