Add support for disabled_rules property in .editorconfig for globally disabling rules #503

shashachu · 2019-06-26T07:26:05Z

Fixes #208

Takes in a comma-separated list of rule ids, with namespaces (e.g. experimental:indent)
Re-enabled NoWildcardImports, PackageNameRule
Un-commented AnnotationRule, MultiLineIfElseRule, and NoItParamInMultilineLambdaRule, and moved disabling into default .editorconfig
Moved .editorconfig parsing into ktlint-core so that plugins that don't invoke ktlint on the command line can take advantage of rule disabling
Also cleaned up params passed to lint and format

shashachu · 2019-06-26T07:31:22Z

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/internal/EditorConfigInternal.kt

@@ -8,8 +8,8 @@ import java.util.Properties
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.ConcurrentHashMap

-class EditorConfig private constructor (
-    val parent: EditorConfig?,
+class EditorConfigInternal private constructor (


Totally open to better names for this class.

What's wrong with just EditorConfig ;) ?

@arturbosch there's already an EditorConfig interface inside of ktlint-core so if you want to use one or the other you need a lot of ugly namespacing. :) We can also rename that one, but I couldn't think of a name for that one!

Oh, didn't know that.
I like to use a Defaultfor my implementations of an interface.
So maybe consider DefaultEditorConfig.

@arturbosch but that's the thing - the internal one is actually not an implementation of the EditorConfig interface ;)

haha correct! I don't have context about why it was implemented this way. I thought about naming the internal one ParsedEditorConfig or EditorConfigParser or something...

shashachu · 2019-06-26T07:31:53Z

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt

     * @throws ParseException if text is not a valid Kotlin code
     * @throws RuleExecutionException in case of internal failure caused by a bug in rule implementation
     */
-    fun lint(text: String, ruleSets: Iterable<RuleSet>, cb: (e: LintError) -> Unit) {


Removed all the overrides and just pass in Params now.

shashachu · 2019-06-26T07:32:49Z

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt

+            .forEach { e -> params.cb(e, false) }
+    }
+
+    private fun userDataResolver(editorConfigPath: String?, debug: Boolean): (String?) -> Map<String, String> {


Moved from Main.kt

shashachu · 2019-06-28T18:29:25Z

@jaredsburrows @Tapchicoma @jeremymailen @JLLeitschuh @bethcutler Thoughts on this PR?

jeremymailen

Thank you, looks great to me! A couple questions to make sure I understand how rule disabling is used, but structurally seems like it should work well with plugins that use ktlint.

jeremymailen · 2019-06-29T14:00:40Z

ktlint-core/src/test/kotlin/com/pinterest/ktlint/core/DisabledRulesTest.kt

+                        text = "var foo",
+                        ruleSets = listOf(RuleSet("standard", NoVarRule())),
+                        cb = { e, _ -> add(e) },
+                        userData = mapOf(("disabled_rules" to "no-var"))


I love the ability to pass in the disabled_rules as a regular userData param or via editor config 👍

jeremymailen · 2019-06-29T14:02:39Z

.editorconfig

+# multiline-if-else - disabled until auto-correct is working properly
+#   (e.g. try formatting "if (true)\n    return { _ ->\n        _\n}")
+# no-it-in-multiline-lambda - disabled until it's clear what to do in case of `import _.it`
+disabled_rules=annotation,multiline-if-else,no-it-in-multiline-lambda


When a rule is not prefixed with anamespace: is it assumed to be in the standard set?

Yep, see this

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt

… disabling rules Fixes pinterest#208 * Takes in a comma-separated list of rule ids, with namespaces (e.g. `experimental:indent`) * Re-enabled `NoWildcardImports`, `PackageNameRule` * Un-commented `AnnotationRule`, `MultiLineIfElseRule`, and `NoItParamInMultilineLambdaRule`, and moved disabling into default `.editorconfig` * Also cleaned up params passed to lint and format

JorgeCastilloPrz · 2019-07-08T10:19:32Z

Does it require some docs in README?

shashachu · 2019-07-08T15:01:47Z

Yes; I like to wait to update the README until we're ready to release so it doesn't look like features are available that have not yet released.

elenigen · 2019-07-10T20:53:49Z

Do we know when is planned the next release of ktlin to include this new feature of allowing to disable rules?

shashachu · 2019-07-10T21:22:56Z

Do we know when is planned the next release of ktlin to include this new feature of allowing to disable rules?

@elenigen I am targeting the end of this week.

… disabling rules (pinterest#503) * Add support for disabled_rules property to .editorconfig for globally disabling rules Fixes pinterest#208 * Takes in a comma-separated list of rule ids, with namespaces (e.g. `experimental:indent`) * Re-enabled `NoWildcardImports`, `PackageNameRule` * Un-commented `AnnotationRule`, `MultiLineIfElseRule`, and `NoItParamInMultilineLambdaRule`, and moved disabling into default `.editorconfig` * Also cleaned up params passed to lint and format

shashachu mentioned this pull request Jun 26, 2019

Implement .ktlintignore for globally disabling rules #459

Closed

shashachu commented Jun 26, 2019

View reviewed changes

jeremymailen approved these changes Jun 29, 2019

View reviewed changes

This was referenced Jul 1, 2019

Unit return types arrow-kt/arrow#1386

Closed

Add documentation to disable ktlint No Unit returns errors arrow-kt/arrow#1502

Closed

shashachu added 4 commits July 2, 2019 21:59

Added test for rule disabling

a195769

fix lint issues with new test

9c959bd

Move disabled_rules into its own userdata key

20c7758

shashachu force-pushed the ktlintignore branch from 1f547d2 to 20c7758 Compare July 3, 2019 04:59

shashachu added 3 commits July 2, 2019 22:19

merge conflict, cleanup

2165939

lint fix, address review feedback

cd2ebdf

Add comment re disabled rules

0ced6d5

shashachu mentioned this pull request Jul 3, 2019

Fix typo from IntentStyle to IndentStyle in EditorConfig #511

Closed

shashachu merged commit ba513d7 into pinterest:master Jul 3, 2019

shashachu mentioned this pull request Jul 3, 2019

Add tests for missing rules in a ruleset #477

Merged

shashachu deleted the ktlintignore branch July 5, 2019 16:23

shashachu mentioned this pull request Jul 5, 2019

Rule: newline before "{" #458

Closed

idntfy mentioned this pull request Jul 17, 2019

Use cli param value as a source of globally disabled rules #533

Closed

shashachu mentioned this pull request Jul 27, 2019

ktLint 0.34 changes not compatible with spotless diffplug/spotless#419

Closed

dadadom mentioned this pull request Aug 6, 2019

disabled-rules for ktlint in .editorconfig is ignored jeremymailen/kotlinter-gradle#112

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for disabled_rules property in .editorconfig for globally disabling rules #503

Add support for disabled_rules property in .editorconfig for globally disabling rules #503

shashachu commented Jun 26, 2019 •

edited

Loading

shashachu Jun 26, 2019 •

edited

Loading

arturbosch Jun 26, 2019

shashachu Jun 26, 2019

arturbosch Jun 26, 2019

romtsn Jun 26, 2019

shashachu Jun 26, 2019

shashachu Jun 26, 2019

shashachu Jun 26, 2019

shashachu commented Jun 28, 2019

jeremymailen left a comment

jeremymailen Jun 29, 2019

jeremymailen Jun 29, 2019

romtsn Jun 29, 2019 •

edited

Loading

JorgeCastilloPrz commented Jul 8, 2019 •

edited

Loading

shashachu commented Jul 8, 2019

elenigen commented Jul 10, 2019

shashachu commented Jul 10, 2019

Add support for disabled_rules property in .editorconfig for globally disabling rules #503

Add support for disabled_rules property in .editorconfig for globally disabling rules #503

Conversation

shashachu commented Jun 26, 2019 • edited Loading

shashachu Jun 26, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shashachu commented Jun 28, 2019

jeremymailen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

romtsn Jun 29, 2019 • edited Loading

Choose a reason for hiding this comment

JorgeCastilloPrz commented Jul 8, 2019 • edited Loading

shashachu commented Jul 8, 2019

elenigen commented Jul 10, 2019

shashachu commented Jul 10, 2019

shashachu commented Jun 26, 2019 •

edited

Loading

shashachu Jun 26, 2019 •

edited

Loading

romtsn Jun 29, 2019 •

edited

Loading

JorgeCastilloPrz commented Jul 8, 2019 •

edited

Loading