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

Remove deprecated cli parameters --experimental, --code-style, --disabled-rules #2411

Merged
merged 7 commits into from
Dec 3, 2023

Conversation

paul-dingemans
Copy link
Collaborator

Description

Remove deprecated cli parameters --experimental, --code-style, --disabled-rules

The .editorconfig is used for managing the configuration of ktlint regardless which API Consumer (for example Ktlint CLI, the KtLint intellij plugin, or third party integrators like Detekt, Spotless) is used. By using the .editorconfig, developers on the same project can use different tools to invoke ktlint, but the configuration is stored in 1 central place.

Ktlint CLI parameters --experimental, --code-style and --disabled-rules shadow .editorconfig properties, and should no longer be used. The parameters have been deprecated in a previous ktlint version (1.0), and so far only 1 request (#2397) to not remove them has been received.

The code style can be managed via .editorconfig property ktlint_code_style. See https://pinterest.github.io/ktlint/latest/rules/configuration-ktlint/

The disabled rules can be managed via .editorconfig properties. See:

Experimental rules can be managed via .editorconfig property ktlint_experimental. Also, it is possible via the .editorconfig to enable specific experimental rules. See:

Checklist

Before submitting the PR, please check following (checks which are not relevant may be ignored):

  • Commit message are well written. In addition to a short title, the commit message also explain why a change is made.
  • At least one commit message contains a reference Closes #<xxx> or Fixes #<xxx> (replace<xxx> with issue number)
  • Tests are added
  • KtLint format has been applied on source code itself and violations are fixed
  • PR title is short and clear (it is used as description in the release changelog)
  • PR description added (background information)

Documentation is updated. See difference between snapshot and release documentation

  • Snapshot documentation in case documentation is to be released together with a code change
  • Release documentation in case documentation is related to a released version of ktlint and has to be published as soon as the change is merged to master

@paul-dingemans paul-dingemans merged commit d8955a6 into master Dec 3, 2023
22 checks passed
@paul-dingemans paul-dingemans deleted the remove-deprecated-cli-parameters branch December 3, 2023 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant