This is an example Vue file.
\n\n```\n\nAfter applying the fix:\n\n```vue\n\n\nThis is an example Vue file.
\n\n```\n\nSince the `vue-eslint-parser` package strives to maintain compatibility with\nrules targeting JavaScript, it exposes Vue AST tokens to rules in different\nways than the default ESlint parser. The means of exposing HTML Comment nodes\nare of specific interest to this plugin, and the mechanism to access these\nare substantially different than how a plugin would typically read a comment\nnode, making it necessary to both specify this particular parser as well as\nsetting the flag.\n\n## Examples\n\n**Example 0:**\n\nExample Configuration:\n\n```json\n{\n \"rules\": {\n \"headers/header-format\": [\n \"error\",\n {\n \"source\": \"string\",\n \"content\": \"Copyright 2024. All rights reserved.\"\n }\n ]\n }\n}\n```\n\nUsing the above configuration, here's a file without a matching header:\n\n```js\nmodule.exports = 42;\n```\n\nWhen the fix is applied, the file now appears so:\n\n```js\n/**\n * Copyright 2024. All rights reserved.\n */\nmodule.exports = 42;\n```\n\n**Example 1:**\n\nUsing the same configuration, this file already has a header, this one containing pragmas:\n\n```js\n/**\n * @fileoverview This file contains a magic number.\n * @author Rob Misasi\n */\nmodule.exports = 42;\n```\n\nWhen the fix is applied, the file now appears so:\n\n```js\n/**\n * Copyright 2024. All rights reserved.\n *\n * @fileoverview This file contains a magic number.\n * @author Rob Misasi\n */\nmodule.exports = 42;\n```\n\n**Example 2:**\nUsing the following configuration, variable values can be injected into the provided header:\n\n```json\n{\n \"rules\": {\n \"headers/header-format\": [\n \"error\",\n {\n \"source\": \"string\",\n \"content\": \"Copyright {year} {company}. All rights reserved.\",\n \"variables\": {\n \"year\": \"2077\",\n \"company\": \"Software Incorporated\"\n }\n }\n ]\n }\n}\n```\n\nWe can then apply a fix to the following file:\n\n```js\n/**\n * Copyright 1947 Hardware LLC. All rights reserved.\n */\nmodule.exports = 42;\n```\n\nAnd get the resulting header:\n\n```js\n/**\n * Copyright 2077 Software Incorporated. All rights reserved.\n */\nmodule.exports = 42;\n```\n\n**Example 3:**\n\nUsing the following configuration, patterns are used to validate content in existing headers:\n\n```json\n{\n \"rules\": {\n \"headers/header-format\": [\n \"error\",\n {\n \"source\": \"string\",\n \"content\": \"Copyright (year) {company}. All rights reserved.\",\n \"variables\": {\n \"company\": \"Contemporary Org\"\n },\n \"patterns\": {\n \"year\": {\n \"pattern\": \"\\\\d{4}\",\n \"defaultValue\": \"2025\"\n }\n }\n }\n ]\n }\n}\n```\n\nThe following file would validate successfully:\n\n```js\n/**\n * Copyright 1985 Contemporary Org. All rights reserved.\n */\nmodule.exports = 42;\n```\n\nAlternatively, the plugin can apply a fix to the following invalid file:\n\n```js\n/**\n * Copyright 40000 Future Corp. All rights reserved.\n */\nmodule.exports = 42;\n```\n\nAnd get the following header:\n\n```js\n/**\n * Copyright 2025 Contemporary Org. All rights reserved.\n */\nmodule.exports = 42;\n```\n\n### Options\n\nOptions are supplied through a single object with the following properties:\n\n| Name | Type | Required | Default | Description |\n| ---------------- | ----------------------------------------------------------------- | ----------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| source | `\"file\" \\| \"string\"` | Yes | | Indicates how the header content is supplied. |\n| style | `\"line\" \\| \"jsdoc\"` | No | `\"jsdoc\"` | Indicates the comment style to enforce. A leading line-style comment block will only include adjacent line comments, although a line comment's content may be empty. No effect if `enableVueSupport: true`. |\n| content | string | When `source: \"string\"` | | The string to enforce in the header comment. |\n| path | string | When `source: \"file\"` | | The path to a file containing the header content to enforce. |\n| preservePragmas | boolean | No | `true` | Preserves existing pragma expressions in leading comments when updating header. No effect when `style: \"line\"`. |\n| blockPrefix | string | No | [See below](#default-prefixes-and-suffixes) | Content at the start of the leading comment block. |\n| blockSuffix | string | No | [See below](#default-prefixes-and-suffixes) | Content at the end of the leading comment block. |\n| linePrefix | string | No | [See below](#default-prefixes-and-suffixes) | Content prepended to the start of each line of content. |\n| trailingNewlines | number | No | | Number of empty lines to enforce after the leading comment. |\n| variables | object | No | | The keys to find and values to fill when formatting the provided header. Values must be strings. |\n| patterns | `{ [key: string] : { pattern: string; defaultValue?: string; } }` | No | | The keys to find and Regex patterns to validate when matching the provided header. **WARNING!** Default values must be provided for errors to be `--fix`able. |\n| enableVueSupport | boolean | No | `false` | **EXPERIMENTAL!** Enable support for parsing `.vue` files. Must be used with `vue-eslint-parser`. [See above](#usage-with-vue) for details. |\n\n#### Default Prefixes and Suffixes\n\nExample configuration:\n\n```js\nexport default [\n {\n // ...\n rules: {\n \"headers/header-format\": [\n \"error\",\n {\n source: \"string\",\n content: \"This is a header.\",\n // ...{Additional Configuration}\n },\n ],\n },\n },\n];\n```\n\nThe subsequent section titles contain the additional configuration inserted\nabove, and the resulting comment that will be produced.\n\n##### style: \"line\"\n\nExpected/produced header:\n\n```js\n// This is a header.\n```\n\n- Default block prefix: None\n- Default block suffix: None\n- Default line prefix: `\" \"`\n\n##### style: \"jsdoc\"\n\nExpected/produced header:\n\n```js\n/**\n * This is a header.\n */\n```\n\n- Default block prefix: `\"*\\n\"`\n- Default block suffix: `\"\\n \"`\n- Default line prefix: `\" * \"`\n\n##### enableVueSupport: true\n\nExpected/produced header:\n\n```vue\n\n```\n\n- Default block prefix: `\"\\n\"`\n- Default block suffix: `\"\\n\"`\n- Default line prefix: `\" \"`\n\n## Future\n\n- Add support for common pragma expressions that don't utilize the `@` symbol (e.g. eslint-disable)\n\n## Rules\n\n\n\n🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\n\n| Name         | Description | 🔧 |\n| :------------------------------------------- | :----------------------------------------------------------------- | :- |\n| [header-format](docs/rules/header-format.md) | Verifies the content and format of a file's leading comment block. | 🔧 |\n\n\n","readmeFilename":"README.md"}