Fix backward incompatibility issues released via KtLint 0.45.0 and 0.45.1 #1442
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…45.1. * Deprecate data class 'Params' as it only provides the userData parameter which prohibits API Consumers to split the '.editorconfig' properties from the other user data. * Deprecate function 'toExperimentalParams' to force API Consumers to start using the 'ExperimentalParams'. * In ExperimentalParams clarify that 'userData' should not contain any '.editorconfig' properties. Now also a runtime error is thrown whenever the lint/format methods are called and 'userData' contains '.editorconfig' properties. * Remove confusing TODO's about moving methods 'lint' and 'format' to the 'ktlint-test' module. * Update deprecation messages to clarify intention. * The 'lint' and 'format' methods in module 'ktlint-core' no longer call the 'VisitorProvider' with parameter 'isUnitTestContext' enabled. API Consumers call these methods with production code for which this parameter should be disabled. * The RuleExtension calls the 'lint' and 'format' methods but do provide a VisitorProvider for which the parameter 'isUnitTestContext' is enabled. * Deprecate the 'format' which accepted the 'ExperimentalParams' and 'Iterable<RuleSet>' while the latter is already included in the first. * Add new 'format' method which accepts 'ExperimentalParams' and 'VisitorProvider' only. * Move 'EditorConfigOverride' from 'ktlint-test' to 'ktlint-core' Closes pinterest#1434
Goooler
reviewed
Apr 2, 2022
Co-authored-by: Goooler <wangzongler@gmail.com>
….1' into 1434-backward-compatibility-0.45.1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Closes #1434
Checklist
CHANGELOG.mdis updatedIn case of adding a new rule:
README.mdis updated