forked from quic-go/quic-go
e2031b7aeb
* Update comment styles 1. Use doc links (the square brackets around identifiers) to make clickable links on pkg.go.dev (https://go.dev/doc/comment#doclinks) 2. Indent lists so that they are rendered properly -- at which point go fmt updates the bullet character to a dash (https://go.dev/doc/comment#lists) 3. Add a couple missing punctuation marks These all will improve the experience of browsing the quic-go docs on pkg.go.dev. * ignore SA1019 for the ConnectionTracingID * ci: exclude ConnectionTracing(ID, Key) from staticlint in http3 --------- Co-authored-by: Marten Seemann <martenseemann@gmail.com>
75 lines
1.6 KiB
YAML
75 lines
1.6 KiB
YAML
version: "2"
|
|
linters:
|
|
default: none
|
|
enable:
|
|
- asciicheck
|
|
- copyloopvar
|
|
- depguard
|
|
- exhaustive
|
|
- govet
|
|
- ineffassign
|
|
- misspell
|
|
- prealloc
|
|
- staticcheck
|
|
- unconvert
|
|
- unparam
|
|
- unused
|
|
settings:
|
|
depguard:
|
|
rules:
|
|
quicvarint:
|
|
list-mode: strict
|
|
files:
|
|
- '**/github.com/quic-go/quic-go/quicvarint/*'
|
|
- '!$test'
|
|
allow:
|
|
- $gostd
|
|
misspell:
|
|
ignore-rules:
|
|
- ect
|
|
exclusions:
|
|
generated: lax
|
|
presets:
|
|
- comments
|
|
- common-false-positives
|
|
- legacy
|
|
- std-error-handling
|
|
rules:
|
|
- linters:
|
|
- depguard
|
|
path: internal/qtls
|
|
- linters:
|
|
- exhaustive
|
|
- prealloc
|
|
- unparam
|
|
path: _test\.go
|
|
- linters:
|
|
- staticcheck
|
|
path: _test\.go
|
|
text: 'SA1029:' # inappropriate key in call to context.WithValue
|
|
# WebTransport still relies on the ConnectionTracingID and ConnectionTracingKey.
|
|
# See https://github.com/quic-go/quic-go/issues/4405 for more details.
|
|
- linters:
|
|
- staticcheck
|
|
paths:
|
|
- http3/
|
|
- integrationtests/self/http_test.go
|
|
text: 'SA1019:.+quic\.ConnectionTracing(ID|Key)'
|
|
paths:
|
|
- internal/handshake/cipher_suite.go
|
|
- third_party$
|
|
- builtin$
|
|
- examples$
|
|
formatters:
|
|
enable:
|
|
- gofmt
|
|
- gofumpt
|
|
- goimports
|
|
exclusions:
|
|
generated: lax
|
|
paths:
|
|
- internal/handshake/cipher_suite.go
|
|
- third_party$
|
|
- builtin$
|
|
- examples$
|