Flatter #228
Merged
Flatter #228
+3,607
−528
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
I forgot to add `eslint-plugin-jsdoc` when creating our new configuration, even though it's present in the legacy configurations. This change re-adds the plugin and configures it for better interaction with TypeScript.
BREAKING CHANGE: Configurations are now returned as objects, like most shared ESLint configurations. The `make*Config` functions are no more. Also, everything is now exported through one file.
See comments about `no-undef`
There was a problem hiding this comment.
Pull Request Overview
This PR replaces function‐generated configurations with flat static configurations for both ESLint and Prettier, following the latest community conventions. It updates various test examples (both good and bad) to reflect the new configuration style, revises legacy configuration files, and updates the documentation accordingly.
Reviewed Changes
Copilot reviewed 20 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| test/recommended/react.good.jsx | Valid React example using the new flat configuration. |
| test/recommended/react.bad.jsx | Bad React test case demonstrating expected ESLint errors. |
| test/recommended/plain.good.ts | Valid plain TypeScript example. |
| test/recommended/plain.good.mjs | Valid plain JavaScript example. |
| test/recommended/plain.bad.ts | Bad TypeScript test case with expected errors. |
| test/recommended/plain.bad.mjs | Bad JavaScript test case with expected errors (e.g. unexpected JSX). |
| test/recommended/eslint.config.mjs | ESLint configuration file updated to use flat configs. |
| test/eslint.test.mjs | Linting tests updated to reflect new configuration results. |
| prettier.config.mjs | Prettier configuration now exports a recommended config directly. |
| lib/prettier.mjs | Legacy Prettier config module updated to export the new recommended config. |
| lib/legacy/*.mjs | Legacy configuration files updated with proper type annotations. |
| lib/index.mjs | Re-exports flat ESLint and Prettier configuration objects. |
| lib/eslint.mjs | ESLint configurations revamped to align with flat configuration style. |
| eslint.config.mjs | Main ESLint config file now uses the flat configuration API. |
| README.md | Documentation updated to explain the flat configuration usage. |
Files not reviewed (2)
- package.json: Language not supported
- test/snapshots/eslint.test.mjs.snap: Language not supported
Comments suppressed due to low confidence (1)
lib/eslint.mjs:353
- The variable 'eslintConfigPrettier' is referenced but not defined. Consider replacing it with the appropriate Prettier configuration (for example, 'prettierConfigScratch.recommended') or importing its definition.
eslintConfigPrettier,
cwillisf
requested review from
georgyangelov,
KManolov3,
Bogomil-Stoyanov and
MiroslavDionisiev
georgyangelov
approved these changes
May 5, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed Changes
Follow
eslintcommunity conventions better by offering flat configurations rather than functions to generate them.Reason for Changes
I started trying to use the previous version (see #214) and realized it wasn't practical.
Test Coverage
Now with tests! It's not full coverage, but it at least covers our
recommendedruleset foreslint.I now also have a real-world example of this configuration in action: scratchfoundation/scratch-l10n#624