Merge remote-tracking branch 'golangci/master' into add-gomodguard-linter

Author: ryancurrah

.github/stale.yml

@@ -1,13 +1,17 @@
 # Number of days of inactivity before an issue becomes stale
-daysUntilStale: 180
+daysUntilStale: 366
 
 # Number of days of inactivity before a stale issue is closed
-daysUntilClose: 14
+daysUntilClose: 30
 
 # Issues with these labels will never be considered stale
 exemptLabels:
   - pinned
   - security
+  - bug
+  - blocked
+  - protected
+  - triaged
 
 # Label to use when marking an issue as stale
 staleLabel: stale

.golangci.example.yml

@@ -126,6 +126,9 @@ linters-settings:
   gocyclo:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 10
+  godot:
+    # check all top-level comments, not only declarations
+    check-all: false
   godox:
     # report any comments starting with keywords, this is useful for TODO or FIXME comments that
     # might be left in the code accidentally and should be resolved before merging

Makefile

@@ -3,8 +3,6 @@
 
 # enable module support across all go commands.
 export GO111MODULE = on
-# opt-in to vendor deps across all go commands.
-export GOFLAGS = -mod=vendor
 # enable consistent Go 1.12/1.13 GOPROXY behavior.
 export GOPROXY = https://proxy.golang.org
 
@@ -46,25 +44,25 @@ test_linters:
 
 # Maintenance
 
-generate: README.md docs/demo.svg install.sh vendor
+generate: README.md docs/demo.svg install.sh
 .PHONY: generate
 
-fast_generate: README.md vendor
+fast_generate: README.md
 .PHONY: fast_generate
 
 maintainer-clean: clean
-	rm -rf docs/demo.svg README.md install.sh vendor
+	rm -rf docs/demo.svg README.md install.sh
 .PHONY: maintainer-clean
 
 check_generated:
 	$(MAKE) --always-make generate
-	git checkout -- vendor/modules.txt go.mod go.sum # can differ between go1.12 and go1.13
+	git checkout -- go.mod go.sum # can differ between go1.12 and go1.13
 	git diff --exit-code # check no changes
 .PHONY: check_generated
 
 fast_check_generated:
 	$(MAKE) --always-make fast_generate
-	git checkout -- vendor/modules.txt go.mod go.sum # can differ between go1.12 and go1.13
+	git checkout -- go.mod go.sum # can differ between go1.12 and go1.13
 	git diff --exit-code # check no changes
 .PHONY: fast_check_generated
 
@@ -105,11 +103,3 @@ go.mod: FORCE
 	go mod tidy
 	go mod verify
 go.sum: go.mod
-
-vendor: go.mod go.sum
-	go mod vendor
-
-unexport GOFLAGS
-vendor_free_build: FORCE
-	go build -o golangci-lint ./cmd/golangci-lint
-.PHONY: vendor_free_build vendor

README.md

@@ -217,6 +217,7 @@ gocognit: Computes and checks the cognitive complexity of functions [fast: true,
 goconst: Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false]
 gocritic: The most opinionated Go source code linter [fast: true, auto-fix: false]
 gocyclo: Computes and checks the cyclomatic complexity of functions [fast: true, auto-fix: false]
+godot: Check if comments end in a period [fast: true, auto-fix: false]
 godox: Tool for detection of FIXME, TODO and other comment keywords [fast: true, auto-fix: false]
 gofmt: Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true]
 goimports: Goimports does everything that gofmt does. Additionally it checks unused imports [fast: true, auto-fix: true]
@@ -489,7 +490,7 @@ golangci-lint help linters
 - [wsl](https://github.com/bombsimon/wsl) - Whitespace Linter - Forces you to use empty lines!
 - [goprintffuncname](https://github.com/jirfag/go-printf-func-name) - Checks that printf-like functions are named with `f` at the end
 - [gomnd](https://github.com/tommy-muehle/go-mnd) - An analyzer to detect magic numbers.
-- [gomodguard](https://github.com/ryancurrah/gomodguard) - Allow and block list linter for direct Go module dependencies.
+- [godot](https://github.com/tetafro/godot) - Check if comments end in a period
 
 ## Configuration
 
@@ -511,7 +512,7 @@ Usage:
   golangci-lint run [flags]
 
 Flags:
-      --out-format string              Format of output: colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml (default "colored-line-number")
+      --out-format string              Format of output: colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions (default "colored-line-number")
       --print-issued-lines             Print lines of code with issue (default true)
       --print-linter-name              Print linter name in issue line (default true)
       --uniq-by-line                   Make issues output unique by line (default true)
@@ -738,6 +739,9 @@ linters-settings:
   gocyclo:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 10
+  godot:
+    # check all top-level comments, not only declarations
+    check-all: false
   godox:
     # report any comments starting with keywords, this is useful for TODO or FIXME comments that
     # might be left in the code accidentally and should be resolved before merging
@@ -1275,7 +1279,7 @@ Thanks to developers and authors of used linters:
 - [bombsimon](https://github.com/bombsimon)
 - [jirfag](https://github.com/jirfag)
 - [tommy-muehle](https://github.com/tommy-muehle)
-- [ryancurrah](https://github.com/ryancurrah)
+- [tetafro](https://github.com/tetafro)
 
 ## Changelog
 

go.mod

@@ -39,6 +39,7 @@ require (
 	github.com/spf13/pflag v1.0.5
 	github.com/spf13/viper v1.6.1
 	github.com/stretchr/testify v1.5.1
+	github.com/tetafro/godot v0.2.5
 	github.com/timakin/bodyclose v0.0.0-20190930140734-f7f2e9bca95e
 	github.com/tommy-muehle/go-mnd v1.3.1-0.20200224220436-e6f9a994e8fa
 	github.com/ultraware/funlen v0.0.2

go.sum

@@ -270,6 +270,8 @@ github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/subosito/gotenv v1.2.0 h1:Slr1R9HxAlEKefgq5jn9U+DnETlIUa6HfgEzj0g5d7s=
 github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw=
+github.com/tetafro/godot v0.2.5 h1:7+EYJM/Z4gYZhBFdRrVm6JTj5ZLw/QI1j4RfEOXJviE=
+github.com/tetafro/godot v0.2.5/go.mod h1:pT6/T8+h6//L/LwQcFc4C0xpfy1euZwzS1sHdrFCms0=
 github.com/timakin/bodyclose v0.0.0-20190930140734-f7f2e9bca95e h1:RumXZ56IrCj4CL+g1b9OL/oH0QnsF976bC8xQFYUD5Q=
 github.com/timakin/bodyclose v0.0.0-20190930140734-f7f2e9bca95e/go.mod h1:Qimiffbc6q9tBWlVV6x0P9sat/ao1xEkREYPPj9hphk=
 github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=

pkg/commands/run.go

@@ -396,6 +396,8 @@ func (e *Executor) createPrinter() (printers.Printer, error) {
 		p = printers.NewCodeClimate()
 	case config.OutFormatJunitXML:
 		p = printers.NewJunitXML()
+	case config.OutFormatGithubActions:
+		p = printers.NewGithub()
 	default:
 		return nil, fmt.Errorf("unknown output format %s", format)
 	}

pkg/config/config.go

@@ -15,6 +15,7 @@ const (
 	OutFormatCheckstyle        = "checkstyle"
 	OutFormatCodeClimate       = "code-climate"
 	OutFormatJunitXML          = "junit-xml"
+	OutFormatGithubActions     = "github-actions"
 )
 
 var OutFormats = []string{
@@ -25,6 +26,7 @@ var OutFormats = []string{
 	OutFormatCheckstyle,
 	OutFormatCodeClimate,
 	OutFormatJunitXML,
+	OutFormatGithubActions,
 }
 
 type ExcludePattern struct {
@@ -208,6 +210,7 @@ type LintersSettings struct {
 	Godox    GodoxSettings
 	Dogsled  DogsledSettings
 	Gocognit GocognitSettings
+	Godot    GodotSettings
 
 	Custom map[string]CustomLinterSettings
 }
@@ -285,6 +288,10 @@ type WSLSettings struct {
 	ForceCaseTrailingWhitespaceLimit int  `mapstructure:"force-case-trailing-whitespace"`
 }
 
+type GodotSettings struct {
+	CheckAll bool `mapstructure:"check-all"`
+}
+
 //nolint:gomnd
 var defaultLintersSettings = LintersSettings{
 	Lll: LllSettings{

pkg/golinters/godot.go

@@ -0,0 +1,64 @@
+package golinters
+
+import (
+	"sync"
+
+	"github.com/tetafro/godot"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+	"github.com/golangci/golangci-lint/pkg/lint/linter"
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+const godotName = "godot"
+
+func NewGodot() *goanalysis.Linter {
+	var mu sync.Mutex
+	var resIssues []goanalysis.Issue
+
+	analyzer := &analysis.Analyzer{
+		Name: godotName,
+		Doc:  goanalysis.TheOnlyanalyzerDoc,
+	}
+	return goanalysis.NewLinter(
+		godotName,
+		"Check if comments end in a period",
+		[]*analysis.Analyzer{analyzer},
+		nil,
+	).WithContextSetter(func(lintCtx *linter.Context) {
+		cfg := lintCtx.Cfg.LintersSettings.Godot
+		settings := godot.Settings{CheckAll: cfg.CheckAll}
+
+		analyzer.Run = func(pass *analysis.Pass) (interface{}, error) {
+			var issues []godot.Message
+			for _, file := range pass.Files {
+				issues = append(issues, godot.Run(file, pass.Fset, settings)...)
+			}
+
+			if len(issues) == 0 {
+				return nil, nil
+			}
+
+			res := make([]goanalysis.Issue, len(issues))
+			for k, i := range issues {
+				issue := result.Issue{
+					Pos:         i.Pos,
+					Text:        i.Message,
+					FromLinter:  godotName,
+					Replacement: &result.Replacement{},
+				}
+
+				res[k] = goanalysis.NewIssue(&issue, pass)
+			}
+
+			mu.Lock()
+			resIssues = append(resIssues, res...)
+			mu.Unlock()
+
+			return nil, nil
+		}
+	}).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue {
+		return resIssues
+	}).WithLoadMode(goanalysis.LoadModeSyntax)
+}

pkg/lint/lintersdb/manager.go

@@ -251,6 +251,9 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithPresets(linter.PresetStyle).
 			WithLoadForGoAnalysis().
 			WithURL("https://github.com/ryancurrah/gomodguard"),
+		linter.NewConfig(golinters.NewGodot()).
+			WithPresets(linter.PresetStyle).
+			WithURL("https://github.com/tetafro/godot"),
 	}
 
 	isLocalRun := os.Getenv("GOLANGCI_COM_RUN") == ""

pkg/printers/github.go

@@ -0,0 +1,39 @@
+package printers
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/golangci/golangci-lint/pkg/logutils"
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+type github struct {
+}
+
+// Github output format outputs issues according to Github actions format:
+// https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
+func NewGithub() Printer {
+	return &github{}
+}
+
+// print each line as: ::error file=app.js,line=10,col=15::Something went wrong
+func formatIssueAsGithub(issue *result.Issue) string {
+	ret := fmt.Sprintf("::error file=%s,line=%d", issue.FilePath(), issue.Line())
+	if issue.Pos.Column != 0 {
+		ret += fmt.Sprintf(",col=%d", issue.Pos.Column)
+	}
+
+	ret += fmt.Sprintf("::%s (%s)", issue.Text, issue.FromLinter)
+	return ret
+}
+
+func (g *github) Print(_ context.Context, issues []result.Issue) error {
+	for ind := range issues {
+		_, err := fmt.Fprintln(logutils.StdOut, formatIssueAsGithub(&issues[ind]))
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}

pkg/printers/github_test.go

@@ -0,0 +1,27 @@
+package printers
+
+import (
+	"go/token"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+func TestFormatGithubIssue(t *testing.T) {
+	sampleIssue := result.Issue{
+		FromLinter: "sample-linter",
+		Text:       "some issue",
+		Pos: token.Position{
+			Filename: "path/to/file.go",
+			Offset:   2,
+			Line:     10,
+			Column:   4,
+		},
+	}
+	require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))
+
+	sampleIssue.Pos.Column = 0
+	require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))
+}

test/testdata/godot.go

@@ -0,0 +1,7 @@
+//args: -Egodot
+package testdata
+
+// Godot checks top-level comments // ERROR "Top level comment should end in a period"
+func Godot() {
+	// nothing to do here
+}