You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
GolangCI-Lint is a linters aggregator. It's fast: on average [5 times faster](#performance) than gometalinter.
7
10
It's [easy to integrate and use](#command-line-options), has [nice output](#quick-start) and has a minimum number of false positives. It supports go modules.
@@ -10,22 +13,22 @@ GolangCI-Lint has [integrations](#editor-integration) with VS Code, GNU Emacs, S
10
13
11
14
Follow the news and releases on our [twitter](https://twitter.com/golangci) and our [blog](https://medium.com/golangci).
12
15
13
-
Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running linters on Github pull requests. Free for Open Source.
16
+
Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running linters on GitHub pull requests. Free for Open Source.
-[`golangci-lint` vs `gometalinter`](#golangci-lint-vs-gometalinter)
@@ -62,15 +65,13 @@ Short 1.5 min video demo of analyzing [beego](https://github.com/astaxie/beego).
62
65
63
66
## Install
64
67
65
-
### Binary Release
68
+
### Binary
66
69
67
-
Most installations are done for CI (travis, circleci etc). It's important to have reproducible CI:
70
+
Most installations are done for CI (e.g. Travis CI, CircleCI). It's important to have reproducible CI:
68
71
don't start to fail all builds at the same time. With golangci-lint this can happen if you
69
72
use deprecated option `--enable-all` and a new linter is added or even without `--enable-all`: when one upstream linter is upgraded.
70
73
71
-
It's highly recommended to install a specific version of golangci-lint. Releases are available on the [releases page](https://github.com/golangci/golangci-lint/releases).
It's highly recommended to install a specific version of golangci-lint available on the [releases page](https://github.com/golangci/golangci-lint/releases).
74
75
75
76
Here is the recommended way to install golangci-lint v1.21.0:
76
77
@@ -90,28 +91,28 @@ golangci-lint --version
90
91
It is advised that you periodically update version of golangci-lint as the project is under active development
91
92
and is constantly being improved. For any problems with golangci-lint, check out recent [GitHub issues](https://github.com/golangci/golangci-lint/issues) and update if needed.
92
93
93
-
### MacOS
94
+
### macOS
94
95
95
-
You can also install a binary release on MacOS using [brew](https://brew.sh/):
96
+
You can also install a binary release on macOS using [brew](https://brew.sh/):
96
97
97
98
```bash
98
99
brew install golangci/tap/golangci-lint
99
100
brew upgrade golangci/tap/golangci-lint
100
101
```
101
102
102
-
### By Docker
103
+
### Docker
103
104
104
105
```bash
105
106
docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:v1.21.0 golangci-lint run -v
106
107
```
107
108
108
-
### go get
109
+
### Go
109
110
110
111
Please, do not install `golangci-lint` by `go get`:
111
112
112
113
1.[`go.mod`](https://github.com/golangci/golangci-lint/blob/master/go.mod) replacement directive doesn't apply. It means you will be using patched version of `golangci-lint`.
113
114
2. it's much slower than binary installation
114
-
3.it's stability depends on your Go version (e.g. on [this compiler Go <= 1.12 bug](https://github.com/golang/go/issues/29612)).
115
+
3.its stability depends on your Go version (e.g. on [this compiler Go <= 1.12 bug](https://github.com/golang/go/issues/29612)).
115
116
4. it's not guaranteed to work: e.g. we've encountered a lot of issues with Go modules hashes.
116
117
5. it allows installation from `master` branch which can't be considered stable.
117
118
@@ -271,7 +272,7 @@ golangci-lint run --disable-all -E errcheck
271
272
272
273
`golangci-lint` can generate bash completion file.
273
274
274
-
### Mac OS X
275
+
### macOS
275
276
276
277
There are two versions of `bash-completion`, v1 and v2. V1 is for Bash 3.2 (which is the default on macOS), and v2 is for Bash 4.1+. The `golangci-lint` completion script doesn’t work correctly with bash-completion v1 and Bash 3.2. It requires bash-completion v2 and Bash 4.1+. Thus, to be able to correctly use `golangci-lint` completion on macOS, you have to install and use Bash 4.1+ ([instructions](https://itnext.io/upgrading-bash-on-macos-7138bd1066ba)). The following instructions assume that you use Bash 4.1+ (that is, any Bash version of 4.1 or newer).
277
278
@@ -1115,7 +1116,7 @@ We don't recommend vendoring `golangci-lint` in your repo: you will get troubles
1115
1116
No, you don't need to do it anymore.
1116
1117
1117
1118
**Which go versions are supported**
1118
-
Short answer: go 1.12 and newer are oficially supported.
1119
+
Short answer: go 1.12 and newer are officially supported.
GolangCI-Lint is a linters aggregator. It's fast: on average [5 times faster](#performance) than gometalinter.
7
10
It's [easy to integrate and use](#command-line-options), has [nice output](#quick-start) and has a minimum number of false positives. It supports go modules.
@@ -10,22 +13,22 @@ GolangCI-Lint has [integrations](#editor-integration) with VS Code, GNU Emacs, S
10
13
11
14
Follow the news and releases on our [twitter](https://twitter.com/golangci) and our [blog](https://medium.com/golangci).
12
15
13
-
Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running linters on Github pull requests. Free for Open Source.
16
+
Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running linters on GitHub pull requests. Free for Open Source.
-[`golangci-lint` vs `gometalinter`](#golangci-lint-vs-gometalinter)
@@ -62,15 +65,13 @@ Short 1.5 min video demo of analyzing [beego](https://github.com/astaxie/beego).
62
65
63
66
## Install
64
67
65
-
### Binary Release
68
+
### Binary
66
69
67
-
Most installations are done for CI (travis, circleci etc). It's important to have reproducible CI:
70
+
Most installations are done for CI (e.g. Travis CI, CircleCI). It's important to have reproducible CI:
68
71
don't start to fail all builds at the same time. With golangci-lint this can happen if you
69
72
use deprecated option `--enable-all` and a new linter is added or even without `--enable-all`: when one upstream linter is upgraded.
70
73
71
-
It's highly recommended to install a specific version of golangci-lint. Releases are available on the [releases page](https://github.com/golangci/golangci-lint/releases).
It's highly recommended to install a specific version of golangci-lint available on the [releases page](https://github.com/golangci/golangci-lint/releases).
74
75
75
76
Here is the recommended way to install golangci-lint {{.LatestVersion}}:
76
77
@@ -90,28 +91,28 @@ golangci-lint --version
90
91
It is advised that you periodically update version of golangci-lint as the project is under active development
91
92
and is constantly being improved. For any problems with golangci-lint, check out recent [GitHub issues](https://github.com/golangci/golangci-lint/issues) and update if needed.
92
93
93
-
### MacOS
94
+
### macOS
94
95
95
-
You can also install a binary release on MacOS using [brew](https://brew.sh/):
96
+
You can also install a binary release on macOS using [brew](https://brew.sh/):
96
97
97
98
```bash
98
99
brew install golangci/tap/golangci-lint
99
100
brew upgrade golangci/tap/golangci-lint
100
101
```
101
102
102
-
### By Docker
103
+
### Docker
103
104
104
105
```bash
105
106
docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:{{.LatestVersion}} golangci-lint run -v
106
107
```
107
108
108
-
### go get
109
+
### Go
109
110
110
111
Please, do not install `golangci-lint` by `go get`:
111
112
112
113
1.[`go.mod`](https://github.com/golangci/golangci-lint/blob/master/go.mod) replacement directive doesn't apply. It means you will be using patched version of `golangci-lint`.
113
114
2. it's much slower than binary installation
114
-
3.it's stability depends on your Go version (e.g. on [this compiler Go <= 1.12 bug](https://github.com/golang/go/issues/29612)).
115
+
3.its stability depends on your Go version (e.g. on [this compiler Go <= 1.12 bug](https://github.com/golang/go/issues/29612)).
115
116
4. it's not guaranteed to work: e.g. we've encountered a lot of issues with Go modules hashes.
116
117
5. it allows installation from `master` branch which can't be considered stable.
117
118
@@ -232,7 +233,7 @@ golangci-lint run --disable-all -E errcheck
232
233
233
234
`golangci-lint` can generate bash completion file.
234
235
235
-
### Mac OS X
236
+
### macOS
236
237
237
238
There are two versions of `bash-completion`, v1 and v2. V1 is for Bash 3.2 (which is the default on macOS), and v2 is for Bash 4.1+. The `golangci-lint` completion script doesn’t work correctly with bash-completion v1 and Bash 3.2. It requires bash-completion v2 and Bash 4.1+. Thus, to be able to correctly use `golangci-lint` completion on macOS, you have to install and use Bash 4.1+ ([instructions](https://itnext.io/upgrading-bash-on-macos-7138bd1066ba)). The following instructions assume that you use Bash 4.1+ (that is, any Bash version of 4.1 or newer).
238
239
@@ -537,7 +538,7 @@ We don't recommend vendoring `golangci-lint` in your repo: you will get troubles
537
538
No, you don't need to do it anymore.
538
539
539
540
**Which go versions are supported**
540
-
Short answer: go 1.12 and newer are oficially supported.
541
+
Short answer: go 1.12 and newer are officially supported.
0 commit comments