mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2025-12-23 06:15:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

ux: use docker to format proto files (#5384)

Browse Source 
## Description

Add a cmd to docker image and use it to format our proto files. This avoids developers the need to install clang-format

Closes: #XXX
This commit is contained in:
Marko
2020-09-22 23:42:55 +02:00
committed by GitHub
parent 0e311abf19
commit 0aecda68fc
7 changed files with 37 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
.clang-format Normal file
View File

@@ -0,0 +1,11 @@
---
Language: Proto
BasedOnStyle: Google
IndentWidth: 2
ColumnLimit: 0
AlignConsecutiveAssignments: true
AlignConsecutiveDeclarations: true
SpacesInSquareBrackets: true
ReflowComments: true
SortIncludes: true
SortUsingDeclarations: true

3
.vscode/settings.json vendored
View File

@@ -4,6 +4,5 @@
"--proto_path=${workspaceRoot}/proto", "--proto_path=${workspaceRoot}/proto",
"--proto_path=${workspaceRoot}/third_party/proto" "--proto_path=${workspaceRoot}/third_party/proto"
] ]
}, }
"clang-format.style": "{BasedOnStyle: Google, IndentWidth: 2, ColumnLimit: 0, AlignConsecutiveAssignments: true, AlignConsecutiveDeclarations: true, SpacesInSquareBrackets: true}",
} }

5
Makefile
View File

@@ -89,6 +89,11 @@ proto-lint:
@$(DOCKER_BUF) check lint --error-format=json @$(DOCKER_BUF) check lint --error-format=json
.PHONY: proto-lint .PHONY: proto-lint
proto-format:
@echo "Formatting Protobuf files"
docker run -v $(shell pwd):/workspace --workdir /workspace tendermintdev/docker-build-proto find ./ -not -path "./third_party/*" -name *.proto -exec clang-format -i {} \;
.PHONY: proto-format
proto-check-breaking: proto-check-breaking:
@$(DOCKER_BUF) check breaking --against-input .git#branch=master @$(DOCKER_BUF) check breaking --against-input .git#branch=master
.PHONY: proto-check-breaking .PHONY: proto-check-breaking

20
proto/tendermint/abci/types.proto
View File

@@ -334,9 +334,9 @@ message TxResult {
// Validator // Validator
message Validator { message Validator {
bytes address = 1; // The first 20 bytes of SHA256(public key) bytes address = 1; // The first 20 bytes of SHA256(public key)
// PubKey pub_key = 2 [(gogoproto.nullable)=false]; // PubKey pub_key = 2 [(gogoproto.nullable)=false];
int64 power = 3; // The voting power int64 power = 3; // The voting power
} }
// ValidatorUpdate // ValidatorUpdate
@@ -352,19 +352,19 @@ message VoteInfo {
} }
enum EvidenceType { enum EvidenceType {
UNKNOWN = 0; UNKNOWN = 0;
DUPLICATE_VOTE = 1; DUPLICATE_VOTE = 1;
LIGHT_CLIENT_ATTACK = 2; LIGHT_CLIENT_ATTACK = 2;
} }
message Evidence { message Evidence {
EvidenceType type = 1; EvidenceType type = 1;
// The offending validator // The offending validator
Validator validator = 2 [(gogoproto.nullable) = false]; Validator validator = 2 [(gogoproto.nullable) = false];
// The height when the offense occurred // The height when the offense occurred
int64 height = 3; int64 height = 3;
// The corresponding time where the offense occurred // The corresponding time where the offense occurred
google.protobuf.Timestamp time = 4 [ google.protobuf.Timestamp time = 4 [
(gogoproto.nullable) = false, (gogoproto.nullable) = false,
(gogoproto.stdtime) = true (gogoproto.stdtime) = true
]; ];

6
proto/tendermint/evidence/types.proto
View File

@@ -13,8 +13,8 @@ message List {
} }
message Info { message Info {
tendermint.types.Evidence evidence = 1 [(gogoproto.nullable) = false]; tendermint.types.Evidence evidence = 1 [(gogoproto.nullable) = false];
google.protobuf.Timestamp time = 2 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true]; google.protobuf.Timestamp time = 2 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
repeated tendermint.types.Validator validators = 3; repeated tendermint.types.Validator validators = 3;
int64 total_voting_power = 4; int64 total_voting_power = 4;
} }

8
proto/tendermint/types/evidence.proto
View File

@@ -14,14 +14,14 @@ message DuplicateVoteEvidence {
} }
message LightClientAttackEvidence { message LightClientAttackEvidence {
LightBlock conflicting_block = 1; LightBlock conflicting_block = 1;
int64 common_height = 2; int64 common_height = 2;
} }
message Evidence { message Evidence {
oneof sum { oneof sum {
DuplicateVoteEvidence duplicate_vote_evidence = 1; DuplicateVoteEvidence duplicate_vote_evidence = 1;
LightClientAttackEvidence light_client_attack_evidence = 2; LightClientAttackEvidence light_client_attack_evidence = 2;
} }
} }

6
proto/tendermint/types/types.proto
View File

@@ -26,13 +26,13 @@ enum SignedMsgType {
option (gogoproto.goproto_enum_stringer) = true; option (gogoproto.goproto_enum_stringer) = true;
option (gogoproto.goproto_enum_prefix) = false; option (gogoproto.goproto_enum_prefix) = false;
SIGNED_MSG_TYPE_UNKNOWN = 0 [(gogoproto.enumvalue_customname) = "UnknownType"]; SIGNED_MSG_TYPE_UNKNOWN = 0 [(gogoproto.enumvalue_customname) = "UnknownType"];
// Votes // Votes
SIGNED_MSG_TYPE_PREVOTE = 1 [(gogoproto.enumvalue_customname) = "PrevoteType"]; SIGNED_MSG_TYPE_PREVOTE = 1 [(gogoproto.enumvalue_customname) = "PrevoteType"];
SIGNED_MSG_TYPE_PRECOMMIT = 2 [(gogoproto.enumvalue_customname) = "PrecommitType"]; SIGNED_MSG_TYPE_PRECOMMIT = 2 [(gogoproto.enumvalue_customname) = "PrecommitType"];
// Proposals // Proposals
SIGNED_MSG_TYPE_PROPOSAL = 32 [(gogoproto.enumvalue_customname) = "ProposalType"]; SIGNED_MSG_TYPE_PROPOSAL = 32 [(gogoproto.enumvalue_customname) = "ProposalType"];
} }
// PartsetHeader // PartsetHeader
@@ -144,7 +144,7 @@ message SignedHeader {
message LightBlock { message LightBlock {
SignedHeader signed_header = 1; SignedHeader signed_header = 1;
tendermint.types.ValidatorSet validator_set = 2; tendermint.types.ValidatorSet validator_set = 2;
} }
message BlockMeta { message BlockMeta {