build: configure ESLint for JSDoc types #249
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
johnhooks
commented
Apr 7, 2023
|
|
||
| return { | ||
| presets: ['@wordpress/babel-preset-default'], | ||
| presets: [ '@wordpress/babel-preset-default' ], |
There was a problem hiding this comment.
Most the configs didn't follow the linting rules.
johnhooks
commented
Apr 7, 2023
Comment on lines
+6
to
+12
| "include": [ | ||
| ".eslintrc.js", | ||
| ".prettierrc.js", | ||
| "babel.config.js", | ||
| "jest.config.js", | ||
| "webpack.config.js" | ||
| ] |
There was a problem hiding this comment.
|
Another benefit to this is it lints the config files in the top level now. |
johnhooks
changed the title
johnhooks
force-pushed
the
build/config-eslint-for-ts
branch
from
7f7ed04
to
8368936
Compare
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.
What?
ESLint configuration requires some tweaks to work well with JSDoc types.
Why?
Without this changes there are linting errors when importing JSDoc types from other files.
How?
Add the TypeScript import resolver and configure properly.
Details of why
jsconfig.eslint.jsonis also necessary can be found here https://typescript-eslint.io/linting/troubleshooting/#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file