fix: escape backticks in package comment for generated code#550
Open
Yanhu007 wants to merge 1 commit intomagefile:masterfrom
Open
fix: escape backticks in package comment for generated code#550Yanhu007 wants to merge 1 commit intomagefile:masterfrom
Yanhu007 wants to merge 1 commit intomagefile:masterfrom
Conversation
When a magefile's package comment contains backticks (e.g. "called with `go tool mage`"), the generated mage_output_file.go embeds the comment in a raw string literal delimited by backticks. The backticks in the comment terminate the string early, producing invalid Go code. Use fmt's %q verb to produce a properly quoted string instead of a raw backtick literal. Fixes magefile#537
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
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.
Fixes #537
Problem
When a magefile's package comment contains backticks, the generated
mage_output_file.gobreaks:The backticks in the comment terminate the raw string literal, producing invalid Go.
Fix
Use
%q(Go quoted string) instead of embedding in a raw backtick literal:This properly escapes any special characters including backticks.
Testing
All mage tests pass.