Deduplicate checks between ESLint and TypeScript #3008
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
openverse-bot
added
🟨 priority: medium
|
Size Change: -4.73 kB (-1%) Total Size: 891 kB
ℹ️ View Unchanged
|
sarayourfriend
changed the title
obulat
approved these changes
Sep 12, 2023
There was a problem hiding this comment.
In others, we disable TypeScript checks because ESLint handles them more flexible (i.e., still allows the project to build, which is useful during development, but still shows an error on linting).
This is a really nice change, thank you!
Tested this PR locally, and it behaved just as you describe: when there's an unused import, the app builds fine but you cannot commit.
| files: ["*.ts"], | ||
| rules: { | ||
| "tsdoc/syntax": "error", | ||
| // This rule is disabled above to avoid forcing ESM syntax on regular JS files |
There was a problem hiding this comment.
What does "forcing ESM syntax on regular JS files" mean here? Where do we do that?
There was a problem hiding this comment.
The disabled rule would raise on every usage of require in our regular JavaScript files and require them to be turned into import statements instead. Our tooling doesn't support that across the board, but our TypeScript files can abide by that rule (because TypeScript supports that syntax out of the box). If we wanted to enable this rule everywhere we would need to change the node scripts we run directly (locales, tapes, etc) to mjs... or run them with ts-node.
dhruvkb
approved these changes
Sep 15, 2023
Co-authored-by: Olga Bulat <[email protected]>
sarayourfriend
deleted the
update/disable-unnecessary-import-eslint-rules
branch
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.
Fixes
Fixes #3007 by @sarayourfriend
Description
Enables the import plugin's typescript config and does some additional configuration to improve the relationship between TypeScript and ESLint. In some cases, we disable ESLint rules because TypeScript already handles them. In others, we disable TypeScript checks because ESLint handles them more flexible (i.e., still allows the project to build, which is useful during development, but still shows an error on linting).
Testing Instructions
Checkout the branch and run
pnpm install && pnpm run eslintand confirm linting is working. Try something like importing or declaring an unused variable in a frontend file and confirm that you get an ESLint error when runningpnpm run eslint, but that you do not see a TS error about it when runningjust p frontend types.Checklist
Update index.md).main) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin