@sheplu/eslint-config-eslint
v0.11.3
Published
Opinionated ESLint rules and config for consistent, high-quality code with zero setup.
Downloads
472
Maintainers
Readme
@sheplu/eslint-config-eslint
Opinionated, exhaustive configuration for every core ESLint rule — ready to drop into an ESLint 10+ flat config.
This package only ships rules from eslint/eslint itself (no plugins). Every non-deprecated upstream rule is configured explicitly, so nothing is left to defaults and nothing silently changes when ESLint ships a new core rule — a scheduled CI job diffs the package against eslint.org/docs/latest/rules/ every week and opens an issue on drift.
199 rules configured across three categories (59 problems, 139 suggestions, 1 layout).
Installation
npm install --save-dev @sheplu/eslint-config-eslint eslintRequires eslint >= 10 (flat config) and Node >= 24.
Usage
In your eslint.config.js:
import { defineConfig } from 'eslint/config';
import { eslintRules } from '@sheplu/eslint-config-eslint';
export default defineConfig([
{
files: [ '**/*.{js,mjs,cjs}' ],
extends: [ eslintRules ],
},
]);eslintRules is an array of flat-config objects, so it plugs directly into extends or can be spread into your own config.
What's inside
All rules are organized after ESLint's own documentation categories:
| Source | Category |
| ------------------------ | ----------------------------------------------------------------------------------- |
| eslint-problems.js | Possible problems |
| eslint-suggestions.js | Suggestions |
| eslint-layouts.js | Layout & formatting |
Layout rules are deliberately minimal — formatting is better delegated to a dedicated stylistic plugin (see @sheplu/eslint-config if you want a matching stylistic layer).
Every rule is set to error with options spelled out explicitly. If you need a more permissive baseline, override rules individually in your own config.
Scripts
npm test # run the test suite (includes upstream drift check)
npm run test:coverage # run tests with coverage
npm run lint # lint the package itself
npm run lint:fix # lint with autofix
npm run setup:hooks # wire .githooks/ as the git hooks path (run once)Upstream drift
review-rules.js fetches eslint.org/docs/latest/rules/, parses the rule index, and diffs it against the configured rule set. This runs:
- as part of
npm test, - on a weekly schedule (
.github/workflows/eslint-rules-drift.yaml), which opens a GitHub issue if new rules appear, are renamed, or are removed upstream.
Contributing
See AGENTS.md for the short version of how this repo is laid out and the CI quality gates. A few things worth knowing up front:
- Git hooks live in
.githooks/. Runnpm run setup:hooksonce after cloning to pointcore.hooksPaththere. The pre-commit hook runs lint and tests; the pre-push hook adds coverage andnpm audit, and blocks direct pushes tomain. (Hooks are opt-in because.npmrcsetsignore-scripts=truefor supply-chain safety.) - AI tooling assets (agent rules, prompts) are distributed via
apkgrather than committed.apkg.jsonandapkg-lock.jsonare in the repo; the resolved files under.codex/,.claude/,.cursor/, etc. are gitignored and materialized by runningapkginstall. CI does this automatically inquality-gates.yaml. If you contribute using an AI agent and want those rule files locally, installapkgand run it against this repo.
