Merge pull request #55 from golangci/feature/generate-parts-of-readme

generate parts of README automatically

Author: golangci

README.md

@@ -77,34 +77,35 @@ GolangCI-Lint can be used with zero configuration. By default next linters are e
 ```
 $ golangci-lint linters
 Enabled by default linters:
-govet: Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
-errcheck: Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
-staticcheck: Staticcheck is go vet on steroids, applying a ton of static analysis checks
-unused: Checks Go code for unused constants, variables, functions and types
-gosimple: Linter for Go source code that specialises on simplifying code
-gas: Inspects source code for security problems
-structcheck: Finds unused struct fields
-varcheck: Finds unused global variables and constants
-ineffassign: Detects when assignments to existing variables are not used
-deadcode: Finds unused code
+govet: Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string [fast: true]
+errcheck: Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases [fast: false]
+staticcheck: Staticcheck is a go vet on steroids, applying a ton of static analysis checks [fast: false]
+unused: Checks Go code for unused constants, variables, functions and types [fast: false]
+gosimple: Linter for Go source code that specializes in simplifying a code [fast: false]
+gas: Inspects source code for security problems [fast: false]
+structcheck: Finds an unused struct fields [fast: false]
+varcheck: Finds unused global variables and constants [fast: false]
+ineffassign: Detects when assignments to existing variables are not used [fast: true]
+deadcode: Finds unused code [fast: false]
+typecheck: Like the front-end of a Go compiler, parses and type-checks Go code [fast: false]
 ```
 
 and next linters are disabled by default:
 ```
 $ golangci-lint linters
 ...
 Disabled by default linters:
-golint: Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
-interfacer: Linter that suggests narrower interface types
-unconvert: Remove unnecessary type conversions
-dupl: Tool for code clone detection
-goconst: Finds repeated strings that could be replaced by a constant
-gocyclo: Computes and checks the cyclomatic complexity of functions
-gofmt: Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
-goimports: Goimports does everything that gofmt does. Additionally it checks unused imports
-maligned: Tool to detect Go structs that would take less memory if their fields were sorted
-megacheck: 3 sub-linters in one: unused, gosimple and staticcheck
-depguard: Go linter that checks if package imports are in a list of acceptable packages
+golint: Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes [fast: true]
+interfacer: Linter that suggests narrower interface types [fast: false]
+unconvert: Remove unnecessary type conversions [fast: false]
+dupl: Tool for code clone detection [fast: true]
+goconst: Finds repeated strings that could be replaced by a constant [fast: true]
+gocyclo: Computes and checks the cyclomatic complexity of functions [fast: true]
+gofmt: Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true]
+goimports: Goimports does everything that gofmt does. Additionally it checks unused imports [fast: true]
+maligned: Tool to detect Go structs that would take less memory if their fields were sorted [fast: false]
+megacheck: 3 sub-linters in one: unused, gosimple and staticcheck [fast: false]
+depguard: Go linter that checks if package imports are in a list of acceptable packages [fast: false]
 ```
 
 Pass `-E/--enable` to enable linter and `-D/--disable` to disable:
@@ -174,30 +175,30 @@ golangci-lint linters
 ```
 
 ## Enabled By Default Linters
-- [go vet](https://golang.org/cmd/vet/) - Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
-- [errcheck](https://github.com/kisielk/errcheck): Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
-- [staticcheck](https://staticcheck.io/): Staticcheck is a go vet on steroids, applying a ton of static analysis checks
-- [unused](https://github.com/dominikh/go-tools/tree/master/cmd/unused): Checks Go code for unused constants, variables, functions, and types
-- [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple): Linter for Go source code that specializes in simplifying a code
-- [gas](https://github.com/GoASTScanner/gas): Inspects source code for security problems
-- [structcheck](https://github.com/opennota/check): Finds an unused struct fields
-- [varcheck](https://github.com/opennota/check): Finds unused global variables and constants
-- [ineffassign](https://github.com/gordonklaus/ineffassign): Detects when assignments to existing variables are not used
-- [deadcode](https://github.com/remyoudompheng/go-misc/tree/master/deadcode): Finds unused code
-- typecheck: Like the front-end of a Go compiler, parses and type-checks Go code. Similar to [gotype](https://godoc.org/golang.org/x/tools/cmd/gotype).
+- [govet](https://golang.org/cmd/vet/) - Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
+- [errcheck](https://github.com/kisielk/errcheck) - Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
+- [staticcheck](https://staticcheck.io/) - Staticcheck is a go vet on steroids, applying a ton of static analysis checks
+- [unused](https://github.com/dominikh/go-tools/tree/master/cmd/unused) - Checks Go code for unused constants, variables, functions and types
+- [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) - Linter for Go source code that specializes in simplifying a code
+- [gas](https://github.com/GoASTScanner/gas) - Inspects source code for security problems
+- [structcheck](https://github.com/opennota/check) - Finds an unused struct fields
+- [varcheck](https://github.com/opennota/check) - Finds unused global variables and constants
+- [ineffassign](https://github.com/gordonklaus/ineffassign) - Detects when assignments to existing variables are not used
+- [deadcode](https://github.com/remyoudompheng/go-misc/tree/master/deadcode) - Finds unused code
+- typecheck - Like the front-end of a Go compiler, parses and type-checks Go code
 
 ## Disabled By Default Linters (`-E/--enable`)
-- [golint](https://github.com/golang/lint): Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
-- [interfacer](https://github.com/mvdan/interfacer): Linter that suggests narrower interface types
-- [unconvert](https://github.com/mdempsky/unconvert): Remove unnecessary type conversions
-- [dupl](https://github.com/mibk/dupl): Tool for code clone detection
-- [goconst](https://github.com/jgautheron/goconst): Finds repeated strings that could be replaced by a constant
-- [gocyclo](https://github.com/alecthomas/gocyclo): Computes and checks the cyclomatic complexity of functions
-- [gofmt](https://golang.org/cmd/gofmt/): Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
-- [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports): Goimports does everything that gofmt does. Additionally it checks unused imports
-- [maligned](https://github.com/mdempsky/maligned): Tool to detect Go structs that would take less memory if their fields were sorted
-- [megacheck](https://github.com/dominikh/go-tools/tree/master/cmd/megacheck): 3 sub-linters in one: unused, gosimple and staticcheck
-- [depguard](https://github.com/OpenPeeDeeP/depguard): Go linter that checks if package imports are in a list of acceptable packages
+- [golint](https://github.com/golang/lint) - Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
+- [interfacer](https://github.com/mvdan/interfacer) - Linter that suggests narrower interface types
+- [unconvert](https://github.com/mdempsky/unconvert) - Remove unnecessary type conversions
+- [dupl](https://github.com/mibk/dupl) - Tool for code clone detection
+- [goconst](https://github.com/jgautheron/goconst) - Finds repeated strings that could be replaced by a constant
+- [gocyclo](https://github.com/alecthomas/gocyclo) - Computes and checks the cyclomatic complexity of functions
+- [gofmt](https://golang.org/cmd/gofmt/) - Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
+- [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports) - Goimports does everything that gofmt does. Additionally it checks unused imports
+- [maligned](https://github.com/mdempsky/maligned) - Tool to detect Go structs that would take less memory if their fields were sorted
+- [megacheck](https://github.com/dominikh/go-tools/tree/master/cmd/megacheck) - 3 sub-linters in one: unused, gosimple and staticcheck
+- [depguard](https://github.com/OpenPeeDeeP/depguard) - Go linter that checks if package imports are in a list of acceptable packages
 
 # Configuration
 ## Command-Line Options
@@ -306,7 +307,6 @@ There is a [`.golangci.yml`](https://github.com/golangci/golangci-lint/blob/mast
 It's a [.golangci.yml](https://github.com/golangci/golangci-lint/blob/master/.golangci.yml) of this repo: we enable more linters than by default and make their settings more strict:
 ```yaml
 run:
-  deadline: 30s
   tests: true
 
 linters-settings:
@@ -410,26 +410,19 @@ Thanks to [alecthomas/gometalinter](https://github.com/alecthomas/gometalinter)
 Thanks to [bradleyfalzon/revgrep](https://github.com/bradleyfalzon/revgrep) for cool diff tool.
 
 Thanks to developers and authors of used linters:
-- [golang/vet](https://golang.org/cmd/vet/)
-- [kisielk/errcheck](https://github.com/kisielk/errcheck)
-- [staticcheck](https://staticcheck.io/)
-- [dominikh/go-tools/unused](https://github.com/dominikh/go-tools/tree/master/cmd/unused)
-- [dominikh/go-tools/gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple)
-- [GoASTScanner/gas](https://github.com/GoASTScanner/gas)
-- [opennota/check](https://github.com/opennota/check)
-- [gordonklaus/ineffassign](https://github.com/gordonklaus/ineffassign)
-- [remyoudompheng/go-misc/deadcode](https://github.com/remyoudompheng/go-misc/tree/master/deadcode)
-- [golang/lint](https://github.com/golang/lint)
-- [mvdan/interfacer](https://github.com/mvdan/interfacer)
-- [mdempsky/unconvert](https://github.com/mdempsky/unconvert)
-- [mibk/dupl](https://github.com/mibk/dupl)
-- [jgautheron/goconst](https://github.com/jgautheron/goconst)
-- [alecthomas/gocyclo](https://github.com/alecthomas/gocyclo)
-- [golang/gofmt](https://golang.org/cmd/gofmt/)
-- [golang/x/tools/goimports](https://godoc.org/golang.org/x/tools/cmd/goimports)
-- [mdempsky/maligned](https://github.com/mdempsky/maligned)
-- [dominikh/go-tools/megacheck](https://github.com/dominikh/go-tools/tree/master/cmd/megacheck)
-- [OpenPeeDeeP/depguard](https://github.com/OpenPeeDeeP/depguard)
+- [kisielk](https://github.com/kisielk)
+- [golang](https://github.com/golang)
+- [dominikh](https://github.com/dominikh)
+- [GoASTScanner](https://github.com/GoASTScanner)
+- [opennota](https://github.com/opennota)
+- [mvdan](https://github.com/mvdan)
+- [mdempsky](https://github.com/mdempsky)
+- [gordonklaus](https://github.com/gordonklaus)
+- [mibk](https://github.com/mibk)
+- [jgautheron](https://github.com/jgautheron)
+- [remyoudompheng](https://github.com/remyoudompheng)
+- [alecthomas](https://github.com/alecthomas)
+- [OpenPeeDeeP](https://github.com/OpenPeeDeeP)
 
 # Future Plans
 1. Upstream all changes of forked linters.