Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nickdeis/eslint-plugin-notice
An eslint rule that checks the top of files and --fix them too!
https://github.com/nickdeis/eslint-plugin-notice
eslint eslint-plugin eslint-rules
Last synced: 7 days ago
JSON representation
An eslint rule that checks the top of files and --fix them too!
- Host: GitHub
- URL: https://github.com/nickdeis/eslint-plugin-notice
- Owner: nickdeis
- License: mit
- Created: 2017-06-07T06:53:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T04:08:40.000Z (5 months ago)
- Last Synced: 2024-10-12T17:35:36.941Z (27 days ago)
- Topics: eslint, eslint-plugin, eslint-rules
- Language: JavaScript
- Size: 205 KB
- Stars: 26
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-eslint - Notice - An eslint rule that checks the top of files and fixes them too! (Plugins / Misc)
README
[](https://github.com/nickdeis/eslint-plugin-notice/actions/workflows/main.yml/badge.svg)
# eslint-plugin-notice
An eslint rule that checks the top of files and `--fix` them too!
## Usage
`npm i -D eslint-plugin-notice`
### Flag config
_eslint.config.js_
```js
import notice from "eslint-plugin-notice";
export default [
{
files: ["**/*.js"],
plugins: {
notice,
},
rules: {
"notice/notice": [
"error",
{ mustMatch: "Copyright \\(c\\) [0-9]{0,4}, Nick Deis" },
],
},
},
];
```
### eslintrc
Throw an error when a file doesn't have copyright notice
```json
{
"plugins": ["notice"],
"rules": {
"notice/notice": [
"error",
{ "mustMatch": "Copyright \\(c\\) [0-9]{0,4}, Nick Deis" }
]
}
}
```
Add a template to `--fix` it
```json
{
"notice/notice": [
"error",
{
"mustMatch": "Copyright \\(c\\) [0-9]{0,4}, Nick Deis",
"template": "/** Copyright (c) <%= YEAR %>, Nick Deis **/"
}
]
}
```
or use a file
_config/copyright.js_
```js
/**
* Copyright (c) <%= YEAR %>, Nick Deis
*/
```
```json
{
"notice/notice": [
"error",
{
"mustMatch": "Copyright \\(c\\) [0-9]{0,4}, Nick Deis",
"templateFile": "config/copyright.js"
}
]
}
```
or just use your template, eslint-plugin-notice will reverse into a pattern for `mustMatch`
```json
{
"notice/notice": [
"error",
{
"templateFile": "config/copyright.js"
}
]
}
```
Want a more expressive template? Add `templateVars` and `varRegexps`
_config/copyright.js_
```js
/**
* Copyright (c) <%= YEAR %>, <%= NAME %>
*/
```
```js
{
"notice/notice":["error",
{
templateFile:"config/copyright.js",
//YEAR will still be added unless you add your own value
templateVars:{NAME:"Nick Deis"},
//The regexp for YEAR is /20\d{2}/ and is automatically added
varRegexps:{NAME:/(Nick|Nicholas) Deis/}
}
]
}
```
## Options
| Option | Description | Default/Required/Optional | Type |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ---------------------- |
| mustMatch | A pattern that must be present in the notice | **Required** unless `template` is set | RegExp/string |
| template | A lodash template that will be used to fix files that do not match `mustMatch` or are less than `nonMatchingTolerance` | **Optional** unless `mustMatch` is not set | string |
| templateFile | `template` will override this setting. A file which contains the `template` | **Optional** | string |
| chars | The number of characters to check for the `mustMatch` pattern | `1000` | number |
| templateVars | The variables to be used with the lodash template, always contains the variable YEAR | `{YEAR:new Date().getFullYear()}` | object |
| [onNonMatchingHeader](#onnonmatchingheader) | Action that should be taken when there is a header comment, but it does not match `mustMatch` or is less than `nonMatchingTolerance` | `"prepend"` | string |
| nonMatchingTolerance | Optional fallback for `mustMatch`. Compares a non-matching header comment (if it exists) to the resolved template using [Metric Longest Common Subsequence](http://heim.ifi.uio.no/~danielry/StringMetric.pdf). `1` means the strings must be exactly the same, where anything less is varying degrees of dissimiliar. `.70` seems like a good choice | **Optional** | number between 0 and 1 |
| varRegexps | If `mustMatch` is not set and `template` is set, a regexp that will be replaced in the `template` to create a regexp for `mustMatch` | `{YEAR:/20\d{2}/}` | object |
| messages | Allows you to change the error messages. See [messages](#messages) | **Optional** | object |
### onNonMatchingHeader
- **prepend**: Prepends the fix template, if it exists, leaving the former header comment intact.
- **replace**: Replaces the former header comment with the fix template if it exists
- **report**: Does not apply fix, simply reports it based on the level assigned to the rule ("error" or "warn")
### messages
The `messages` option allows you to change the default error messages.
There are three messages you can change by passing in an object with the pairs you wish to change.
For example, if you want to change the default message for when a header does not match `mustMatch`:
```js
{
"notice/notice":["error",
{
"mustMatch":"Apache License",
"templateFile":"config/apache.js",
"messages":{
"whenFailedToMatch":"Couldn't find 'Apache License', are you sure you added it?"
}
}
]
}
```
The three configurable messages are:
- **whenFailedToMatch**: When the header fails to match the `mustMatch` pattern.
- **reportAndSkip**: When using `"onNonMatchingHeader":"report"` and a non-matching notice is found.
- **whenOutsideTolerance**: When you using `nonMatchingTolerance` to check for notice similarity and it fails to be similar enough. Passes in `similarity` as a template variable (eg `"The similarity is {{ similarity }}"`)