Add ESLint import resolver #31792
Merged
Add ESLint import resolver #31792
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
|
Size Change: 0 B Total Size: 1.3 MB ℹ️ View Unchanged
|
kevin940726
commented
May 13, 2021
.github/workflows/static-checks.yml
Outdated
| - name: Type checking | ||
| run: npm run build:package-types | ||
| - name: Build and type checking | ||
| run: npm run build |
There was a problem hiding this comment.
We probably don't even need to run the full build in this workflow? Just build:package-types is enough?
There was a problem hiding this comment.
I removed the build step. We can add it back if we really need it.
Great idea to use the custom resolver to remove the need for the build step for Gutenberg. We do something similar already for unit tests with a Jest mapper 👍🏻
I don't think we need a package. It isn't applicable outside of Gutenberg. It will make this PR simpler. |
Sure, but where should I put this file then? I don't think it belongs in |
There is the
|
kevin940726
force-pushed
the
add/eslint-import-resolver
branch
from
e7ee3ff
to
60eae9c
Compare
gziolo
reviewed
May 17, 2021
gziolo
reviewed
May 17, 2021
gziolo
approved these changes
May 17, 2021
6 tasks
7 tasks
|
@youknowriad noticed that WordPress dependencies can be added to the code and ESLint doesn't report it as a violation. It was caught during backporting to the
Those violations were already fixed in the The simplest way to test is to disable the resolver and import anything from |
|
Good catch! I indeed missed this case, I'll see what I can do in a follow-up PR. |
7 tasks
14 tasks
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.
Description
eslint-plugin-importis using the default import resolver to resolve the packages. By default, it's looking for the "main" field inpackage.json. This works for most packages, but not automatically for internal@wordpress/*packages. We need to at least runnpm run devornpm run buildonce to generate the build files in order for the resolver to work. It isn't a big deal though, but wouldn't it be better if we can skip this step and just automatically reference the file to their source?This PR introduces a new internal package
@wordpress/eslint-import-resolverto handle the resolution of the@wordpress/*packages. It tries to fallback to finding the source file insrc/index.jswhenever the "main" file isn't present. For other external dependencies, it simply fallbacks to the default resolution usingeslint-import-resolver-node.The benefit of this is that it no longer requires the developers to build the packages before they can run
lint-js, or before the code editor's built-in linter shout at them.How has this been tested?
Return to a "clean state" of the project, that is, remove all of the
buildfolders.Install the dependencies, and then
lint-jsscript should work without extra steps. Or, do a clean clone of the project to a new directory.Types of changes
New feature
Checklist:
*.native.jsfiles for terms that need renaming or removal).