Release Center

Documentation patch release

Useful READMEs, wherever you start.

Version 3.6.1 refreshes the package READMEs with clear setup examples, consistent artwork, quick navigation, and direct links to documentation and support. Configuration APIs, lint rules, and runtime requirements remain unchanged.

Release candidatev3.6.1

Highlights

• Package READMEs share light and dark artwork, version and license badges, and direct documentation, source, and changelog links.
• Framework adapters and feature packs show the dependencies to install and a working configuration example; deprecated packages point to their replacements.
• Contributor and private-workspace guides use the current Starlight documentation, correct support links, and commands that run the actual workspace checks.
• This patch changes documentation only. There are no API migrations or expected effective-rule changes.

Upgrade the package

Use these commands after the candidate has been published. Choose the command for your repository’s package manager; it updates within your declared dependency range. Moving from v2 requires the v2-to-v3 migration guide.

pnpmnpmYarnBun

bash

pnpm update @santi020k/eslint-config-basic

bash

npm update @santi020k/eslint-config-basic

bash

yarn up @santi020k/eslint-config-basic

bash

bun update @santi020k/eslint-config-basic

After upgrading, run:

pnpmnpmYarnBun

bash

pnpm dlx @santi020k/eslint-config-basic compatibility
pnpm dlx @santi020k/eslint-config-basic doctor
pnpm dlx @santi020k/eslint-config-basic inspect

bash

npx @santi020k/eslint-config-basic compatibility
npx @santi020k/eslint-config-basic doctor
npx @santi020k/eslint-config-basic inspect

bash

yarn dlx @santi020k/eslint-config-basic compatibility
yarn dlx @santi020k/eslint-config-basic doctor
yarn dlx @santi020k/eslint-config-basic inspect

bash

bunx @santi020k/eslint-config-basic compatibility
bunx @santi020k/eslint-config-basic doctor
bunx @santi020k/eslint-config-basic inspect

Verify your upgrade

1. Before changing dependencies, save an effective-rule snapshot with basic-eslint snapshot. If your current version does not support snapshots, record the existing lint output instead.
2. Update Basic and the framework or feature packs your project uses. Packages within the same major can have different minor and patch versions; follow their declared dependency and peer ranges instead of matching every version.
3. Run basic-eslint compatibility to check Node.js, ESLint, and installed package ranges, then basic-eslint doctor and basic-eslint inspect to diagnose setup problems and confirm detected features. Optional packs may require a newer Node.js version than the lean Basic package.
4. Run basic-eslint diff against the pre-upgrade snapshot, when available. Exit code 1 means effective rules changed; review those changes before refreshing the snapshot.
5. Run your lint script with zero allowed warnings, plus your project’s type checks and tests. See the editor and CI recipe for a minimal lint script and workflow.

These checks validate your project after an upgrade. Maintainer release preflight remains a separate gate.

Maintainer release process

Release branches use release/v<stable-semver> and must match the Basic package version. Both versioned release branches and Changesets-generated branches receive complete preflight and a dependency audit before publishing from the merged main commit. See the release preparation and recovery guide for validation, migration notes, recovery, and post-release verification.

Moving from an older major

For v2, follow the v2-to-v3 migration guide for the lean package boundary, optional package installs, and moved imports. For v1, start with v1-to-v2, then continue to v2-to-v3. Review migration output before using --write.

For package-level release notes, continue to the changelog index.