TrueCloudLab/rclone
16
0
Fork 2
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions 1
rclone/.golangci.yml

145 lines
3.6 KiB
YAML
Raw Normal View History

build: use golangci-lint for code quality checks
2019-01-11 16:29:49 +00: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 12:14:51 +00:00
- revive
build: use golangci-lint for code quality checks
2019-01-11 16:29:49 +00: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 11:35:58 +00: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 10:12:17 +00:00
- unused
build: enable misspell linter
2022-08-30 10:39:21 +00:00
- misspell
build: enable gocritic linter Running with default set of checks, except disabling the following - appendAssign: append result not assigned to the same slice (diagnostics check, many false positives) - captLocal: using capitalized names for local variables (style check, too opinionated) - commentFormatting: not having a space between `//` and comment text (style check, too opinionated) - exitAfterDefer: log.Fatalln will exit, and `defer func(){...}(...)` will not run (diagnostics check, to be revisited) - ifElseChain: rewrite if-else to switch statement (style check, many occurrences and a bit opinionated, to be revisited) - singleCaseSwitch: should rewrite switch statement to if statement (style check, many occurrences and a bit opinionated, to be revisited)
2024-06-01 09:46:31 +00:00
- gocritic
build: use golangci-lint for code quality checks
2019-01-11 16:29:49 +00:00
#- prealloc
#- maligned
disable-all: true
issues:
golangci: enable lints excluded by default
2019-02-09 11:25:05 +00:00
# Enable some lints excluded by default
exclude-use-default: false
build: use golangci-lint for code quality checks
2019-01-11 16:29:49 +00: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-08 22:18:18 +00:00
max-issues-per-linter: 0
build: use golangci-lint for code quality checks
2019-01-11 16:29:49 +00: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 14:58:52 +00:00
build: exclude known issues from the staticcheck linting in ci
2022-08-20 18:54:18 +00:00
exclude-rules:
- linters:
- staticcheck
text: 'SA1019: "github.com/rclone/rclone/cmd/serve/httplib" is deprecated'
build: re-enable revive linters In this commit: 75dfdbf211593cea ci: revert revive settings back to fix lint We accidentally disabled all the revive linters. Unfortunately setting the rules clears the default set of rules so it is necessary to mention all rules that we need.
2023-08-29 11:58:05 +00:00
# don't disable the revive messages about comments on exported functions
include:
- EXC0012
- EXC0013
- EXC0014
- EXC0015
build: increase timeout for golangci-lint to 10 minutes
2021-10-15 14:58:52 +00: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 14:17:18 +00:00
linters-settings:
revive:
build: re-enable revive linters In this commit: 75dfdbf211593cea ci: revert revive settings back to fix lint We accidentally disabled all the revive linters. Unfortunately setting the rules clears the default set of rules so it is necessary to mention all rules that we need.
2023-08-29 11:58:05 +00:00
# setting rules seems to disable all the rules, so re-enable them here
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 14:17:18 +00:00
rules:
build: re-enable revive linters In this commit: 75dfdbf211593cea ci: revert revive settings back to fix lint We accidentally disabled all the revive linters. Unfortunately setting the rules clears the default set of rules so it is necessary to mention all rules that we need.
2023-08-29 11:58:05 +00:00
- name: blank-imports
disabled: false
- name: context-as-argument
disabled: false
- name: context-keys-type
disabled: false
- name: dot-imports
disabled: false
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 14:17:18 +00:00
- name: empty-block
disabled: true
build: re-enable revive linters In this commit: 75dfdbf211593cea ci: revert revive settings back to fix lint We accidentally disabled all the revive linters. Unfortunately setting the rules clears the default set of rules so it is necessary to mention all rules that we need.
2023-08-29 11:58:05 +00:00
- name: error-naming
disabled: false
- name: error-return
disabled: false
- name: error-strings
disabled: false
- name: errorf
disabled: false
- name: exported
disabled: false
- name: increment-decrement
disabled: true
- name: indent-error-flow
disabled: false
- name: package-comments
disabled: false
- name: range
disabled: false
- name: receiver-naming
disabled: false
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 14:17:18 +00:00
- name: redefines-builtin-id
disabled: true
- name: superfluous-else
disabled: true
build: re-enable revive linters In this commit: 75dfdbf211593cea ci: revert revive settings back to fix lint We accidentally disabled all the revive linters. Unfortunately setting the rules clears the default set of rules so it is necessary to mention all rules that we need.
2023-08-29 11:58:05 +00:00
- name: time-naming
disabled: false
- name: unexported-return
disabled: false
- name: unreachable-code
disabled: true
- name: unused-parameter
disabled: true
- name: var-declaration
disabled: false
- name: var-naming
disabled: false
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 11:35:58 +00: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"]
build: enable gocritic linter Running with default set of checks, except disabling the following - appendAssign: append result not assigned to the same slice (diagnostics check, many false positives) - captLocal: using capitalized names for local variables (style check, too opinionated) - commentFormatting: not having a space between `//` and comment text (style check, too opinionated) - exitAfterDefer: log.Fatalln will exit, and `defer func(){...}(...)` will not run (diagnostics check, to be revisited) - ifElseChain: rewrite if-else to switch statement (style check, many occurrences and a bit opinionated, to be revisited) - singleCaseSwitch: should rewrite switch statement to if statement (style check, many occurrences and a bit opinionated, to be revisited)
2024-06-01 09:46:31 +00:00
gocritic:
build: enable custom linting rules with ruleguard via gocritic
2024-06-01 10:25:42 +00:00
# Enable all default checks with some exceptions and some additions (commented).
# Cannot use both enabled-checks and disabled-checks, so must specify all to be used.
disable-all: true
enabled-checks:
#- appendAssign # Enabled by default
- argOrder
- assignOp
- badCall
- badCond
#- captLocal # Enabled by default
- caseOrder
- codegenComment
#- commentFormatting # Enabled by default
- defaultCaseOrder
- deprecatedComment
- dupArg
- dupBranchBody
- dupCase
- dupSubExpr
- elseif
#- exitAfterDefer # Enabled by default
- flagDeref
- flagName
#- ifElseChain # Enabled by default
- mapKey
- newDeref
- offBy1
- regexpMust
- ruleguard # Not enabled by default
#- singleCaseSwitch # Enabled by default
- sloppyLen
- sloppyTypeAssert
- switchTrue
- typeSwitchVar
- underef
- unlambda
- unslice
- valSwap
- wrapperFunc
settings:
ruleguard:
rules: "${configDir}/bin/rules.go"
Reference in a new issue Copy permalink