Rule: file-header

Enforces a certain header comment for all files, matched by a regular expression.

Notes:
Has Fixer

Config

The first option, which is mandatory, is a regular expression that all headers should match. The second argument, which is optional, is a string that should be inserted as a header comment if fixing is enabled and no header that matches the first argument is found.

Config examples
"file-header": [true, "Copyright \\d{4}", "Copyright 2017"]
Schema
{
  "type": "array",
  "items": [
    {
      "type": "string"
    },
    {
      "type": "string"
    }
  ],
  "additionalItems": false,
  "minLength": 1,
  "maxLength": 2
}