Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: replace run.skip-xxx options by issues.exclude-xxx options #4509

Merged
merged 15 commits into from
Mar 16, 2024

Conversation

ldez
Copy link
Member

@ldez ldez commented Mar 15, 2024

The option name skip-xxx is a source of confusion.
And to increase the confusion, those options are inside the section run.

This sample of issues illustrate the problem: #1912, #2748, #4084, #3775, #1832, #4360

My proposal is move and rename those options:

  • run.skip-dirs deprecation: replaced by issues.exclude-dirs
  • run.skip-dirs-use-default deprecation: replaced by issues.exclude-dirs-use-default
  • run.skip-files deprecation: replaced by issues.exclude-files

This is a non-breaking change: the skip-xxx will still work but with a warning, and issues.exclude-xxx options do the same things as skip-xxx.

log output

Using a flag:

$ go run ./cmd/golangci-lint run --skip-dirs=foo
Flag --skip-dirs has been deprecated, check the documentation for more information.
WARN [config_reader] The configuration option `run.skip-dirs` is deprecated, please use `issues.exclude-dirs`. 

Using the file:

$ go run ./cmd/golangci-lint run
WARN [config_reader] The configuration option `run.skip-dirs` is deprecated, please use `issues.exclude-dirs`. 

one commit, one change.

@ldez ldez added enhancement New feature or improvement area: config Related to .golangci.yml and/or cli options labels Mar 15, 2024
@ldez ldez force-pushed the feat/skip-deprecation branch 6 times, most recently from 9b1cfe1 to ad09dde Compare March 15, 2024 04:46
.golangci.next.reference.yml Outdated Show resolved Hide resolved
.golangci.next.reference.yml Show resolved Hide resolved
.golangci.next.reference.yml Show resolved Hide resolved
@ldez ldez added this to the next milestone Mar 15, 2024
@ldez ldez force-pushed the feat/skip-deprecation branch from 894fabc to 5de9d08 Compare March 15, 2024 16:55
pkg/commands/flagsets.go Outdated Show resolved Hide resolved
@ldez ldez force-pushed the feat/skip-deprecation branch from 2b038c9 to a69b8b6 Compare March 15, 2024 18:45
@ldez ldez force-pushed the feat/skip-deprecation branch from a69b8b6 to ceef5f7 Compare March 15, 2024 18:46
@ldez ldez force-pushed the feat/skip-deprecation branch from ceef5f7 to 7b2fd9f Compare March 15, 2024 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: config Related to .golangci.yml and/or cli options enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants