Fix traversing the directory hierarchy on WindowsOS / Ant-style path matching #1615
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
…b in which always uses "/" as separator Closes pinterest#1599
Goooler
reviewed
Aug 28, 2022
Comment on lines
+214
to
+218
| private val onWindowsOS | ||
| get() = | ||
| System | ||
| .getProperty("os.name") | ||
| .startsWith("windows", true) |
There was a problem hiding this comment.
Suggested change
| private val onWindowsOS | |
| get() = | |
| System | |
| .getProperty("os.name") | |
| .startsWith("windows", true) | |
| private val onWindowsOS: Boolean | |
| get() = System.getProperty("os.name").startsWith("windows", true) |
…which would lead to exception
…matching Globs always use a "/" as directory separator on all OS's. Input patterns containing a "\" on Windows OS are transformed to "/" as users on Windows more likely would assume that the "\" may be used. On WindowsOS, transform "\" in the filepath to "/" before comparing the filename with the regular expression (of the glob) which always uses "/" as separator. Refactor all logic which create globs based on an input path. - If a path (absolute or relative) point to a directory, that path is expanded to the default globs (*.kt, *.kts) in that specific directory or any of its subdirectories. - If a path (absolute or relative) does not point to a directory, e.g. it points to a file, or it is a pattern. See "**" replacement below. - On Windows OS patters containing a "*" (or "**") can not be resolved with default Paths utilities. In such case the given input pattern is handled as is. See "**" replacement below. Patterns that contain one or more occurrence of a "**" are split into multiple patterns so that files on that specific path and subdirectories will be matched. - For example, for path "some/path/**/*.kt" an additional pattern "some/path/*.kt" is generated to make sure that not only the "*.kt" files in a subdirectory of "some/path/" are found but also the "*.kt" in directory "some/path" as well. This is in sync with the "**" notation in a glob which should be interpreted as having zero or more intermediate subdirectories. - For example, for path "some/**/path/**/*.kt", multiple additional patterns are generated. As it contains two "**" patterns, 2 x 2 patterns are needed to match all possible combinations: - "some/**/path/**/*.kt" - "some/**/path/*.kt" - "some/path/**/*.kt" - "some/path/*.kt" Finally, on Windows OS more fixes are needed as the resulting globs may not contain any drive destinations as the start of the path. Such a drive destination is replaced with a "**". So "D:/some/path/*.kt" becomes "/some/path/*.kt". Note that the last glob representation is less strict than the original pattern as it could match on other drives that "D:/" as well. Extend trace logging. Closes pinterest#1600 Closes pinterest#1601
paul-dingemans
changed the title
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
Globs always use a "/" as directory separator on all OS's. Input patterns containing a "" on Windows OS are transformed to "/" as users on Windows more likely would assume that the "" may be used.
On WindowsOS, transform "" in the filepath to "/" before comparing the filename with the regular expression (of the glob) which always uses "/" as separator.
Refactor all logic which create globs based on an input path.
points to a file, or it is a pattern. See "**" replacement below.
Patterns that contain one or more occurrence of a "**" are split into multiple patterns so that files on that specific path and subdirectories will be matched.
- "some//path/**/.kt"
- "some//path/*.kt"
- "some/path//.kt"
- "some/path/.kt"
Finally, on Windows OS more fixes are needed as the resulting globs may not contain any drive destinations as the start of the path. Such a drive destination is replaced with a "**". So "D:/some/path/.kt" becomes "/some/path/.kt". Note that the last glob representation is less strict than the original pattern as it could match on other drives that "D:/" as well.
Extend trace logging.
Closes #1600
Closes #1601
Checklist
CHANGELOG.mdis updatedIn case of adding a new rule: