fix: normalize paths in get-options-overrides
#331
Merged
Conversation
This file contains hidden or 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 `outDir` was not normalized after the `/placeholder` part was
added to `cacheRoot`
- `cacheRoot` could have `\` directory separators on it on Windows,
which caused some tests to fail on Windows before
- tests have been normalized now too
- `expandIncludeWithDirs` used `path.join` without normalizing after
- `path.join` uses the OS's native separators (`posix.join` would do
POSIX separators only), so when the paths were already normalized
and then `path.join`ed, this would cause mixed separators on Windows
- this fixes the current CI failure on Windows in the `createFilter`
tests (`rootDirs` and `projectReferences`, which use
`expandIncludeWithDirs`)
- c.f. https://github.com/ezolenko/rollup-plugin-typescript2/runs/6516149780?check_suite_focus=true
agilgur5
added
kind: bug
This was referenced May 26, 2022
|
All tests pass on Windows now! Hoping we don't have to deal with path normalization again for a while now 😅 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
get-options-overrides.tshad some paths that were not normalized, resulting in mixed separators on Windows in certain cases.get-options-overrides(createFilter) #329 (comment)get-options-overrides(createFilter) #329 (comment)Details
the
outDirwas not normalized after the/placeholderpart was added tocacheRootcacheRootcould have\directory separators on it on Windows, which caused some tests to fail on Windows beforeexpandIncludeWithDirsusedpath.joinwithout normalizing afterpath.joinuses the OS's native separators (posix.joinwould do POSIX separators only), so when the paths were already normalized and thenpath.joined, this would cause mixed separators on WindowscreateFiltertests (rootDirsandprojectReferences, which useexpandIncludeWithDirs)Review Notes
This should just be a bugfix and not breaking, but per the linked discussions, I'm really not sure how these bugs haven't been found yet by consumers -- I'm guessing that TS does normalization on
outDir(lots of redundant normalization necessary due to ambiguous inputs) and thatrootDirsandprojectReferencesjust aren't used by many Windows users.