fix(js): handle arbitrary nested ts path mappings when re-mapping them to the outputs #27429
+34
−14
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 7245d6b. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 4 targets
Sent with 💌 from NxCloud. |
jaysoo
approved these changes
Aug 16, 2024
FrozenPandaz
pushed a commit
that referenced
this pull request
Aug 19, 2024
…m to the outputs (#27429) <!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> When re-mapping a TS path mapping like `"@foo/lib1/plugins/some-file": ["packages/lib1/src/plugins/some-file.ts"]`, it results in: ```json "@foo/lib1/plugins/some-file": [ "dist/packages/lib1/plugins/some-file", "dist/packages/lib1/src/plugins/some-file.ts" ] ``` The first path is wrong because it's missing the `src` directory, and the second one has a file extension that's not in the output. ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> When re-mapping a TS path mapping like `"@foo/lib1/plugins/some-file": ["packages/lib1/src/plugins/some-file.ts"]`, it should result in: ```json "@foo/lib1/plugins/some-file": [ "dist/packages/lib1/plugins/some-file", "dist/packages/lib1/src/plugins/some-file", "dist/packages/lib1/src/plugins/some-file.ts" ] ``` In this case, the second path would correctly point to the output. It doesn't have an extension, which allows the compiler to pick up the correct one. Note that while the first and third paths are still not valid for this specific use case, they could still be valid for other use cases, and in any case, they're still kept for backward compatibility. The util to re-map these paths is currently very generic and generates potentially valid paths. The invalid paths for a given use case won't throw an error as long as there's one that's valid. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #21699 (cherry picked from commit 89f6ad4)
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Current Behavior
When re-mapping a TS path mapping like
"@foo/lib1/plugins/some-file": ["packages/lib1/src/plugins/some-file.ts"], it results in:The first path is wrong because it's missing the
srcdirectory, and the second one has a file extension that's not in the output.Expected Behavior
When re-mapping a TS path mapping like
"@foo/lib1/plugins/some-file": ["packages/lib1/src/plugins/some-file.ts"], it should result in:In this case, the second path would correctly point to the output. It doesn't have an extension, which allows the compiler to pick up the correct one.
Note that while the first and third paths are still not valid for this specific use case, they could still be valid for other use cases, and in any case, they're still kept for backward compatibility. The util to re-map these paths is currently very generic and generates potentially valid paths. The invalid paths for a given use case won't throw an error as long as there's one that's valid.
Related Issue(s)
Fixes #21699