-
Notifications
You must be signed in to change notification settings - Fork 396
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: Configure crate-ci/typos and auto fix what I can #1551
Conversation
// ArgDatabaseTopicMesssageDownConversionEnable determines whether brokers should convert messages for consumers expecting older message formats | ||
ArgDatabaseTopicMesssageDownConversionEnable = "message-down-conversion-enable" | ||
// ArgDatabaseTopicMessageDownConversionEnable determines whether brokers should convert messages for consumers expecting older message formats | ||
ArgDatabaseTopicMessageDownConversionEnable = "message-down-conversion-enable" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is a "code aware" spell checker, any chance you happen to know if there is a way to exclude existing exported vars/consts? That's not really an issue for doctl itself, but if we were to bring this into say godo, we'd want to avoid breaking changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so best i've found in the past was default.extend-identifiers
in the config, but nothing automated
I believe typos also has a cli flag for listing all the identifiers it finds
that being said, fixing the spelling is an easy breaking change to handle for end users, its not like they have to figure out how to rewrite code because a function no longer exists.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff! I've been meaning to get to adding something like this. Thanks 🙏
Could you add a note somewhere in the CONTRIBUTING.md around how to run/set this up for local dev?
I can when I get a minute. Do you want a PR github action too? |
If you're up for it. That would be great. We can add that latter too to no block this PR. |
decided to do it seperately |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Thanks again Gavin!
Can setup a github action too
https://github.com/crate-ci/typos/blob/master/docs/github-action.md