Skip to content

Commit 5e20411

Browse files
authored
feat: mark legacy-recommended config deprecated (#1331)
<!-- πŸ‘‹ Hi, thanks for sending a PR to eslint-plugin-package-json! πŸ—‚ Please fill out all fields below and make sure each item is true and [x] checked. Otherwise we may not be able to review your PR. --> ## PR Checklist - [x] Addresses an existing open issue: fixes #1329 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Following the decision made in #1253, this change marks the legacy config deprecated. It will be removed in roughly 6 months.
1 parent bffb12d commit 5e20411

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ npm install eslint eslint-plugin-package-json --save-dev
2828

2929
## Usage
3030

31-
### Flat Config
31+
### Config
3232

3333
This plugin's recommended configuration enables its rules on `**/package.json` files, parsing them with [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser).
3434

@@ -61,7 +61,7 @@ export default [
6161

6262
See [ESLint's _Configuration Files_ guide](https://eslint.org/docs/latest/use/configure/configuration-files-new) for details on how to customize your rules and other config settings.
6363

64-
### Legacy Config
64+
### Legacy Config (deprecated)
6565

6666
Usage with ESLint's legacy ("eslintrc") format requires also installing [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser):
6767

@@ -142,8 +142,8 @@ By default, this is:
142142
- `false` for [`require-name`](docs/rules/require-name.md) and [`require-version`](docs/rules/require-version.md).
143143
- `true` for every other `require-*` rule.
144144

145-
By specifying this setting as `true` or `false`, it will override the defaults and apply the setting for ALL rules.
146-
In that case, either all `require-*` rules will be applied to private packages or no `require-*` rules will be applied to private packages.
145+
By specifying this setting as `true` or `false`, it will override the defaults and apply the setting for ALL rules.
146+
In that case, either all `require-*` rules will be applied to private packages or no `require-*` rules will be applied to private packages.
147147
Even then, you can override the setting again at the rule level, by using the rule's `ignorePrivate` option, which will take precedence over this global setting.
148148

149149
### Usage Alongside Prettier

β€Žsrc/plugin.tsβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ const recommendedRules = {
7676

7777
export const plugin = {
7878
configs: {
79+
/** @deprecated please use the recommended (flat) config. This will be removed in early 2026 */
7980
"legacy-recommended": {
8081
plugins: ["package-json"],
8182
rules: recommendedRules,

0 commit comments

Comments
Β (0)