Ktlint doesn't allow wildcard import? (Using IntelliJ auto import feature)

Question

I am running a Kotlin project with ktlint maven plugin (first time user). but whenever I do a maven build. I often see the failure along the lines of

src/main/kotlin/com/myproject/model/User.kt:7:1: Wildcard import (cannot be auto-corrected)

Since I use IntelliJ, I often rely on auto import where many subpackages are grouped into a wildcard (*). Is this what ktline used to enforce good import practices?

So your question is why ktlint doesn't allow wildcard imports? — Saurabh Thorat, Apr 09 '20 at 16:39
Maybe [this](https://stackoverflow.com/questions/147454/why-using-a-wild-card-with-a-java-import-statement-bad) one can help you. — I V, Apr 10 '20 at 00:20

score 15 · Accepted Answer · edited Jan 19 '23 at 06:37

15

As of version 0.34 or thereabouts you can override individual rules via EditorConfig. Add this to your .editorconfig file in the root of the project:

[*.{kt,kts}]
ktlint_no-wildcard-imports = disabled

https://pinterest.github.io/ktlint/faq/#how-do-i-globally-disable-a-rule

edited Jan 19 '23 at 06:37

joedeandev

626
1
6
15

answered Jun 17 '20 at 01:24

Alec

479
4
6

Alec could you please add an example here? – Yash Pokar Aug 27 '22 at 13:01
1

@YashPokar Added. Weird that they removed documentation from their Github page. – Alec Sep 20 '22 at 15:49
1

`disabled_rules` is deprecated as of ktlint 0.48. The supported way to do this is now: `ktlint_no-wildcard-imports = disabled` – joedeandev Jan 18 '23 at 04:16

JJ. · Answer 2 · 2022-06-08T08:37:37.763

6

I was using ktlint-gradle and using the command ./gradlew ktlintCheck and my .editorconfig wasn't getting picked up. I solved it by adding this to build.gradle

ktlint {
    disabledRules.set(setOf("no-wildcard-imports"))
}

edited Jun 08 '22 at 08:37

answered Jun 08 '22 at 07:45

JJ.

112
2
10

This stopped working lately with the following error `UserData should not contain '.editorconfig' properties [disabled_rules]. Such properties should be passed via the 'ExperimentalParams.editorConfigOverride' field. Note that this is only required for properties that (potentially) contain a value that differs from the actual value in the '.editorconfig' file.` Use the accepted answer instead – Totò Nov 25 '22 at 03:10

score 5 · Answer 3 · answered Apr 06 '23 at 08:13

5

ktlint changed the rule layout in .editoconfig (again). Now it has to be:

ktlint_standard_no-wildcard-imports = disabled

answered Apr 06 '23 at 08:13

mattelacchiato

317
3
11

This is the working solution now, starting version 0.49.0 of ktlint. Thanks @mattelacchiato – Ankit Gaurav May 05 '23 at 11:02

Ktlint doesn't allow wildcard import? (Using IntelliJ auto import feature)

3 Answers3