all: add starred-block comment style, improve comment parsing #12
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
joshuasing
added
type: refactor
joshuasing
changed the title
Improve comment parsing and remove unnecessary scan to detect comment style prior to parsing. This also adds a "starred-block" comment style, as it is used by some projects. Additionally, add functionality to detect and entirely ignore directive comments when detecting an existing header comment, to prevent build directive comments from being overriden/replaced.
joshuasing
force-pushed
the
joshua/comments
branch
from
9376461 to
68e1dbb
Compare
joshuasing
commented
Apr 20, 2025
| header = cs.Parse(header) | ||
| header, cs, err := parseComment(header) | ||
| if err != nil { | ||
| return "", false, fmt.Errorf("parse header comment: %w", err) |
There was a problem hiding this comment.
We should ideally never fail to lint ever, so instead of failing here, if we can't parse the comment I think it makes sense to either ignore the file or generate a new header instead.
The only reason to fail should be bad user input or an error from a template, I think.
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.
Improve comment parsing and remove unnecessary scan to detect comment
style prior to parsing. This also adds a "starred-block" comment style,
as it is used by some projects.
Additionally, add functionality to detect and entirely ignore directive
comments when detecting an existing header comment, to prevent build
directive comments from being overridden/replaced.