yoheimuta / yoheimuta/protolint
Some rules do not support auto-disable
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 699
- Forks
- 64
- PR merge metrics
- No merged PRs in 30d
Description
I'm attempting to apply the default rules set to existing proto files. My understanding is that applying -auto_disable should apply the appropriate comment for disabling. However, I still see violations for the following rules after using -auto_disable:
- ENUM_FIELDS_HAVE_COMMENT
- ENUMS_HAVE_COMMENT
- FIELD_NAMES_EXCLUDE_PREPOSITIONS
- FIELDS_HAVE_COMMENT
- FILE_HAS_COMMENT
- MAX_LINE_LENGTH
- MESSAGE_NAMES_EXCLUDE_PREPOSITIONS
- MESSAGES_HAVE_COMMENT
- RPC_NAMES_UPPER_CAMEL_CASE
- RPCS_HAVE_COMMENT
- SERVICES_HAVE_COMMENT
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the -auto_disable option and how it handles the listed rules. Reproduce the issue against existing proto files using the default rules set, then compare the rules that receive disable comments with those that still report violations. Done means all listed rules are handled consistently or their unsupported behavior is clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, devtools
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100