Remove flow type annotations, set up ESLint #623
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
I did this by running: ``` npm init @eslint/config@latest ```
We know that we do not want to use flow anymore. We may want to adopt TypeScript, but it is unclear if we will in the near term. #593 I want to re-introduce ESLint, and instead of setting up ESLint to be able to parse flow syntax, I decided that we should just remove it. #608 I removed these annotations by running the following command: ``` npx flow-remove-types lib/ -d lib/ ``` Then I formatted the files by running prettier on everything: ``` node_modules/.bin/prettier -w lib/ ``` I think if we wanted to introduce TypeScript that it might be easier to do it from scratch anyway instead of attempting to convert the flow types over to a different type system.
TypeScript pretty much won, and we've removed Flow annotations from this repo.
For convenience.
This is a node project, not a browser project, so we need to use the node globals. And we also need to tell ESLint about our tests, and how to ignore the stuff that used to be in the .eslintignore file. This resolves most of the errors.
Now that we have ESLint set up, we need to fix the things it complained about. This handles all of that in one commit.
This will help us avoid committing errors.
mikabytes
approved these changes
Jun 8, 2024
Closed
This will make it easier for folks to catch errors as they work.
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.
Related issues:
I decided to remove flow type annotations with this change because I didn't want to bother with setting up the new ESLint to understand the flow syntax. I also think that it might be easier to adopt TypeScript from this state than it would be to attempt to port over the flow types.
For now, I am just rolling with the default recommended ESLint configuration that they include with the base package, to get a decent baseline of ESLint rules enabled.
This is probably best reviewed commit-by-commit instead of all at once.