Support ESLint flat configuration #100
Merged
Conversation
This file contains 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 commit refactors `./src/index.js` to support ESLint's "new" flat
configuration file [1] in a non-disruptive, backwards-compatible manner.
The introduction of the flat configuration changed the "shape" of the
object that plugins should export. As a result, plugin authors are
adding confis with names like `flat/recommended` (as I've done here) for
consumers ot use. Rules for the "flat"-prefixed configurations are the
same as the legacy config, but with the exported objects conforming to
the new "flat" syntax.
I followed the recommendations in the plugin migration guide [2] with
inspiration drawn from the eslint-plugin-jsdoc's project [3].
Notable changes:
- adds the `meta` key as recommended by ESLint with name and version
drawn from `package.json`
- adds a `flat/recommended` configuration matching the rules set by the
existing `recommended configuration`
Usage in an `eslint.config.js` file would look like:
```js
import sortClassMembers from "eslint-plugin-sort-class-members";
export default [
sortClassMembers.configs["flat/recommended"],
rules: {
// etc. etc. etc.
},
];
```
[1] https://eslint.org/docs/latest/use/configure/configuration-files-new
[2] https://eslint.org/docs/latest/extend/plugin-migration-flat-config
[3] https://github.com/gajus/eslint-plugin-jsdoc/blob/main/src/index.js
|
Oh, shoot. In my enthusiasm for getting this PR open, I forgot to update the README. I'm happy to do that but will wait for any feedback on this PR first. |
|
Thanks for the PR and the thorough explanation! I'm kinda out of the loop on the flat config migration, but this looks inline with the recommendation as far as I can tell. If you wouldn't mind updating the docs that would be great! |
|
Thanks, @bryanrsmith! Added a bit of detail to the README.md in fe70442. Let me know what you think. |
|
Thank you! Published as v1.20.0. |
|
That's great news. Thanks, @bryanrsmith! |
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.
First off, thanks for considering this change! I've used your plugin for quite some time and it's been super helpful.
Description
(Drawn from commit message on 15ace41)
This PR refactors
./src/index.jsto support ESLint's "new" flat configuration file in a non-disruptive, backwards-compatible manner.The introduction of the flat configuration changed the "shape" of the object that plugins should export. As a result, plugin authors are adding confis with names like
flat/recommended(as I've done here) for consumers ot use. Rules for the "flat"-prefixed configurations are the same as the legacy config, but with the exported objects conforming to the new "flat" syntax.I followed the recommendations in the plugin migration guide with inspiration drawn from the eslint-plugin-jsdoc's project.
Notable changes:
metakey as recommended by ESLint with name and version drawn frompackage.jsonflat/recommendedconfiguration matching the rules set by the existingrecommended configurationUsage in an
eslint.config.jsfile would look like:…and also
I neglected to note the "before" in my commit message. Before this change, using this plugin in a "flat" configuration file is possible, but requires a bit of extra work: