Skip to content
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

chore: improve proto formatting #12656

Merged
merged 6 commits into from
Jul 21, 2022
Merged

chore: improve proto formatting #12656

merged 6 commits into from
Jul 21, 2022

Conversation

julienrbrt
Copy link
Member

Description

Follow-up on #12643 (comment)

Turns out, we need to disable the formatter for cosmos.orm.v1.table.
I have not found any option for doing that directly in the .clang-format config file.
There was a typo as well for the formatter style. It should have been Google instead of google.

I have re-ran make proto-all as well.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt requested a review from a team as a code owner July 20, 2022 14:46
Copy link
Contributor

@amaury1093 amaury1093 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indentation looks better! Thanks

@@ -7,31 +7,33 @@ import "google/protobuf/duration.proto";
import "cosmos/orm/v1/orm.proto";

message ExampleTable {
// clang-format off
Copy link
Member

@tac0turtle tac0turtle Jul 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not a crazy fan about these. it seems to add overhead in the .pb.go files Are we able to remove these?

Copy link
Member Author

@julienrbrt julienrbrt Jul 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not add anything in the .pb.go. make proto-all added unrelated changes. If you like, I can only run make proto-format in this PR.

I agree the comments are not super useful, but it does make the proto file way easier to read with correct indentation. It is only required for cosmos.orm.v1.table.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah nvm ignore the comment. Was weird how the bytes changed

@julienrbrt julienrbrt requested a review from tac0turtle July 20, 2022 16:21
@alexanderbez alexanderbez added the A:automerge Automatically merge PR once all prerequisites pass. label Jul 21, 2022
@mergify mergify bot merged commit 0b69859 into main Jul 21, 2022
@mergify mergify bot deleted the julien/impv-proto-format branch July 21, 2022 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. C:orm C:x/distribution distribution module related C:x/params C:x/upgrade
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants