Configure golangci-lint via yml file (textileio#249)

asutula · web-flow · commit 4df6ee342608 · 2020-04-16T09:58:54.000-05:00
* configure golangci-lint via yml file

Signed-off-by: Aaron Sutula &lt;hi@asutula.com&gt;

* increase timeout

Signed-off-by: Aaron Sutula &lt;hi@asutula.com&gt;

* add reviewdog back in

Signed-off-by: Aaron Sutula &lt;hi@asutula.com&gt;

* fixing misspellings

Signed-off-by: Aaron Sutula &lt;hi@asutula.com&gt;

* clean up conf file

Signed-off-by: Aaron Sutula &lt;hi@asutula.com&gt;
diff --git a/.github/workflows/review.yml b/.github/workflows/review.yml
@@ -11,16 +11,13 @@ jobs:
     steps:
       - uses: actions/checkout@v1
       - uses: actions-contrib/golangci-lint@v1
-        with:
-          args: "run -E golint --timeout 30m --exclude-use-default=false"
   spell-check:
-    name: spell-check
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: reviewdog/action-misspell@v1
-        with:
-          reporter: github-pr-review
-          github_token: ${{ secrets.github_token }}
-          locale: "US"
-
+     name: spell-check
+     runs-on: ubuntu-latest
+     steps:
+       - uses: actions/checkout@v1
+       - uses: reviewdog/action-misspell@v1
+         with:
+           reporter: github-pr-review
+           github_token: ${{ secrets.github_token }}
+           locale: "US"
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,32 @@
+linters-settings:
+  misspell:
+    locale: US
+
+linters:
+  # please, do not use `enable-all`: it's deprecated and will be removed soon.
+  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+  disable-all: true
+  enable:
+    - golint
+    - misspell
+
+  # don't enable:
+  # - gochecknoglobals
+  # - gocognit
+  # - godox
+  # - maligned
+  # - prealloc
+
+issues:
+  exclude-use-default: false
+
+run:
+  timeout: 30m
+  skip-files:
+    - gateway/assets.go
+
+# golangci.com configuration
+# https://github.com/golangci/golangci/wiki/Configuration
+service:
+  golangci-lint-version: 1.23.x # use the fixed version to not introduce new linters unexpectedly
+    
diff --git a/deals/deals.go b/deals/deals.go
@@ -28,7 +28,7 @@ var (
 	// ErrRetrievalNoAvailableProviders indicates that the data isn't available on any provided
 	// to be retrieved.
 	ErrRetrievalNoAvailableProviders = errors.New("no providers to retrieve the data")
-	// ErrDealNotFound indicates a particular ProposalCid from a deal isn't found on-chain. Currenty,
+	// ErrDealNotFound indicates a particular ProposalCid from a deal isn't found on-chain. Currently,
 	// in Lotus this indicates that it may never existed on-chain, or it existed but it already expired
 	// (currEpoch > StartEpoch+Duration).
 	ErrDealNotFound = errors.New("deal not found on-chain")
diff --git a/exe/cli/cmd/ffs_watch.go b/exe/cli/cmd/ffs_watch.go
@@ -127,8 +127,8 @@ func jobsComplete(state map[string]*client.JobEvent) bool {
 
 func displayName(s ffs.JobStatus) string {
 	switch s {
-	case ffs.Cancelled:
-		return "Cancelled"
+	case ffs.Canceled:
+		return "Canceled"
 	case ffs.Failed:
 		return "Failed"
 	case ffs.InProgress:
diff --git a/ffs/coreipfs/coreipfs.go b/ffs/coreipfs/coreipfs.go
@@ -84,7 +84,7 @@ func (ci *CoreIpfs) Add(ctx context.Context, r io.Reader) (cid.Cid, error) {
 
 // Get retrieves a cid from the IPFS node.
 func (ci *CoreIpfs) Get(ctx context.Context, c cid.Cid) (io.Reader, error) {
-	log.Debugf("geting cid %s", c)
+	log.Debugf("getting cid %s", c)
 	n, err := ci.ipfs.Unixfs().Get(ctx, path.IpfsPath(c))
 	if err != nil {
 		return nil, fmt.Errorf("getting cid %s from ipfs: %s", c, err)
diff --git a/ffs/grpc/service.go b/ffs/grpc/service.go
@@ -16,7 +16,7 @@ import (
 )
 
 var (
-	// ErrEmptyAuthToken is returned when the provided auth-token is unkown.
+	// ErrEmptyAuthToken is returned when the provided auth-token is unknown.
 	ErrEmptyAuthToken = errors.New("auth token can't be empty")
 
 	log = logger.Logger("ffs-grpc-service")
diff --git a/ffs/pb/ffs.pb.go b/ffs/pb/ffs.pb.go
diff --git a/ffs/pb/ffs.proto b/ffs/pb/ffs.proto
@@ -99,7 +99,7 @@ enum JobStatus {
    Queued = 0;
 	InProgress = 1;
 	Failed = 2;
-	Cancelled = 3;
+	Canceled = 3;
 	Success = 4;
 }
 
diff --git a/ffs/types.go b/ffs/types.go
@@ -28,7 +28,7 @@ func (jid JobID) String() string {
 }
 
 var (
-	// EmptyInstanceID representes an empty/invalid Instance ID.
+	// EmptyInstanceID represents an empty/invalid Instance ID.
 	EmptyInstanceID = APIID("")
 )
 
@@ -64,9 +64,9 @@ const (
 	// Failed indicates the Job failed, with job.ErrCause with
 	// the error cause.
 	Failed
-	// Cancelled indicates the Job was cancelled from Queued,
+	// Canceled indicates the Job was canceled from Queued,
 	// and didn't reach execution.
-	Cancelled
+	Canceled
 	// Success indicates the Job was successfully executed.
 	Success
 )
diff --git a/index/ask/ask.go b/index/ask/ask.go
@@ -130,7 +130,7 @@ func (ai *Index) Close() error {
 	return nil
 }
 
-// start is a long running job that updates asks infromation in the market
+// start is a long running job that updates asks information in the market
 func (ai *Index) start() {
 	defer close(ai.finished)
 	if err := ai.update(); err != nil {
@@ -232,7 +232,7 @@ func generateIndex(ctx context.Context, api *apistruct.FullNodeStruct) (*IndexSn
 
 	select {
 	case <-ctx.Done():
-		return nil, fmt.Errorf("refresh was cancelled")
+		return nil, fmt.Errorf("refresh was canceled")
 	default:
 	}
 
diff --git a/index/miner/onchain.go b/index/miner/onchain.go
@@ -110,7 +110,7 @@ func deltaRefresh(ctx context.Context, api *apistruct.FullNodeStruct, chainIndex
 	return nil
 }
 
-// fullRefresh updates chainIndex for all miners information at the currenty
+// fullRefresh updates chainIndex for all miners information at the currently
 // heaviest tipset.
 func fullRefresh(ctx context.Context, api *apistruct.FullNodeStruct, chainIndex *ChainIndex) error {
 	ts, err := api.ChainHead(ctx)
@@ -153,7 +153,7 @@ func updateForAddrs(ctx context.Context, api *apistruct.FullNodeStruct, chainInd
 
 	select {
 	case <-ctx.Done():
-		return fmt.Errorf("cancelled by context")
+		return fmt.Errorf("canceled by context")
 	default:
 	}
 	return nil
diff --git a/index/slashing/slashing.go b/index/slashing/slashing.go
@@ -49,7 +49,7 @@ type Index struct {
 }
 
 // New returns a new SlashingIndex. It will load previous state from ds, and
-// immediatelly start getting in sync with new on-chain.
+// immediately start getting in sync with new on-chain.
 func New(ds datastore.TxnDatastore, api *apistruct.FullNodeStruct) (*Index, error) {
 	cs := chainsync.New(api)
 	store, err := chainstore.New(txndstr.Wrap(ds, "chainstore"), cs)
@@ -270,7 +270,7 @@ func epochPatch(ctx context.Context, c *apistruct.FullNodeStruct, pts *types.Tip
 
 	select {
 	case <-ctx.Done():
-		return nil, fmt.Errorf("cancelled by context")
+		return nil, fmt.Errorf("canceled by context")
 	default:
 	}
 
diff --git a/signaler/signaler.go b/signaler/signaler.go
@@ -61,7 +61,7 @@ func (s *Signaler) Signal() {
 	}
 }
 
-// Close closes the Signaler. Any channel that wasn't explicitely unregistered,
+// Close closes the Signaler. Any channel that wasn't explicitly unregistered,
 // is closed.
 func (s *Signaler) Close() {
 	s.lock.Lock()

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ import (`
`16`	`16`	`)`
`17`	`17`
`18`	`18`	`var (`
`19`		`- // ErrEmptyAuthToken is returned when the provided auth-token is unkown.`
	`19`	`+ // ErrEmptyAuthToken is returned when the provided auth-token is unknown.`
`20`	`20`	`ErrEmptyAuthToken = errors.New("auth token can't be empty")`
`21`	`21`
`22`	`22`	`log = logger.Logger("ffs-grpc-service")`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ enum JobStatus {`
`99`	`99`	`Queued = 0;`
`100`	`100`	`InProgress = 1;`
`101`	`101`	`Failed = 2;`
`102`		`- Cancelled = 3;`
	`102`	`+ Canceled = 3;`
`103`	`103`	`Success = 4;`
`104`	`104`	`}`
`105`	`105`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ func (jid JobID) String() string {`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`var (`
`31`		`- // EmptyInstanceID representes an empty/invalid Instance ID.`
	`31`	`+ // EmptyInstanceID represents an empty/invalid Instance ID.`
`32`	`32`	`EmptyInstanceID = APIID("")`
`33`	`33`	`)`
`34`	`34`
`@@ -64,9 +64,9 @@ const (`
`64`	`64`	`// Failed indicates the Job failed, with job.ErrCause with`
`65`	`65`	`// the error cause.`
`66`	`66`	`Failed`
`67`		`- // Cancelled indicates the Job was cancelled from Queued,`
	`67`	`+ // Canceled indicates the Job was canceled from Queued,`
`68`	`68`	`// and didn't reach execution.`
`69`		`- Cancelled`
	`69`	`+ Canceled`
`70`	`70`	`// Success indicates the Job was successfully executed.`
`71`	`71`	`Success`
`72`	`72`	`)`
Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ func (ai *Index) Close() error {`
`130`	`130`	`return nil`
`131`	`131`	`}`
`132`	`132`
`133`		`-// start is a long running job that updates asks infromation in the market`
	`133`	`+// start is a long running job that updates asks information in the market`
`134`	`134`	`func (ai *Index) start() {`
`135`	`135`	`defer close(ai.finished)`
`136`	`136`	`if err := ai.update(); err != nil {`
`@@ -232,7 +232,7 @@ func generateIndex(ctx context.Context, api apistruct.FullNodeStruct) (IndexSn`
`232`	`232`
`233`	`233`	`select {`
`234`	`234`	`case <-ctx.Done():`
`235`		`- return nil, fmt.Errorf("refresh was cancelled")`
	`235`	`+ return nil, fmt.Errorf("refresh was canceled")`
`236`	`236`	`default:`
`237`	`237`	`}`
`238`	`238`