@tony.ganchev/eslint-plugin-header weekly downloads statistics

@tony.ganchev/eslint-plugin-header

The native ESLint 9/10 standard header-validating plugin. A zero-bloat, drop-in replacement for eslint-plugin-header with first-class Flat Config & TypeScript support. Auto-fix copyright, license, and banner comments in JavaScript, TypeScript, Vue, Svelte, CSS, HTML, YAML, and Markdown files. Supports oxlint.

Table of Contents

1. Motivation and Acknowledgements
2. Major Consumers
3. Compatibility
   1. Runtimes
   2. Configuration Formats
   3. Languages
4. Usage
   1. File-based Configuration
   2. Inline Configuration
      1. Header Contents Configuration
      2. Providing To-year in Auto-fix
      3. Trailing Empty Lines Configuration
      4. Line Endings
   3. Support for Leading Comments
      1. Notes on Behavior
   4. Examples
   5. Linting CSS
   6. Linting HTML
   7. Linting Vue
   8. Linting Svelte
   9. Linting Markdown
   10. Linting YAML
5. Comparison to Alternatives
   1. Compared to eslint-plugin-headers
      1. Health Scans
   2. Compared to eslint-plugin-license-header
   3. Compared to eslint-plugin-notice
6. Versioning
   1. What is a Feature?
   2. What is Backward-compatibility?
7. License

Motivation and Acknowledgements

The plugin started as a fork of eslint-plugin-header to address missing ESLint 9 compatibility.

Today it addresses the following issues:

• Support for ESLint 9/10 with a fully-validated configuration schema.
• Continued support for ESLint 7/8.
• Complete Windows support.
• New object-based configuration providing the bases for future enhancements.
• Continued support for eslint-plugin-header array configuration.
• Bugfixes where the original project has not been updated for the three years before the fork.
• Fixes issues with she-bangs and empty lines before the header. See PR history for more details.
• Good error reporting and improved auto-fixes.
• Complete drop-in-replacement compatibility with existing projects using eslint-plugin-header.

Multiple other projects took from where eslint-plugin-header left off. A comparison of the current project to these alternatives is available in a dedicated section.

Major Consumers

The plugin is used by hundreds of projects to enforce license compliance and consistent header structures. Notable adopters include:

                                                                           

Learn more about how these organizations use the plugin on our consumers list.

Compatibility

Runtimes…