Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yash-singh1/eslint-plugin-userscripts
ESLint Plugin for UserScripts
https://github.com/yash-singh1/eslint-plugin-userscripts
eslint eslint-plugin
Last synced: 3 months ago
JSON representation
ESLint Plugin for UserScripts
- Host: GitHub
- URL: https://github.com/yash-singh1/eslint-plugin-userscripts
- Owner: Yash-Singh1
- License: mit
- Created: 2021-08-01T05:32:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-07T13:10:31.000Z (9 months ago)
- Last Synced: 2024-05-07T14:41:16.053Z (9 months ago)
- Topics: eslint, eslint-plugin
- Language: TypeScript
- Homepage: https://yash-singh1.github.io/eslint-plugin-userscripts/
- Size: 262 KB
- Stars: 28
- Watchers: 2
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `eslint-plugin-userscripts`
Implements rules for userscripts in `eslint`.
## Installation
You'll first need to install [ESLint](http://eslint.org):
```shell
npm install eslint --save-dev
```
Next, install `eslint-plugin-userscripts`:
```shell
npm install eslint-plugin-userscripts --save-dev
```
## Usage in legacy config
Add `userscripts` to the plugins section of your `.eslintrc` configuration file:
```json
{
"extends": ["plugin:userscripts/recommended"]
}
```
## Usage in recent flat config
Add an element to the config array in your `eslint.config.*` file :
```js
const userscripts = require('eslint-plugin-userscripts');
module.exports = [
// other configs
{
files: ['*.user.js'],
plugins: {
userscripts: {
rules: userscripts.rules
}
},
rules: {
...userscripts.configs.recommended.rules
},
settings: {
userscriptVersions: {
violentmonkey: '*'
}
}
}
];
```
## Supported Rules
| Rule | Description | Recommended |
| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | :---------: |
| [`filename-user`](docs/rules/filename-user.md) | Ensures userscripts end with .user.js | ✅ |
| [`no-invalid-grant`](docs/rules/no-invalid-grant.md) | Ensures the argument passed to `@grant` is valid | ✅ |
| [`no-invalid-metadata`](docs/rules/no-invalid-metadata.md) | Ensures userscripts have valid metadata | ✅ |
| [`require-name`](docs/rules/require-name.md) | Ensures userscripts have a name | ✅ |
| [`require-description`](docs/rules/require-description.md) | Ensures userscripts have a description | ✅ |
| [`require-version`](docs/rules/require-version.md) | Ensures userscripts have a valid version | ✅ |
| [`use-homepage-and-url`](docs/rules/use-homepage-and-url.md) | Ensures that for each `homepage` attribute, `homepageURL` is also used | ✅ |
| [`require-download-url`](docs/rules/require-download-url.md) | Ensures that for each `downloadURL` there is a `updateURL` | ✅ |
| [`align-attributes`](docs/rules/align-attributes.md) | Ensures that attributes are spaced out and aligned | ✅ |
| [`require-attribute-space-prefix`](docs/rules/require-attribute-space-prefix.md) | Ensure that attributes are prefixed by one space | ✅ |
| [`metadata-spacing`](docs/rules/metadata-spacing.md) | Ensures there is a newline between the metadata and the code | ✅ |
| [`no-invalid-headers`](docs/rules/no-invalid-headers.md) | Ensures userscripts have valid headers | ✅ |
| [`compat-grant`](docs/rules/compat-grant.md) | Ensures your `@grant` permissions are supported | |
| [`compat-headers`](docs/rules/compat-headers.md) | Ensures your headers are supported | |
| [`better-use-match`](docs/rules/better-use-match.md) | Prefers `@match` over `@include` | ✅ |