Skip to content

Commit 9ed7dad

Browse files
committed
#77: move changes from README.md to README.md.tmpl
1 parent 94ba831 commit 9ed7dad

File tree

2 files changed

+58
-58
lines changed

2 files changed

+58
-58
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The recommended way to install golangci-lint:
4747
curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | bash -s VERSION
4848
```
4949

50-
Periodically update version of golangci-lint: the project is under active development
50+
Periodically update version of golangci-lint: the project is under active development
5151
and is constantly being improved. But please always check for newly found issues and
5252
update if needed.
5353

@@ -137,7 +137,7 @@ GolangCI-Lint was created to fix the following issues with `gometalinter`:
137137
3. Doesn't use real bounded concurrency: if you set it to `n` it can take up to `n*n` threads because of forced threads in specific linters. `gometalinter` can't do anything about it because it runs linters as black boxes in forked processes. In GolangCI-Lint we run all linters in one process and completely control them. Configured concurrency will be correctly bounded.
138138
This issue is important because you often want to set concurrency to the CPUs count minus one to ensure you **do not freeze your PC** and be able to work on it while analyzing code.
139139
4. Lack of nice output. We like how the `gcc` and `clang` compilers format their warnings: **using colors, printing warning lines and showing the position in line**.
140-
5. Too many issues. GolangCI-Lint cuts a lot of issues by using default exclude list of common false-positives. By default, it has enables **smart issues processing**: merge multiple issues for one line, merge issues with the same text or from the same linter. All of these smart processors can be configured by the user.
140+
5. Too many issues. GolangCI-Lint cuts a lot of issues by using default exclude list of common false-positives. By default, it has enabled **smart issues processing**: merge multiple issues for one line, merge issues with the same text or from the same linter. All of these smart processors can be configured by the user.
141141
6. Integration into large codebases. A good way to start using linters in a large project is not to fix a plethora of existing issues, but to set up CI and **fix only issues in new commits**. You can use `revgrep` for it, but it's yet another utility to install and configure. With `golangci-lint` it's much easier: `revgrep` is already built into `golangci-lint` and you can use it with one option (`-n, --new` or `--new-from-rev`).
142142
7. Installation. With `gometalinter`, you need to run a linters installation step. It's easy to forget this step and end up with stale linters. It also complicates CI setup. GolangCI-Lint requires **no installation of linters**.
143143
8. **Yaml or toml config**. Gometalinter's JSON isn't convenient for config files.
@@ -150,13 +150,13 @@ This issue is important because you often want to set concurrency to the CPUs co
150150
# Performance
151151
Benchmarks were executed on MacBook Pro (Retina, 13-inch, Late 2013), 2,4 GHz Intel Core i5, 8 GB 1600 MHz DDR3.
152152
It has 4 cores and concurrent linting as a default consuming all cores.
153-
Benchmark were run (and measured) automatically, see the code
153+
Benchmark was run (and measured) automatically, see the code
154154
[here](https://github.com/golangci/golangci-lint/blob/master/test/bench_test.go) (`BenchmarkWithGometalinter`).
155155

156156
We measure peak memory usage (RSS) by tracking of processes RSS every 5 ms.
157157

158158
## Comparison with gometalinter
159-
We compare golangci-lint and gometalinter in default mode, but explicitly enabl all linters because of small differences in the default configuration.
159+
We compare golangci-lint and gometalinter in default mode, but explicitly enable all linters because of small differences in the default configuration.
160160
```bash
161161
$ golangci-lint run --no-config --issues-exit-code=0 --deadline=30m \
162162
--disable-all --enable=deadcode --enable=gocyclo --enable=golint --enable=varcheck \
@@ -431,7 +431,7 @@ Thanks to developers and authors of used linters:
431431
1. Upstream all changes of forked linters.
432432
2. Fully integrate all used linters: make a common interface and reuse 100% of what can be reused: AST traversal, packages preparation etc.
433433
3. Make it easy to write own linter/checker: it should take a minimum code, have perfect documentation, debugging and testing tooling.
434-
4. Speed up package loading (dig into [loader](golang.org/x/tools/go/loader)): on-disk cache and existing code profiling-optimizing.
434+
4. Speed up package loading (dig into [loader](golang.org/x/tools/go/loader)): on-disk cache and existing code profiling-optimizing.
435435
5. Analyze (don't only filter) only new code: analyze only changed files and dependencies, make incremental analysis, caches.
436436
6. Smart new issues detector: don't print existing issues on changed lines.
437437
7. Integration with Text Editors. On-the-fly code analysis for text editors: it should be super-fast.

0 commit comments

Comments
 (0)