https://github.com/nikku/eslint-plugin-license-header

Rules to validate the presence of license headers in source files.
https://github.com/nikku/eslint-plugin-license-header

eslint eslint-plugin license-management licenses

Last synced: 6 days ago
JSON representation

Rules to validate the presence of license headers in source files.

• Host: GitHub
• URL: https://github.com/nikku/eslint-plugin-license-header
• Owner: nikku
• License: mit
• Created: 2019-02-20T08:22:18.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-26T19:16:33.000Z (6 months ago)
• Last Synced: 2024-10-04T12:51:50.569Z (about 1 month ago)
• Topics: eslint, eslint-plugin, license-management, licenses
• Language: JavaScript
• Homepage:
• Size: 466 KB
• Stars: 27
• Watchers: 5
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-license-header

[![CI](https://github.com/nikku/eslint-plugin-license-header/actions/workflows/CI.yml/badge.svg)](https://github.com/nikku/eslint-plugin-license-header/actions/workflows/CI.yml)

[![Code coverage](https://img.shields.io/codecov/c/github/nikku/eslint-plugin-license-header.svg)](https://codecov.io/gh/nikku/eslint-plugin-license-header)

Rules to validate the presence of license headers in source files.

## Installation

```sh

npm install eslint-plugin-license-header --save-dev

```

## Usage

Add `license-header` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

  "plugins": [

    "license-header"

  ]

}

```

### Header configuration

When enabling the rule specify the license header template as a path:

```json

{

  "rules": {

    "license-header/header": [ "error", "./resources/license-header.js" ]

  }

}

```

Alternatively, specify the license header as raw text:

```js

{

  "rules": {

    "license-header/header": [

      "error",

      [

          "/***********************************************",

          " * Copyright My Company",

          " * Copyright " + new Date().getFullYear(),

          " ***********************************************/",

      ]

    ]

  }

}

```

### Flat config

In `eslint@9` you can consume the library using a flat configuration, too:

```js

import licenseHeader from "eslint-plugin-license-header";

export default [

  {

    files: '**/*.js',

    plugins: {

      'license-header': licenseHeader

    },

    rules: {

      "license-header/header": ...

    }

  }

];

```

### Autofix

You may [auto-fix](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) your source files, adding or updating a given license header:

```sh

eslint --fix .

```

## Supported rules

* [`license-header/header`](./docs/rules/header.md): checks a source file for the presence of a license header

## License

[MIT](./LICENSE)