Skip to content

Commit 0bc2523

Browse files
committed
fix #266: docs: reorder sections and update changelog
1 parent 71b940e commit 0bc2523

File tree

2 files changed

+104
-28
lines changed

2 files changed

+104
-28
lines changed

README.md

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running lint
2525
* [False Positives](#false-positives)
2626
* [FAQ](#faq)
2727
* [Thanks](#thanks)
28-
* [Future Plans](#future-plans)
2928
* [Changelog](#changelog)
29+
* [Future Plans](#future-plans)
3030
* [Contact Information](#contact-information)
3131

3232
## Demo
@@ -808,23 +808,46 @@ Thanks to developers and authors of used linters:
808808
- [walle](https://github.com/walle)
809809
- [alexkohler](https://github.com/alexkohler)
810810
811-
## Future Plans
812-
813-
1. Upstream all changes of forked linters.
814-
2. Fully integrate all used linters: make a common interface and reuse 100% of what can be reused: AST traversal, packages preparation etc.
815-
3. Make it easy to write own linter/checker: it should take a minimum code, have perfect documentation, debugging and testing tooling.
816-
4. Speed up package loading (dig into [loader](golang.org/x/tools/go/loader)): on-disk cache and existing code profiling-optimizing.
817-
5. Analyze (don't only filter) only new code: analyze only changed files and dependencies, make incremental analysis, caches.
818-
6. Smart new issues detector: don't print existing issues on changed lines.
819-
7. Integration with Text Editors. On-the-fly code analysis for text editors: it should be super-fast.
820-
8. Minimize false-positives by fixing linters and improving testing tooling.
821-
9. Automatic issues fixing (code rewrite, refactoring) where it's possible.
822-
10. Documentation for every issue type.
823-
824811
## Changelog
825812
826813
There is the most valuable changes log:
827814
815+
### October 2018
816+
817+
1. Update goimports formatting
818+
2. Use go/packages
819+
* A lot of linters became "fast": they are enabled by --fast now and
820+
work in 1-2 seconds. Only unparam, interfacer and megacheck
821+
are "slow" linters now.
822+
823+
* Average project is analyzed 20-40% faster than before if all linters are
824+
enabled! If we enable all linters except unparam, interfacer and
825+
megacheck analysis is 10-20x faster!
826+
3. Support goimports.local-prefix option for goimports
827+
4. Change license from AGPL to GPL
828+
5. Update CLA
829+
830+
### September 2018
831+
832+
1. Rename GAS to gosec
833+
2. Drop go1.9 support
834+
3. Support installation of golangci-lint via go modules
835+
4. Update dockerfile to use golang 1.11
836+
5. Add support for ignore/exclude flags in errcheck
837+
838+
### August 2018
839+
840+
1. Improve lll parsing for very long lines
841+
2. Update Depguard with a Glob support
842+
3. Silent output by default
843+
4. Disable GAS (gosec) by default
844+
5. Build golangci-lint on go1.11
845+
846+
### July 2018
847+
848+
1. Add `golangci-lint linters` command
849+
2. Fix work with symlinks
850+
828851
### June 2018
829852
830853
1. Add support of the next linters:
@@ -844,7 +867,22 @@ There is the most valuable changes log:
844867
1. Support GitHub Releases
845868
2. Installation via Homebrew and Docker
846869
870+
## Future Plans
871+
872+
1. Upstream all changes of forked linters.
873+
2. Make it easy to write own linter/checker: it should take a minimum code, have perfect documentation, debugging and testing tooling.
874+
3. Speed up SSA loading: on-disk cache and existing code profiling-optimizing.
875+
4. Analyze (don't only filter) only new code: analyze only changed files and dependencies, make incremental analysis, caches.
876+
5. Smart new issues detector: don't print existing issues on changed lines.
877+
6. Minimize false-positives by fixing linters and improving testing tooling.
878+
7. Automatic issues fixing (code rewrite, refactoring) where it's possible.
879+
8. Documentation for every issue type.
880+
847881
## Contact Information
848882
849883
You can contact the [author](https://github.com/jirfag) of GolangCI-Lint
850884
885+
886+
## License Scan
887+
888+
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgolangci%2Fgolangci-lint.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fgolangci%2Fgolangci-lint?ref=badge_large)

README.tmpl.md

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Sponsored by [GolangCI.com](https://golangci.com): SaaS service for running lint
2525
* [False Positives](#false-positives)
2626
* [FAQ](#faq)
2727
* [Thanks](#thanks)
28-
* [Future Plans](#future-plans)
2928
* [Changelog](#changelog)
29+
* [Future Plans](#future-plans)
3030
* [Contact Information](#contact-information)
3131

3232
## Demo
@@ -459,23 +459,46 @@ Thanks to [bradleyfalzon/revgrep](https://github.com/bradleyfalzon/revgrep) for
459459
Thanks to developers and authors of used linters:
460460
{{.ThanksList}}
461461

462-
## Future Plans
463-
464-
1. Upstream all changes of forked linters.
465-
2. Fully integrate all used linters: make a common interface and reuse 100% of what can be reused: AST traversal, packages preparation etc.
466-
3. Make it easy to write own linter/checker: it should take a minimum code, have perfect documentation, debugging and testing tooling.
467-
4. Speed up package loading (dig into [loader](golang.org/x/tools/go/loader)): on-disk cache and existing code profiling-optimizing.
468-
5. Analyze (don't only filter) only new code: analyze only changed files and dependencies, make incremental analysis, caches.
469-
6. Smart new issues detector: don't print existing issues on changed lines.
470-
7. Integration with Text Editors. On-the-fly code analysis for text editors: it should be super-fast.
471-
8. Minimize false-positives by fixing linters and improving testing tooling.
472-
9. Automatic issues fixing (code rewrite, refactoring) where it's possible.
473-
10. Documentation for every issue type.
474-
475462
## Changelog
476463

477464
There is the most valuable changes log:
478465

466+
### October 2018
467+
468+
1. Update goimports formatting
469+
2. Use go/packages
470+
* A lot of linters became "fast": they are enabled by --fast now and
471+
work in 1-2 seconds. Only unparam, interfacer and megacheck
472+
are "slow" linters now.
473+
474+
* Average project is analyzed 20-40% faster than before if all linters are
475+
enabled! If we enable all linters except unparam, interfacer and
476+
megacheck analysis is 10-20x faster!
477+
3. Support goimports.local-prefix option for goimports
478+
4. Change license from AGPL to GPL
479+
5. Update CLA
480+
481+
### September 2018
482+
483+
1. Rename GAS to gosec
484+
2. Drop go1.9 support
485+
3. Support installation of golangci-lint via go modules
486+
4. Update dockerfile to use golang 1.11
487+
5. Add support for ignore/exclude flags in errcheck
488+
489+
### August 2018
490+
491+
1. Improve lll parsing for very long lines
492+
2. Update Depguard with a Glob support
493+
3. Silent output by default
494+
4. Disable GAS (gosec) by default
495+
5. Build golangci-lint on go1.11
496+
497+
### July 2018
498+
499+
1. Add `golangci-lint linters` command
500+
2. Fix work with symlinks
501+
479502
### June 2018
480503

481504
1. Add support of the next linters:
@@ -495,7 +518,22 @@ There is the most valuable changes log:
495518
1. Support GitHub Releases
496519
2. Installation via Homebrew and Docker
497520

521+
## Future Plans
522+
523+
1. Upstream all changes of forked linters.
524+
2. Make it easy to write own linter/checker: it should take a minimum code, have perfect documentation, debugging and testing tooling.
525+
3. Speed up SSA loading: on-disk cache and existing code profiling-optimizing.
526+
4. Analyze (don't only filter) only new code: analyze only changed files and dependencies, make incremental analysis, caches.
527+
5. Smart new issues detector: don't print existing issues on changed lines.
528+
6. Minimize false-positives by fixing linters and improving testing tooling.
529+
7. Automatic issues fixing (code rewrite, refactoring) where it's possible.
530+
8. Documentation for every issue type.
531+
498532
## Contact Information
499533

500534
You can contact the [author](https://github.com/jirfag) of GolangCI-Lint
501535
536+
537+
## License Scan
538+
539+
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgolangci%2Fgolangci-lint.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fgolangci%2Fgolangci-lint?ref=badge_large)

0 commit comments

Comments
 (0)