rclone/.golangci.yml

# golangci-lint configuration options

linters:
  enable:
    - errcheck
    - goimports
    - revive
    - ineffassign
    - govet
    - unconvert
    - staticcheck
    - gosimple
    - stylecheck
    - unused
    - misspell
    #- prealloc
    #- maligned
  disable-all: true

issues:
  # Enable some lints excluded by default
  exclude-use-default: false

  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
  max-issues-per-linter: 0

  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
  max-same-issues: 0

  exclude-rules:

    - linters:
      - staticcheck
      text: 'SA1019: "github.com/rclone/rclone/cmd/serve/httplib" is deprecated'

    # TODO: Remove if/when this is fixed by merging PR #6277.
    - linters:
      - staticcheck
      text: 'SA1019: "golang.org/x/oauth2/jws" is deprecated'

run:
  # timeout for analysis, e.g. 30s, 5m, default is 1m
  timeout: 10m

linters-settings:
  revive:
    rules:
      - name: unreachable-code
        disabled: true
      - name: unused-parameter
        disabled: true
      - name: empty-block
        disabled: true
      - name: redefines-builtin-id
        disabled: true
      - name: superfluous-else
        disabled: true
  stylecheck:
    # Only enable the checks performed by the staticcheck stand-alone tool,
    # as documented here: https://staticcheck.io/docs/configuration/options/#checks
    checks: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022", "-ST1023"]
build: use golangci-lint for code quality checks 2019-01-12 00:29:49 +08:00			`# golangci-lint configuration options`

			`linters:`
			`enable:`
			`- errcheck`
			`- goimports`
Revert "build: disable revive linter pending a fix in golangci-lint" This reverts commit 7a24c173f6669172d845221c7e37e5824fa13fb7. 2022-08-03 20:14:51 +08:00			`- revive`
build: use golangci-lint for code quality checks 2019-01-12 00:29:49 +08:00			`- ineffassign`
			`- govet`
			`- unconvert`
build: add staticcheck, gosimple and stylecheck linting to the build pipeline - fixes #6273 These combined should correspond to the checks performed by the stand-alone staticcheck tool, which is by default used for linting in Visual Studio Code with the Go extension. One exception is the unused checks, which staticcheck tool performs, but chose to not enabled here in rclone due to many reported occurrences. See #6387 for more information. 2022-08-20 19:35:58 +08:00			`- staticcheck`
			`- gosimple`
			`- stylecheck`
build: replace deprecated linters deadcode, structcheck and varcheckadd with unused The three linters deadcode, structcheck and varcheck we have been using are as of gitlabci-lint version 1.49.0 (24 Aug 2022) marked as deprecated, and replaced by unused. The linters staticcheck, gosimple, stylecheck and unused should combined correspond to the checks performed by the stand-alone staticcheck tool, which is by default used for linting in Visual Studio Code with the Go extension. We previously enabled the first three, but skipped unused due to many reported issues. See #6387 for more information. 2022-08-28 18:12:17 +08:00			`- unused`
build: enable misspell linter 2022-08-30 18:39:21 +08:00			`- misspell`
build: use golangci-lint for code quality checks 2019-01-12 00:29:49 +08:00			`#- prealloc`
			`#- maligned`
			`disable-all: true`

			`issues:`
golangci: enable lints excluded by default 2019-02-09 19:25:05 +08:00			`# Enable some lints excluded by default`
			`exclude-use-default: false`

build: use golangci-lint for code quality checks 2019-01-12 00:29:49 +08:00			`# Maximum issues count per one linter. Set to 0 to disable. Default is 50.`
build: fix lint option max-issues-per-linter 2022-09-09 06:18:18 +08:00			`max-issues-per-linter: 0`
build: use golangci-lint for code quality checks 2019-01-12 00:29:49 +08:00
			`# Maximum count of issues with the same text. Set to 0 to disable. Default is 3.`
			`max-same-issues: 0`
build: increase timeout for golangci-lint to 10 minutes 2021-10-15 22:58:52 +08:00
build: exclude known issues from the staticcheck linting in ci 2022-08-21 02:54:18 +08:00			`exclude-rules:`

			`- linters:`
			`- staticcheck`
			`text: 'SA1019: "github.com/rclone/rclone/cmd/serve/httplib" is deprecated'`

			`# TODO: Remove if/when this is fixed by merging PR #6277.`
			`- linters:`
			`- staticcheck`
			`text: 'SA1019: "golang.org/x/oauth2/jws" is deprecated'`

build: increase timeout for golangci-lint to 10 minutes 2021-10-15 22:58:52 +08:00			`run:`
			`# timeout for analysis, e.g. 30s, 5m, default is 1m`
			`timeout: 10m`
ci: revert revive settings back to fix lint The upstream revive repo changed the default settings for this linter. We use this through golangci-lint. This change meant lots of errors appearing all at once. We should probably fix these in due course, but for the time being this disables those settings. See: https://github.com/mgechev/revive/pull/799 2023-03-20 22:17:18 +08:00
			`linters-settings:`
			`revive:`
			`rules:`
			`- name: unreachable-code`
			`disabled: true`
			`- name: unused-parameter`
			`disabled: true`
			`- name: empty-block`
			`disabled: true`
			`- name: redefines-builtin-id`
			`disabled: true`
			`- name: superfluous-else`
			`disabled: true`
build: add staticcheck, gosimple and stylecheck linting to the build pipeline - fixes #6273 These combined should correspond to the checks performed by the stand-alone staticcheck tool, which is by default used for linting in Visual Studio Code with the Go extension. One exception is the unused checks, which staticcheck tool performs, but chose to not enabled here in rclone due to many reported occurrences. See #6387 for more information. 2022-08-20 19:35:58 +08:00			`stylecheck:`
			`# Only enable the checks performed by the staticcheck stand-alone tool,`
			`# as documented here: https://staticcheck.io/docs/configuration/options/#checks`
			`checks: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022", "-ST1023"]`