feat: make knip understand yarn pnp #924
Open
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
commit: |
jwoo0122
commented
Jan 22, 2025
There was a problem hiding this comment.
I made a real yarn workspace to test real pnp api, but it'll be good to see any ideas for this fixture.
This comment was marked as resolved.
This comment was marked as resolved.
jwoo0122
changed the title
jwoo0122
commented
Feb 8, 2025
Comment on lines
+14
to
+37
| const findNearestPnPFile = (startDir: string) => { | ||
| // Find the nearest .pnp.cjs file by traversing up | ||
| let currentDir = startDir; | ||
| while (currentDir !== '/') { | ||
| const pnpPath = join(currentDir, '.pnp.cjs'); | ||
| if (isFile(pnpPath)) { | ||
| const pnpApi = _require(pnpPath); | ||
| pnpApi.setup(); | ||
| pnpStatus.dir = startDir; | ||
| pnpStatus.pnpPath = pnpPath; | ||
| pnpStatus.enabled = true; | ||
| return; | ||
| } | ||
| // Move up one directory | ||
| const parentDir = dirname(currentDir); | ||
| if (parentDir === currentDir) { | ||
| break; // Reached root | ||
| } | ||
| currentDir = parentDir; | ||
| } | ||
| pnpStatus.dir = startDir; | ||
| pnpStatus.pnpPath = ''; | ||
| pnpStatus.enabled = false; | ||
| }; |
There was a problem hiding this comment.
I made this by assuming that knip needs to be able to understand yarn pnp, even if it isn't under yarn pnp environment, e.g yarn dlx knip. If it's not, we can just simply import pnpapi directly, instead of manually finding it.
|
Thanks for the PR, @jwoo0122. Without knowing exactly how PnP works, please let my try to understand what support for PnP means to Knip, and what features (i.e. issue types) are still (un)available/relevant. Some initial questions that pop up in my mind:
|
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.
Make knip understand yarn pnp. It can now look into manifest files inside yarn cache, and correctly check peer dependency or bin field.
Maybe we can make this feature to be enabled with yarn plugin made from #864 but I couldn't find how to patch manifest helpers with plugin.
You should see
manifest/helpers.ts.