Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cletusw/eslint-plugin-local-rules
A plugin for ESLint that allows you to use project-specific rules
https://github.com/cletusw/eslint-plugin-local-rules
eslint eslint-plugin eslintplugin
Last synced: 5 days ago
JSON representation
A plugin for ESLint that allows you to use project-specific rules
- Host: GitHub
- URL: https://github.com/cletusw/eslint-plugin-local-rules
- Owner: cletusw
- License: mit
- Created: 2017-05-04T21:19:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T15:21:04.000Z (3 months ago)
- Last Synced: 2024-12-13T18:02:35.134Z (12 days ago)
- Topics: eslint, eslint-plugin, eslintplugin
- Language: JavaScript
- Homepage:
- Size: 106 KB
- Stars: 162
- Watchers: 3
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-local-rules
A plugin for ESLint that allows you to use project-specific rules, similar to the deprecated [`--rulesdir`](http://eslint.org/docs/user-guide/command-line-interface#--rulesdir) command line option ([more](http://eslint.org/docs/developer-guide/working-with-rules#runtime-rules)).
## Install
```sh
npm install eslint-plugin-local-rules
```
Usage (JavaScript)
### ./eslint-local-rules.js (or ./eslint-local-rules/index.js)
```javascript
'use strict';
module.exports = {
'disallow-identifiers': {
meta: {
docs: {
description: 'disallow identifiers',
category: 'Possible Errors',
},
schema: [],
},
create: function (context) {
return {
Identifier: function (node) {
context.report({
node: node,
message: 'Identifiers not allowed for Super Important reasons.',
});
},
};
},
},
};
```
### ./.eslintrc
#### Use all rules as errors
```json
{
"plugins": ["local-rules"],
"extends": [
"plugin:local-rules/all"
]
}
```
#### Use all rules as warnings
```json
{
"plugins": ["local-rules"],
"extends": [
"plugin:local-rules/all-warn"
]
}
```
#### Customize each rule independently
```json
{
"plugins": ["local-rules"],
"rules": {
"local-rules/disallow-identifiers": "error"
}
}
```
## Usage (TypeScript)
```
npm install ts-node @types/eslint
```
You'll also need an eslint config like the [.eslintrc](#eslintrc) above ([more info](https://eslint.org/docs/latest/use/configure/configuration-files)).
### ./eslint-local-rules/index.js
```javascript
require("ts-node").register({
transpileOnly: true,
compilerOptions: {
module: "commonjs",
},
});
module.exports = require("./rules").default;
```
### ./eslint-local-rules/rules.ts
```typescript
import type { Rule } from "eslint";
export default {
"disallow-identifiers": {
meta: {
docs: {
description: 'disallow identifiers',
category: 'Possible Errors',
},
schema: [],
},
create: function (context) {
return {
Identifier: function (node) {
context.report({
node: node,
message: 'Identifiers not allowed for Super Important reasons.',
});
},
};
},
},
} satisfies Record;
```
## npm/yarn/pnpm workspaces support
This plugin supports npm/yarn/pnpm workspaces, although note that if the eslint-local-rules.js file is in the workspace subdirectory, running from the project root is unsupported.
For example, if there's an eslint-local-rules.js and index.js in ./src/app:
Wrong: `npx eslint src/app/index.js`
Right: `(cd src/app; npx eslint index.js)`
Also note that if there is an eslint-local-rules.js file in *both* the workspace subdirectory and project root, the workspace one takes precedence (assuming you're running eslint from the workspace directory, as above).
## Alternatives
* [eslint-plugin-local](https://github.com/taskworld/eslint-plugin-local) - Allows specifying additonal plugin config such as [`processors`](https://eslint.org/docs/developer-guide/working-with-plugins#processors-in-plugins)
* [eslint-plugin-rulesdir](https://github.com/not-an-aardvark/eslint-plugin-rulesdir) - Allows for a custom rules directory name
## Context for this plugin
* https://github.com/eslint/eslint/issues/2715
* https://github.com/eslint/eslint/issues/8769
## License
MIT