Ability to control blank lines between groups

[nafg]

I would like to reproduce my intellij config as closely as possible. In .idea/codeStyles/Project.xml I have this:

      <option name="importLayout">
        <array>
          <option value="java" />
          <option value="_______ blank line _______" />
          <option value="scala" />
          <option value="_______ blank line _______" />
          <option value="org.scalajs" />
          <option value="play" />
          <option value="net.liftweb" />
          <option value="reactive" />
          <option value="slick" />
          <option value="japgolly" />
          <option value="io.github.nafg" />
          <option value="_______ blank line _______" />
          <option value="all other imports" />
          <option value="_______ blank line _______" />
          <option value="chesednow" />
        </array>
      </option>

So for example, imports from japgolly should always go before imports from io.github.nafg, however I don't want a blank line between them.

Is there any way to achieve this, or could there be?

[liancheng]

@nafg, that's a nice feature request. It cannot be done today but can be added relatively easily. I'd add one configuration named blankLines and a special group - representing the blank line.

When blankLines is set to Auto, which is the default value, OrganizeImports respects the current behavior, i.e., a blank line is automatically inserted between adjacent groups. When blankLines is set to Manual, you need to add the - group to insert blank lines manually.

With this, your sample configuration can be translated into:

OrganizeImports {
  blankLines = "Manual"
  groups = [
    "re:javax?\\."
    "-"
    "scala."
    "-"
    "org.scalajs."
    "play."
    "net.liftweb."
    "reactive."
    "slick."
    "japgolly."
    "io.github.nafg."
    "-"
    "*"
    "-"
    "chesednow"
  ]
}

WDYT?

[liancheng]

Maybe use --- instead of - to make the blank line groups easier to locate visually.

[nafg]

That sounds like a great strategy.

…

On Mon, Dec 14, 2020 at 8:59 PM Cheng Lian ***@***.***> wrote: Maybe use --- instead of - to make the blank line groups easier to locate visually. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#140 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAYAUDUQ5GPESUKXZ4PDF3SU27IVANCNFSM4UZYH2YQ> .

[liancheng]

@nafg I had a draft implementation for this feature in PR #142. It turned out to be much hairier than I initially expected. I'll try to see whether things can be refactored and simplified. On the other hand, here's a workaround that largely satisfies your requirement. You can configure the OrganizeImports as following:

OrganizeImports {
  groups = [
    "re:javax?\\."
    "scala."
    "re:(org\\.scalajs|play|net\\.liftweb|reactive|slick|japgolly|io\\.github\\.nafg)\\."
    "*"
    "chesednow"
  ]
}

The only thing is that the 3rd group will sort all the imports in that group according to the importsOrder configuration, so it does not strictly reflect the original order you wanted. However, I think it makes more sense to order them alphabetically instead of using an ad-hoc order? Are there any reasons why you prefer the specific order you listed in the PR description? (I get that it eases migration if your IntelliJ is already configured like that.)

[nafg]

My main reason is that being able to use it without making changes across the codebase. I primarily use intellij to organize imports. If I could run a fast command line tool across the codebase that would not rock the boat too much it would be nice.

…

On Wed, Dec 16, 2020, 2:47 PM Cheng Lian ***@***.***> wrote: @nafg <https://github.com/nafg> I had a draft implementation for this feature in PR #142 <#142>. It turned out to be much hairier than I initially expected. I'll try to see whether things can be refactored and simplified. On the other hand, here's a workaround that largely satisfies your requirement. You can configure the OrganizeImports as following: OrganizeImports { groups = [ "re:javax?\\." "scala." "re:(org\\.scalajs|play|net\\.liftweb|reactive|slick|japgolly|io\\.github\\.nafg)\\." "*" "chesednow" ] } The only thing is that the 3rd group will sort all the imports in that group according to the importsOrder configuration, so it does not strictly reflect the original order you wanted. However, I think it makes more sense to order them alphabetically instead of using an ad-hoc order? Are there any reasons why you prefer the specific order you listed in the PR description? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#140 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAYAUFI3J2OOHJB3JTRMBLSVEFD5ANCNFSM4UZYH2YQ> .

[liancheng]

@nafg, thanks for the context. So it's for migrating existing projects using IntelliJ import optimizer to OrganizeImports. That totally makes sense. Let me try to find some time to refactor #142 and add tests.