Fix -comment flag handling for multi-line values#8
Open
stevendpclark wants to merge 1 commit into
Open
Conversation
Summary
- When the -comment argument contains newline characters, the generated file now emits one // -prefixed line per segment instead of embedding the raw newline
inside a single comment line (which produces invalid Go)
- The same newline-in-args edge case is sanitized in the DO NOT EDIT header line by collapsing embedded newlines to spaces
- Replaces deprecated ioutil.TempFile with os.CreateTemp (deprecated since Go 1.16)
Root cause
g.Printf("// %s\n", comments.String()) emitted the comment as a single Printf call. If the string contained \n, the output would be:
// line one
line two // ← not a comment — syntax error
Fix
Split the comment string on \n and emit each segment as its own // … line.
Test plan
- TestCommentWithNewline — end-to-end test: builds the enumer binary, generates a file with -comment "line one\nline two", asserts both comment lines appear in
the output, and verifies the generated file compiles cleanly
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.
Summary
Root cause
g.Printf("// %s\n", comments.String()) emitted the comment as a single Printf call. If the string contained \n, the output would be:
// line one
line two // ← not a comment — syntax error
Fix
Split the comment string on \n and emit each segment as its own // … line.
Test plan