@zibuthe7j11/quo-facilis-commodi

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

Install

1npm install @zibuthe7j11/quo-facilis-commodi

Usage (JavaScript)

./eslint-local-rules.js (or ./eslint-local-rules/index.js)

1'use strict';
2
3module.exports = {
4  'disallow-identifiers': {
5    meta: {
6      docs: {
7        description: 'disallow identifiers',
8        category: 'Possible Errors',
9      },
10      schema: [],
11    },
12    create: function (context) {
13      return {
14        Identifier: function (node) {
15          context.report({
16            node: node,
17            message: 'Identifiers not allowed for Super Important reasons.',
18          });
19        },
20      };
21    },
22  },
23};

./.eslintrc

1{
2  "plugins": ["@zibuthe7j11/quo-facilis-commodi"],
3
4  "rules": {
5    "local-rules/disallow-identifiers": "error"
6  }
7}

Usage (TypeScript)

npm install ts-node @types/eslint

You'll also need an eslint config like the .eslintrc above (more info).

./eslint-local-rules/index.js

1require("ts-node").register({
2  transpileOnly: true,
3  compilerOptions: {
4    module: "commonjs",
5  },
6});
7
8module.exports = require("./rules").default;

./eslint-local-rules/rules.ts

1import type { Rule } from "eslint";
2
3export default {
4  "disallow-identifiers": {
5    meta: {
6      docs: {
7        description: 'disallow identifiers',
8        category: 'Possible Errors',
9      },
10      schema: [],
11    },
12    create: function (context) {
13      return {
14        Identifier: function (node) {
15          context.report({
16            node: node,
17            message: 'Identifiers not allowed for Super Important reasons.',
18          });
19        },
20      };
21    },
22  },
23} satisfies Record<string, Rule.RuleModule>;

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