mirror of
https://github.com/gravitational/teleport
synced 2024-10-22 10:13:21 +00:00
3ac5a0aedb
* Adjust go_package of lib/prehog Go protobufs This makes them follow the pattern set out by api/proto and proto. * Adjust go_package of lib/teleterm Go protobufs * Use single buf.gen.yaml to generate JS protos This also entailed changing the location of lib/teleterm protos and changing the value of their package specifier to match the conventions in other parts of the codebase. This is a breaking change but that is fine for Connect as the protos are used locally only and each build ships with matching protobufs. * Make web/packages/teleterm use protobufs from gen-proto-js We used to copy protobufs over to web/packages/teleterm/src/services/tshd since webapps used to be in a separate repo. This is no longer the case, so we can just make teleterm use protobufs from gen-proto-js. * Move prehog & teleterm protos into proto/teleport/lib * Generate JS protos to gen/proto/js * Move lib/teleterm Go protobufs to gen/proto/go * Move lib/prehog Go protobufs to gen/proto/go * Rename lib/teleterm proto package * Re-enable linter rules for teleterm & prehog * Update prehogv1 path in usagereporter_test.go * Use except instead of ignore_only to allow Google API-style responses * Add UNARY_RPC to api/proto & proto * Ignore gen/ when running addlicense * buf-js.gen.yaml: Remove comment about lack of go_package for JS * Move prehog protos to proto/prehog/v1alpha * Adjust prehog's go_package to match proto package
48 lines
1.5 KiB
YAML
48 lines
1.5 KiB
YAML
version: v1
|
|
lint:
|
|
use:
|
|
- DEFAULT
|
|
- PACKAGE_NO_IMPORT_CYCLE
|
|
- UNARY_RPC
|
|
# Top-level types require comments.
|
|
- COMMENT_ENUM
|
|
- COMMENT_MESSAGE
|
|
- COMMENT_RPC
|
|
- COMMENT_SERVICE
|
|
except:
|
|
# Allow Google API-style responses (CreateFoo returns Foo).
|
|
# See https://cloud.google.com/apis/design/standard_methods.
|
|
- RPC_REQUEST_RESPONSE_UNIQUE
|
|
- RPC_RESPONSE_STANDARD_NAME
|
|
ignore:
|
|
# "legacy" lib protos.
|
|
- teleport/lib/multiplexer/test/ping.proto
|
|
- teleport/lib/web/envelope.proto
|
|
ignore_only:
|
|
# Allow only certain services to use streaming RPCs.
|
|
#
|
|
# We should avoid streaming RPCs until we have a compelling reason to use them (e.g. the
|
|
# implementation needs 1-N messages or the server cannot dial directly to the client).
|
|
#
|
|
# Check out the links below. If you still have questions or doubts, reach out to @codingllama.
|
|
#
|
|
# https://docs.buf.build/lint/rules#unary_rpc
|
|
# https://github.com/gravitational/teleport/pull/16043#issuecomment-1235728212
|
|
# https://github.com/twitchtv/twirp/issues/70#issuecomment-470367807
|
|
UNARY_RPC:
|
|
- teleport/lib/teleterm/v1/service.proto
|
|
# TODO(ravicious): Fix protos and re-enable lib/teleterm lint rules below.
|
|
RPC_REQUEST_STANDARD_NAME:
|
|
- teleport/lib/teleterm
|
|
# TODO(espadolini): Fix protos and re-enable prehog lint rules below.
|
|
COMMENT_MESSAGE:
|
|
- teleport/lib/teleterm
|
|
- prehog
|
|
COMMENT_RPC:
|
|
- prehog
|
|
COMMENT_SERVICE:
|
|
- prehog
|
|
breaking:
|
|
use:
|
|
- FILE
|