Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/not-an-aardvark/eslint-plugin-self

Allows ESLint plugins to lint themselves
https://github.com/not-an-aardvark/eslint-plugin-self

eslint eslint-plugin

Last synced: 11 days ago
JSON representation

Allows ESLint plugins to lint themselves

Awesome Lists containing this project

README

        

# eslint-plugin-self

When writing an ESLint plugin, it's often useful to use the plugin's rules to lint the plugin's own codebase. You can use `eslint-plugin-self` to do that.

## Usage

```
npm install eslint-plugin-self --save-dev
```

Note: `eslint-plugin-self` must be installed locally (it will not work if installed globally), and the project that installs it must be a functioning ESLint plugin.

Add the following to your config file:

```json
{
"plugins": [
"self"
]
}
```

Then you can use your plugin's rules, with the `self/` prefix:

```json
{
"rules": {
"self/my-custom-rule": "error"
}
}
```

You can also use your plugin's configs, or anything else exported by your plugin:

```json
{
"extends": [
"plugin:self/some-config"
]
}
```