Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading README regarding intellij integration #734

Closed
ColtonIdle opened this issue Apr 29, 2020 · 1 comment · Fixed by #1570
Closed

Misleading README regarding intellij integration #734

ColtonIdle opened this issue Apr 29, 2020 · 1 comment · Fixed by #1570
Labels
Milestone

Comments

@ColtonIdle
Copy link

According to #701 it sounds like intellij idea integration is imperfect.

I am proposing to deprecate current IntellijIDEA integration. Problem with it:

  • writes IDEA specific configuration xml files that could not be used by other editors
  • is detached from used rules and not configurable. Only generic style is written to configuration file.

The project readme makes it seem like it is perfect?

. with IntelliJ IDEA
While this is not strictly necessary it makes Intellij IDEA's built-in formatter produce 100% ktlint-compatible code

Hope someone can update/clarify to save time for the next person. It would really be nice to have direct guidance on how to use this with intellij, but it seems like the editorconfig is the way to go. If so, that should also be mentioned with hopefully instructions on how to generate an editorconfig from ktlint rules? Or a sample editorconfig available so that I can easily copy it into my project and have a 1:1 mapping between intellij editor and ktlint.

@Tapchicoma
Copy link
Collaborator

Readme is misleading. Written xml file controls only a small subset of kotlin style configuration:

Also this file is detached from rules, so updating it could be forgotten/nobody knows about it 🤷‍♂️

@paul-dingemans paul-dingemans added this to the 0.47.0 milestone Jul 1, 2022
paul-dingemans added a commit to paul-dingemans/ktlint that referenced this issue Aug 3, 2022
…`.editorconfig` property `disabled_rules` to `ktlint_disabled_rules`.

Closes pinterest#701
Closes pinterest#734
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants