Skip to content
ESLint Config Setup

Contributing

Contributing

Development setup

  1. Clone the repository and install dependencies:

    git clone https://github.com/sebastian-software/eslint-config-setup.git
cd eslint-config-setup
pnpm install

  2. Run the self-lint and type checks:

    pnpm lint
pnpm check

  3. Run the tests:

    pnpm test
pnpm test:coverage

  4. Build and regenerate the published configs:

    pnpm build
pnpm generate

Useful workspace commands

pnpm docs:dev
pnpm docs:build

pnpm install wires the repo-local pre-push hook automatically. Every git push runs pnpm lint before the push proceeds.

Updating snapshots

When you intentionally change rules or update plugins:

pnpm --filter eslint-config-setup exec vitest run --update

Review the snapshot diff carefully. It shows exactly which rules changed.