@scrumble-nl/eslint-plugin-scrumble-rules
v2.3.1
Published
Scrumble shared ESLint rules
Readme
@scrumble-nl/eslint-plugin-scrumble-rules
Scrumble's shared ESLint rules. React-version-agnostic — the only peer dependency is ESLint. Works
with both the flat config (eslint.config.mjs) and the legacy .eslintrc format.
Installation
npm install --save-dev @scrumble-nl/eslint-plugin-scrumble-rulesRequires ESLint >=6.
Usage
Flat config (recommended)
The plugin exposes a recommended shareable config. It is what @scrumble-nl/ci-node's base config
consumes, so most projects get these rules transitively and never import this plugin directly.
// eslint.config.mjs
import scrumble from '@scrumble-nl/eslint-plugin-scrumble-rules';
export default [
{
plugins: scrumble.configs.recommended.plugins,
rules: scrumble.configs.recommended.rules,
},
];Legacy config
{
"plugins": ["@scrumble-nl/scrumble-rules"],
"rules": {
"@scrumble-nl/scrumble-rules/sort-imports": "warn",
"@scrumble-nl/scrumble-rules/ignore-comment": "warn",
"@scrumble-nl/scrumble-rules/enforce-whitespace-above-return": "warn"
}
}Rules
recommended enables every rule as a warning.
| Rule | Description | Fixable |
|---|---|---|
| scrumble-rules/sort-imports | Sorts import statements (React first, then external, then local, CSS last; grouped by blank lines). Imports matching a compilerOptions.paths alias in the project's tsconfig.json (e.g. @/) count as local. | ✅ |
| scrumble-rules/ignore-comment | Requires an explanation after @ts-ignore and @ts-expect-error. | 💡 suggestion |
| scrumble-rules/enforce-whitespace-above-return | Requires a blank line above a return, except when it is the first or only statement in its block, the brace-less body of an if or loop, or directly follows the } closing an if, loop or function declaration. | ✅ |
Development
npm install
npm run build # tsc: src/ -> lib/
npm run lint
npm testThe published package contains only the compiled lib/ output, built automatically on prepare.
Releases are cut by tagging a commit with the version that matches package.json (e.g. 2.3.0); the
shared CI pipeline publishes the tag to the public npm registry (publishConfig in package.json).
