-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ESLint changes preparing for Prettier #2153
Merged
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 comment was marked as outdated.
This comment was marked as outdated.
The Jest plugin has been updated with flat config support, so all the pieces are in place. I could make a separate branch for the format/lint related PRs to land on so we run Prettier etc before affecting develop? |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This was referenced Jun 19, 2024
This was referenced Jul 16, 2024
This was referenced Aug 16, 2024
Open
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.
Pull Request
Problem
ESLint have deprecating the formatting rules, and suggest using a separate formatter.
Using StandardJS and TypeScript equivalent has been painful to maintain. (To be fair, partly because of how we ended up using it.)
See: #2104
Solution
Use ESLint for linting. Start with ESLint recommended rules.
Use Prettier for formatting. In a way this is quite like using Standard, opinionated so less setup and debate over settings! Installed and configured in this PR, but not used to format files yet to keep the PR focused on the setup changes.
I did a rework of the naming of the npm scripts so now
check
lint/format/type, andfix
lint/format.Note: I saw there was a new flat config for ESLint and liked the look of it. Flat config is going to be default in ESLint 9. I used the new config file name
eslint.config.js
so detected as flat from command-line with ESLint 8.Note:
eslint-plugin-jsdoc
installed but not activated yet, as will complain about multiple issues. Have also installedprettier-plugin-jsdoc
which will hopefully fix some of the lint issues! Will evaluate those in separate PR.For interest, I found a good blog after doing most of the work: https://www.joshuakgoldberg.com/blog/configuring-eslint-prettier-and-typescript-together/
ChangeLog