[AssetMapper] Ignore comment lines in JavaScriptImportPathCompiler #53893
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
weaverryan
approved these changes
Feb 10, 2024
fabpot
approved these changes
Feb 10, 2024
fabpot
reviewed
Feb 10, 2024
| * | ||
| * @see https://regex101.com/r/1iBAIb/1 | ||
| */ | ||
| private const IMPORT_PATTERN = '/^(?:\/\/.*)|(?:\'(?:[^\'\\\\]|\\\\.)*\'|"(?:[^"\\\\]|\\\\.)*")|(?:import\s*(?:(?:\*\s*as\s+\w+|\s+[\w\s{},*]+)\s*from\s*)?|\bimport\()\s*[\'"`](\.\/[^\'"`]+|(\.\.\/)*[^\'"`]+)[\'"`]\s*[;\)]?/m'; |
There was a problem hiding this comment.
We can probably inline the comments directly in the regex (and add some spaces/new lines) to make the regex more easily understandable by using /ms.
There was a problem hiding this comment.
Is that better... or a bit too much ?
private const IMPORT_PATTERN = '/
^
(?:\/\/.*) # Lines that start with comments
|
(?:
\'(?:[^\'\\\\]|\\\\.)*\' # Strings enclosed in single quotes
|
"(?:[^"\\\\]|\\\\.)*" # Strings enclosed in double quotes
)
|
(?: # Import statements (script captured)
import\s*
(?:
(?:\*\s*as\s+\w+|\s+[\w\s{},*]+)
\s*from\s*
)?
|
\bimport\(
)
\s*[\'"`](\.\/[^\'"`]+|(\.\.\/)*[^\'"`]+)[\'"`]\s*[;\)]
?
/mx';There was a problem hiding this comment.
Another solution can be :
private const PATTERN_LINES_START_WITH_COMMENTS = '(?:\/\/.*)';
private const PATTERN_STRINGS_ENCLOSED_SINGLE_OR_DOUBLE_QUOTES = '(?:
\'(?:[^\'\\\\]|\\\\.)*\' # Strings enclosed in single quotes
|
"(?:[^"\\\\]|\\\\.)*" # Strings enclosed in double quotes
)
';
// ...And you concat everything in the IMPORT_PATTERN. What do you think about it ?
There was a problem hiding this comment.
I genuinely have no opinion here, just happy if the next person to work with this pattern does not lose time to understand why and how we made this regexp :) So you guys tell me
fabpot
approved these changes
Feb 11, 2024
|
Thank you @smnandre. |
4927b8e to
41a3489
Compare
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.
The following code was wrongly treated as one line of comment
This PR updates the regexp to ignore comment lines (and fix #53849)
Also added a comment explaining how the regexp works for future maintenance.