eslint-plugin-local-rules

A plugin for ESLint that allows you to use project-specific rules, similar to the deprecated --rulesdir command line option (more).

Install

``sh
npm install eslint-plugin-local-rules
`

Usage (JavaScript)

$3

`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.',
});
},
};
},
},
};
`

$3

#### 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 above (more info).

$3

`javascript
require("ts-node").register({
transpileOnly: true,
compilerOptions: {
module: "commonjs",
},
});

module.exports = require("./rules").default;
`

$3

`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 - Allows specifying additonal plugin config such as processors`
* 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