eslint-plugin-header

What is eslint-plugin-header?

The eslint-plugin-header package is an ESLint plugin that allows you to enforce consistent header comments in your JavaScript files. This can be useful for ensuring that all files in a project contain specific licensing information, author details, or any other required header content.

What are eslint-plugin-header's main functionalities?

Enforce Header Comments

This feature allows you to enforce a specific header comment at the top of your JavaScript files. The configuration specifies the type of comment (block in this case) and the content of the header.

module.exports = {
  "plugins": ["header"],
  "rules": {
    "header/header": [2, "block", [
      "*",
      " This is a header comment",
      " Author: Your Name",
      " License: MIT",
      "*/"
    ]]
  }
};

Customizable Header Content

You can customize the content of the header to include project-specific information such as the project name, author, and date. This ensures that all files have consistent and up-to-date header information.

module.exports = {
  "plugins": ["header"],
  "rules": {
    "header/header": [2, "block", [
      "*",
      " Project: My Project",
      " Author: Your Name",
      " Date: 2023-10-01",
      "*/"
    ]]
  }
};

Support for Different Comment Styles

The plugin supports different styles of comments, such as line comments. This allows you to choose the comment style that best fits your project's coding standards.

module.exports = {
  "plugins": ["header"],
  "rules": {
    "header/header": [2, "line", [
      "// This is a header comment",
      "// Author: Your Name",
      "// License: MIT"
    ]]
  }
};

Other packages similar to eslint-plugin-header

eslint-plugin-license-header

The eslint-plugin-license-header package is another ESLint plugin that enforces license headers in your files. It is similar to eslint-plugin-header but focuses specifically on license information. It allows for customizable license templates and supports various comment styles.

eslint-plugin-file-header

The eslint-plugin-file-header package is designed to enforce file headers in your JavaScript files. It offers similar functionality to eslint-plugin-header, allowing you to specify the content and format of the headers. It also supports placeholders for dynamic content such as the current date.

eslint-plugin-jsdoc

The eslint-plugin-jsdoc package is primarily focused on enforcing JSDoc comments in your code. While it is not specifically designed for file headers, it can be configured to ensure that certain JSDoc comments are present at the top of your files, providing similar functionality to eslint-plugin-header.

README

eslint-plugin-header

Ensure that source files have a certain header.

Usage

{
    "plugins": [
        "header"
    ],
    "rules": {
        "header": [2, "block", "Copyright 2015\nMy Company"]
    }
}