feat!: refactor plugin export to conform to latest conventions #957
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change refactors the plugin's exports to conform to the latest standards recommended by the ESLint team.
The plugin is still the default export, but it now has configs attached to it as well, but the legacy rc-based config (now called `'legacy-recommended'`) and the `recommended` flat-config.
For users of the flat config, you'll need to make the following changes.
```diff
- import packageJson from "eslint-plugin-package-json/configs/recommended";
+ import packageJson from "eslint-plugin-package-json";
export default [
- packageJson,
+ packageJson.configs.recommended,
];
```
For users of the legacy config, you'll need to make the following changes.
```diff
module.exports = {
overrides: [
{
- extends: ["plugin:package-json/recommended"],
+ extends: ["plugin:package-json/legacy-recommended"],
files: ["package.json"],
parser: "jsonc-eslint-parser",
},
],
};
```
BREAKING CHANGE
michaelfaith
force-pushed
the
fix/refactor-plugin-obj
branch
from
9879219 to
b85c967
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #957 +/- ##
==========================================
+ Coverage 98.77% 99.50% +0.73%
==========================================
Files 21 20 -1
Lines 1222 1221 -1
Branches 142 142
==========================================
+ Hits 1207 1215 +8
+ Misses 15 6 -9 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This change refactors the plugin's exports to conform to the latest standards recommended by the ESLint team.
The plugin is still the default export, but it now has configs attached to it as well, but the legacy rc-based config (now called `'legacy-recommended'`) and the `recommended` flat-config.
For users of the flat config, you'll need to make the following changes.
```js
- import packageJson from "eslint-plugin-package-json/configs/recommended";
+ import packageJson from "eslint-plugin-package-json";
export default [
- packageJson,
+ packageJson.configs.recommended,
];
```
For users of the legacy config, you'll need to make the following changes.
```js
module.exports = {
overrides: [
{
- extends: ["plugin:package-json/recommended"],
+ extends: ["plugin:package-json/legacy-recommended"],
files: ["package.json"],
parser: "jsonc-eslint-parser",
},
],
};
```
BREAKING CHANGE
|
🎉 This is included in version v0.26.4 🎉 The release is available on: Cheers! 📦🚀 |
3 tasks
This was referenced Mar 17, 2025
This was referenced Mar 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
status: accepting prsOverview
This change refactors the plugin's exports to conform to the latest standards recommended by the ESLint team.
The plugin is still the default export, but it now has configs attached to it as well, but the legacy rc-based config (now called
'legacy-recommended') and therecommendedflat-config.For users of the flat config, you'll need to make the following changes.
For users of the legacy config, you'll need to make the following changes.
module.exports = { overrides: [ { - extends: ["plugin:package-json/recommended"], + extends: ["plugin:package-json/legacy-recommended"], files: ["package.json"], parser: "jsonc-eslint-parser", }, ], };BREAKING CHANGE
Closes #752