Initial implementation of IDE integration via editorconfig #874
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
romtsn
reviewed
Aug 29, 2020
ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/internal/EditorConfigGenerator.kt
Outdated
Show resolved
Hide resolved
ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigGeneratorTest.kt
Show resolved
Hide resolved
ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/api/UsesEditorConfigProperties.kt
Outdated
Show resolved
Hide resolved
|
LGTM 👍 looks way cleaner now (esp. on a calling side). What if we have a custom EC property (like ij_kotlin_something) - we'd need to create our own PropertyType, right? |
romtsn
approved these changes
Sep 8, 2020
Yes, for that custom |
Two annotations: - feature in alpha state - this is highly experimental feature that will change in the future. - feature in beta state - experimental feature that may have some bugs. Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
Tapchicoma
force-pushed
the
701/initial-editorconfig-integration
branch
from
a3fbfe4
to
aa8f239
Compare
This interface should be used by rules to provide default editorconfig properties. This is used to generate missing properties for .editorconfig and enable better integration with IDE. Feature is set to be in alpha state. Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
Should simplify writing tests for rules implementing UsesEditorConfigProperty interface. Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
This will allow to load written by test case `.editorconfig` file. Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
Split into smaller test-cases, use EditorConfigTestRule. Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
Tapchicoma
force-pushed
the
701/initial-editorconfig-integration
branch
2 times, most recently
from
79c4bcb
to
13b9870
Compare
Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
gnawf
suggested changes
Sep 18, 2020
ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/api/UsesEditorConfigProperties.kt
Outdated
Show resolved
Hide resolved
ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt
Outdated
Show resolved
Hide resolved
ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt
Outdated
Show resolved
Hide resolved
ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigGeneratorTest.kt
Outdated
Show resolved
Hide resolved
ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/internal/EditorConfigGeneratorTest.kt
Outdated
Show resolved
Hide resolved
|
@gnawf thank you for noticing it, will fix nits 👍 |
Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
Make it follow common pattern '*EditorConfig*'. Signed-off-by: Yahor Berdnikau <egorr.berd@gmail.com>
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.
This PR brings base implementation of IDE integration via
.editorconfigfile:UsesEditorConfigPropertiesthat rule should implement to provide default values to generated.editorconfigfile. Just as an example on how it will be - 'final-newline' rule was updated to support it. In followup PR all standard rules should be updated to support it.KtLintobject -generateKotlinEditorconfigSection(params)that generates.editorconfigKotlin section based on existing.editorconfigand default rules values. CLI support will be added in followup PR.Additionally I've introduced two annotations -
FeatureInAlphaStateandFeatureInBetaStateto indicate that this feature is experimental and api may change.Update:
EditorConfigTestRuleto simplify writing.editorconfigfile content for testsRuleextension methods for tests that additionally accepts linted file path, so KtLint will load located in the same folder.editorconfigfile.Part of #701 issue