mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-16 11:23:11 -06:00
Code Issues Packages Projects Releases Wiki Activity

replaced gometalinter description with golangci-lint

Browse source 
Signed-off-by: Arshpreet <7arshpreet@gmail.com>
This commit is contained in:
Arshpreet 2019-12-23 18:33:33 +05:30
parent b34fce0d85
commit 227a953e93
1 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CODE_STYLE.md
View file

@ -5,17 +5,15 @@ considerations.
## Linters ## Linters
We use `gometalinter` to run a number of linters, the exact list can be found We use `golangci-lint` to run a number of linters, the exact list can be found under linters
in [linter.json](linter.json). Some of these are slow and expensive to run, but in [.golangci.yml](.golangci.yml). [Installation](https://github.com/golangci/golangci-lint#install) and [Editor Integration](https://github.com/golangci/golangci-lint#editor-integration) for it can be found in the readme of golangci-lint.
a subset can be found in [linter-fast.json](linter-fast.json) that run quickly
enough to be run as part of an IDE.
For rare cases where a linter is giving a spurious warning, it can be disabled For rare cases where a linter is giving a spurious warning, it can be disabled
for that line or statement using a [comment directive](https://github.com/alecthomas/gometalinter#comment-directives), e.g. for that line or statement using a [comment directive](https://github.com/alecthomas/gometalinter#comment-directives), e.g.
`// nolint: gocyclo`. This should be used sparingly and only when its clear `// nolint: gocyclo`. This should be used sparingly and only when its clear
that the lint warning is spurious. that the lint warning is spurious.
The linters are vendored, and can be run using [scripts/find-lint.sh](scripts/find-lint.sh) The linters can be run using [scripts/find-lint.sh](scripts/find-lint.sh)
(see file for docs) or as part of a build/test/lint cycle using (see file for docs) or as part of a build/test/lint cycle using
[scripts/build-test-lint.sh](scripts/build-test-lint.sh). [scripts/build-test-lint.sh](scripts/build-test-lint.sh).
@ -82,9 +80,9 @@ sets up linting correctly:
```json ```json
{ {
"go.gopath": "${workspaceRoot}:${workspaceRoot}/vendor", "go.lintTool":"golangci-lint",
"go.lintOnSave": "workspace", "go.lintFlags": [
"go.lintTool": "gometalinter", "--fast"
"go.lintFlags": ["--config=linter-fast.json", "--concurrency=5"] ]
} }
``` ```