Skip to content

Fix removeSemicolons() corrupting dollar-slashy strings, escaped triple quotes and for headers - #3170

Open
Pankraz76 wants to merge 1 commit into
diffplug:mainfrom
Pankraz76:fix/remove-semicolons-dollar-slashy-and-for
Open

Pankraz76 wants to merge 1 commit into
diffplug:mainfrom
Pankraz76:fix/remove-semicolons-dollar-slashy-and-for

Conversation

@Pankraz76

Copy link
Copy Markdown

Follow-up to #2780. The scanner still removed semicolons that are part of the program:

  • inside dollar-slashy strings ($/ ... /$), the idiomatic way to embed JS/SQL in Groovy, same use case as removeSemicolons() should not be applied to multiline strings in groovy #2780
  • after an escaped triple quote (\""" / \''') inside a multiline string, which flipped the scanner state for the rest of the literal
  • at the end of a line inside a multi-line for (init; cond; update) header, producing code that no longer compiles

Rewrite the boolean-flag scanner as an explicit mode state machine and protect only semicolons whose innermost open bracket is a for header, so semicolons in closures passed as arguments are still removed. Plain slashy strings remain unsupported (ambiguous with division without a real lexer) and this is documented.

Output is byte-identical to the previous implementation on all 163 files in testlib/src/main/resources. Adds a fast StepHarness unit test.

Claude-Session: https://claude.ai/code/session_01MTr23zHsJ17K1kvSQYF4AH

Please DO NOT FORCE PUSH. Don't worry about messy history, it's easier to do code review if we can tell what happened after the review, and force pushing breaks that.

Please make sure that your PR allows edits from maintainers. Sometimes it's faster for us to just fix something than it is to describe how to fix it.

Allow edits from maintainers

After creating the PR, please add a commit that adds a bullet-point under the [Unreleased] section of CHANGES.md, plugin-gradle/CHANGES.md, and plugin-maven/CHANGES.md which includes:

  • a summary of the change
  • either
    • a link to the issue you are resolving (for small changes)
    • a link to the PR you just created (for big changes likely to have discussion)

If your change only affects a build plugin, and not the lib, then you only need to update the plugin-foo/CHANGES.md for that plugin.

If your change affects lib in an end-user-visible way (fixing a bug, updating a version) then you need to update CHANGES.md for both the lib and all build plugins. Users of a build plugin shouldn't have to refer to lib to see changes that affect them.

This makes it easier for the maintainers to quickly release your changes :)

…eaders

Follow-up to diffplug#2780. The scanner still removed semicolons that are part of
the program:

- inside dollar-slashy strings (`$/ ... /$`), the idiomatic way to embed
  JS/SQL in Groovy, same use case as diffplug#2780
- after an escaped triple quote (`\"""` / `\'''`) inside a multiline
  string, which flipped the scanner state for the rest of the literal
- at the end of a line inside a multi-line `for (init; cond; update)`
  header, producing code that no longer compiles

Rewrite the boolean-flag scanner as an explicit mode state machine and
protect only semicolons whose innermost open bracket is a `for` header,
so semicolons in closures passed as arguments are still removed. Plain
slashy strings remain unsupported (ambiguous with division without a
real lexer) and this is documented.

Output is byte-identical to the previous implementation on all 163 files
in testlib/src/main/resources. Adds a fast StepHarness unit test.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MTr23zHsJ17K1kvSQYF4AH

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant