fix(deps): update ver_ktlint to v0.48.1 #1451
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.46.1
->0.48.1
0.46.1
->0.48.1
0.46.1
->0.48.1
0.46.1
->0.48.1
⚠ Dependency Lookup Warnings ⚠
Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information.
Release Notes
pinterest/ktlint
v0.48.1
Compare Source
Added
Removed
Fixed
no-semi
(#1733)standard:filename
rule whenever Ktlint CLI is run with option--stdin
(#1742)--log-level
is specified. Throw exception when an invalid value is passed. (#1749)experimental
rule set are disabled by default. (#1747)Changed
1.8.0
and Kotlin version to1.8.0
.v0.48.0
Compare Source
Indent rule
The
indent
rule has been rewritten from scratch. Solving problems in the old algorithm was very difficult. With the new algorithm this becomes a lot easier. Although the new implementation of the rule has been compared against several open source projects containing over 400,000 lines of code, it is still likely that new issues will be discovered. Please report your indentation issues so that these can be fixed as well..editorconfig
property to disable rulesIn the previous release (0.47.x), the
.editorconfig
propertydisabled_rules
was deprecated and replaced withktlint_disabled_rules
. This latter property has now been deprecated as well in favour of a more flexible and better maintainable solution. Rule and rule sets can now be enabled/disabled with a separate property per rule (set). Please read deprecation of (ktlint_)disable_rules property for more information.The KtLint CLI has not been changed. Although you can still use parameter
--experimental
to enable KtLint's Experimental rule set, you might want to set.editorconfig
propertyktlint_experimental = enabled
instead.API Changes & RuleSet providers
If you are not an API consumer or Rule Set provider then you can skip this section.
Class relocations
Classes below have been relocated:
com.pinterest.ktlint.core.api.UsesEditorConfigProperties.EditorConfigProperty
has been replaced withcom.pinterest.ktlint.core.api.editorconfig.EditorConfigProperty
.com.pinterest.ktlint.core.KtLintParseException
has been replaced withcom.pinterest.ktlint.core.api.KtLintParseException
.com.pinterest.ktlint.core.RuleExecutionException
has been replaced withcom.pinterest.ktlint.core.api.KtLintRuleException
.com.pinterest.ktlint.reporter.format.internal.Color
has been moved tocom.pinterest.ktlint.reporter.format.Color
.com.pinterest.ktlint.reporter.plain.internal.Color
has been moved tocom.pinterest.ktlint.reporter.plain.Color
.Invoking
lint
andformat
This is the last release that supports the
ExperimentalParams
to invoke thelint
andformat
functions of KtLint. TheExperimentalParams
contains a mix of configuration settings which are not dependent on the file/code which is to be processed. Other parameters in that class describe the code/file to be processed but can be configured inconsistently (for example a file with name "foo.kt" could be marked as a Kotlin Script file).The static object
KtLint
is deprecated and replaced by classKtLintRuleEngine
which is configured withKtLintRuleEngineConfiguration
. The instance of theKtLintRuleEngine
is intended to be reused for scanning all files in a project and should not be recreated per file.Both
lint
andformat
are simplified and can now be called for a code block or for an entire file.Retrieve
.editorconfig
sThe list of
.editorconfig
files which will be accessed by KtLint when linting or formatting a given path can now be retrieved with the new APIKtLint.editorConfigFilePaths(path: Path): List<Path>
.This API can be called with either a file or a directory. It's intended usage is that it is called once with the root directory of a project before actually linting or formatting files of that project. When called with a directory path, all
.editorconfig
files in the directory or any of its subdirectories (except hidden directories) are returned. In case the given directory does not contain an.editorconfig
file or if it does not contain theroot=true
setting, the parent directories are scanned as well until a root.editorconfig
file is found.Calling this API with a file path results in the
.editorconfig
files that will be accessed when processing that specific file. In case the directory in which the file resides does not contain an.editorconfig
file or if it does not contain theroot=true
setting, the parent directories are scanned until a root.editorconfig
file is found.Psi filename replaces FILE_PATH_USER_DATA_KEY
Constant
KtLint.FILE_PATH_USER_DATA_KEY
is deprecated and will be removed in KtLint version 0.49.0. The file name will be passed correctly to the node with element type FILE and can be retrieved as follows:Added
wrapping
(#1643)stdin
with the--patterns-from-stdin
command line options/flags (#1606)indent
rule and new experimental rulecontext-receiver-wrapping
(#1672)class-naming
), functions (function-naming
) and properties (property-naming
) (#44)plain-summary
which prints a summary the number of violation which have been autocorrected or could not be autocorrected, both split by rule.Fixed
.editorconfig
when running CLI with options--stdin
and--editorconfig
(#1651)trailing-comma-on-call-site
(#1642)ktlint_disabled_rules
to exposededitorConfigProperties
(#1671)trailing-comma-on-declaration-site
andtrailing-comma-on-call-site
(#1676)function-signature
(#1690)Changed
1.8.0-RC
and Kotlin version to1.7.21
.true
unless theandroid codestyle
is enabled. Note that KtLint from a consistency viewpoint enforces the trailing comma on call site while default IntelliJ IDEA formatting only allows the trailing comma but leaves it up to the developer's discretion. (#1670)true
unless theandroid codestyle
is enabled. Note that KtLint from a consistency viewpoint enforces the trailing comma on declaration site while default IntelliJ IDEA formatting only allows the trailing comma but leaves it up to the developer's discretion. (#1669)--debug
,--trace
,--verbose
and-v
are replaced with--log-level=<level>
or the short version `-l=, see CLI log-level. (#1632)--log-level=none
or-l=none
(#1652)indent
rule. Solving problems in the old algorithm was very difficult. With the new algorithm this becomes a lot easier. Although the new implementation of the rule has been compared against several open source projects containing over 400,000 lines of code, it is still likely that new issues will be discovered. Please report your indentation issues so that these can be fixed as well. (#1682, #1321, #1200, #1562, #1563, #1639)indent
rule. Solving problems in the old algorithm was very difficult. With the new algorithm this becomes a lot easier. Although the new implementation of the rule has been compared against several open source projects containing over 400,000 lines of code, it is still likely that new issues will be discovered. Please report your indentation issues so that these can be fixed as well. (#1682, #1321, #1200, #1562, #1563, #1639, #1688)java 19
, remove support for running tests onjava 18
.io.github.detekt.sarif4k:sarif4k
version to0.2.0
(#1701).v0.47.1
Compare Source
Fixed
trailing-comma-on-call-site
,trailing-comma-on-declaration-site
) (#1602)--disabled-rules
(#1599)@file:Suppress
on all toplevel declarations (#1623)Changed
v0.47.0
Compare Source
API Changes & RuleSet providers
If you are not an API consumer nor a RuleSet provider, then you can safely skip this section. Otherwise, please read below carefully and upgrade your usage of ktlint. In this and coming releases, we are changing and adapting important parts of our API in order to increase maintainability and flexibility for future changes. Please avoid skipping a releases as that will make it harder to migrate.
Rule lifecycle hooks / deprecate RunOnRootOnly visitor modifier
Up until ktlint 0.46 the Rule class provided only one life cycle hook. This "visit" hook was called in a depth-first-approach on all nodes in the file. A rule like the IndentationRule used the RunOnRootOnly visitor modifier to call this lifecycle hook for the root node only in combination with an alternative way of traversing the ASTNodes. Downside of this approach was that suppression of the rule on blocks inside a file was not possible (#631). More generically, this applied to all rules, applying alternative traversals of the AST.
The Rule class now offers new life cycle hooks:
Optionally, a rule can stop the traversal of the remainder of the AST whenever the goal of the rule has been achieved. See KDoc on Rule class for more information.
The "visit" life cycle hook will be removed in Ktlint 0.48. In KtLint 0.47 the "visit" life cycle hook will be called only when hook "beforeVisitChildNodes" is not overridden. It is recommended to migrate to the new lifecycle hooks in KtLint 0.47. Please create an issue, in case you need additional assistence to implement the new life cycle hooks in your rules.
Ruleset providing by Custom Rule Set Provider
The KtLint engine needs a more fine-grained control on the instantiation of new Rule instances. Currently, a new instance of a rule can be created only once per file. However, when formatting files the same rule instance is reused for a second processing iteration in case a Lint violation has been autocorrected. By re-using the same rule instance, state of that rule might leak from the first to the second processing iteration.
Providers of custom rule sets have to migrate the custom rule set JAR file. The current RuleSetProvider interface which is implemented in the custom rule set is deprecated and marked for removal in KtLint 0.48. Custom rule sets using the old RuleSetProvider interface will not be run in KtLint 0.48 or above.
For now, it is advised to implement the new RuleSetProviderV2 interface without removing the old RuleSetProvider interface. In this way, KtLint 0.47 and above use the RuleSetProviderV2 interface and ignore the old RuleSetProvider interface completely. KtLint 0.46 and below only use the old RuleSetProvider interface.
Adding the new interface is straight forward, as can be seen below:
Also note that file 'resource/META-INF/services/com.pinterest.ktlint.core.RuleSetProviderV2' needs to be added. In case your custom rule set provider implements both RuleSetProvider and RuleSetProviderV2, the resource directory contains files for both implementation. The content of those files is identical as the interfaces are implemented on the same class.
Once above has been implemented, rules no longer have to clean up their internal state as the KtLint rule engine can request a new instance of the Rule at any time it suspects that the internal state of the Rule is tampered with (e.g. as soon as the Rule instance is used for traversing the AST).
Rule set providing by API Consumer
The KtLint engine needs a more fine-grained control on the instantiation of new Rule instances. Currently, a new instance of a rule can be created only once per file. However, when formatting files the same rule instance is reused for a second processing iteration in case a Lint violation has been autocorrected. By re-using the same rule instance, state of that rule might leak from the first to the second processing iteration.
The ExperimentalParams parameter which is used to invoke "KtLint.lint" and "KtLint.format" contains a new parameter "ruleProviders" which will replace the "ruleSets" parameter in KtLint 0.48. Exactly one of those parameters should be a non-empty set. It is preferred that API consumers migrate to using "ruleProviders".
Once above has been implemented, rules no longer have to clean up their internal state as the KtLint rule engine can request a new instance of the Rule at any time it suspects that the internal state of the Rule is tampered with (e.g. as soon as the Rule instance is used for traversing the AST).
Format callback
The callback function provided as parameter to the format function is now called for all errors regardless whether the error has been autocorrected. Existing consumers of the format function should now explicitly check the
autocorrected
flag in the callback result and handle it appropriately (in most case this will be ignoring the callback results for whichautocorrected
has valuetrue
).CurrentBaseline
Class
com.pinterest.ktlint.core.internal.CurrentBaseline
has been replaced withcom.pinterest.ktlint.core.api.Baseline
.Noteworthy changes:
baselineRules
(nullable) is replaced with `lintErrorsPerFile (non-nullable).baselineGenerationNeeded
(boolean) is replaced withstatus
(typeBaseline.Status
).The utility functions provided via
com.pinterest.ktlint.core.internal.CurrentBaseline
are moved to the new class. One new methodList<LintError>.doesNotContain(lintError: LintError)
is added..editorconfig property "disabled_rules"
The
.editorconfig
propertydisabled_rules
(api propertyDefaultEditorConfigProperties.disabledRulesProperty
) has been deprecated and will be removed in a future version. Usektlint_disabled_rules
(api propertyDefaultEditorConfigProperties.ktlintDisabledRulesProperty
) instead as it more clearly identifies that ktlint is the owner of the property. This property is to be renamed in.editorconfig
files andExperimentalParams.editorConfigOverride
.Although, Ktlint 0.47.0 falls back on property
disabled_rules
wheneverktlint_disabled_rules
is not found, this result in a warning message being printed.Default/alternative .editorconfig
Parameter "ExperimentalParams.editorConfigPath" is deprecated in favor of the new parameter "ExperimentalParams.editorConfigDefaults". When used in the old implementation this resulted in ignoring all ".editorconfig" files on the path to the file. The new implementation uses properties from the "editorConfigDefaults"parameter only when no ".editorconfig" files on the path to the file supplies this property for the filepath.
API consumers can easily create the EditConfigDefaults by calling
"EditConfigDefaults.load(path)" or creating it programmatically.
Reload of
.editorconfig
fileSome API Consumers keep a long-running instance of the KtLint engine alive. In case an
.editorconfig
file is changed, which was already loaded into the internal cache of the KtLint engine this change would not be taken into account by KtLint. One way to deal with this, was to clear the entire KtLint cache after each change in an.editorconfig
file.Now, the API consumer can reload an
.editorconfig
. If the.editorconfig
with given path is actually found in the cached, it will be replaced with the new value directly. If the file is not yet loaded in the cache, loading will be deferred until the file is actually requested again.Example:
Miscellaneous
Several methods for which it is unlikely that they are used by API consumers have been marked for removal from the public API in KtLint 0.48.0. Please create an issue in case you have a valid business case to keep such methods in the public API.
Added
format
reporter. This reporter prints a one-line-summary of the formatting status per file. (#621).Fixed
filename
(#1521).indent
) #631enum-entry-name-case
,filename
) (#1530).ktlint
cli on default kotlin extensions only when an (existing) path to a directory is given. (#917).format
function for all errors including errors that are autocorrected (#1491)function-signature
(#1527)multiline-if-else
(#1560)multiline-if-else
(#828)ktlint_code_style
(#1559)trailing-comma
(#1542)trailing-comma
intotrailing-comma-on-call-site
andtrailing-comma-on-declaration-site
(#1555)wrapping
(#1578)Changed
format
function for all errors including errors that are autocorrected (#1491)annotation
(#1574).editorconfig
propertydisabled_rules
toktlint_disabled_rules
(#701)1.7.20-beta
and Kotlin version to1.7.10
.7.5.1
versionRemoved
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR has been generated by Mend Renovate. View repository job log here.