Pick TabsAndIndentsStyle from .editorconfig

[vlsi]

What problem are you trying to solve?

I am trying to duplicate the configuration between .editorcofig and OpenRewrite.

Describe the solution you'd like

I would like OpenRewrite to infer TabsAndIndentsStyle settings from https://editorconfig.org/ settings

Have you considered any alternatives or workarounds?

Frankly speaking, I have not.

Additional context

https://editorconfig.org/ is a well-known standard for configuring common IDE settings, and many IDEs support .editorconfig files natively.
It would be great if OpenRewrite could reuse the settings from there.

.editorconfig settings are flexible: the settings can be divided into several files, and the indent style can vary across files.

See https://github.com/pgjdbc/pgjdbc/blob/9cf9f36a1d3a1edd9286721f9c0b9cfa9e8422e3/.editorconfig#L31-L43

Are you interested in contributing this feature to OpenRewrite?

I am about to integrate OpenRerwite, so I am not sure I would have time to implement editorconfig support.

[timtebeek]

Hi @vlsi, thanks for the suggestion! We don't yet support .editorconfig, but it's an interesting idea. We do allow customizing code styles, and have various recipes to standardize on a particular style. When no explicit style is provided, we autodetect the style and match that when we change code.

rewrite/rewrite-java/src/main/java/org/openrewrite/java/style/Autodetect.java

Lines 41 to 46 in 2173a71

	public Autodetect(UUID id, Collection<Style> styles) {
	super(id,
	"org.openrewrite.java.Autodetect",
	"Auto-detected",
	"Automatically detect styles from a repository's existing code.",
	emptySet(), styles);

It's likely a larger effort to pick up .editorconfig files, especially given that they can be spread across a code base to affect certain folders, whereas we detect and apply styles per module (roughly speaking: src/main or src/test folders).

That then leaves the question: is there anywhere you've seen code changes introduced in a style that differs from what your .editorconfig indicates? Since I'd expect the auto detection to pick up on a standardized style already. Given the work involved I'd only take this on if we expect substantial improvements, so it's good to have examples of where things go wrong currently.

[timtebeek]

And since you mentioned you're integrating OpenRewrite, I thought you might also be interested to try out https://app.moderne.io . That's a platform we've built to help OSS projects run OpenRewrite recipes, and I've gone ahead and made pgjdbc available there as well. That means you can now run recipes such as this one to move from explicit types to diamond operators against pgjdbc: https://app.moderne.io/results/pH1ciJE1x

With the top right corner button you can start a PR to get this resolved, and then run some of the other 1300 recipes as well. Hope that helps!

[vlsi]

When no explicit style is provided, we autodetect the style and match that when we change code

In practice, Gradle plugin resorts to checkstyle.xml in case the project has checkstyle configured, and there's no way to opt out of that.
That means autoconfiguration is not triggered in my case.

In my experience, Checkstyle produces non-actionable warnings, so I am leaning towards moving the configuration to .editorconfig in case it is possible.

For pgjdbc, I have to add

  - org.openrewrite.java.style.SpacesStyle:
      # See https://github.com/openrewrite/rewrite/blob/1d0aeec11e2d7f239f2f656bfd964b17ca8e4d17/rewrite-java/src/main/java/org/openrewrite/java/style/SpacesStyle.java#L26C14-L26C25
      other:
        afterForSemicolon: true

otherwise OpenRewrite removes spaces after semicolons in for loops.

[knutwannheden]

We indeed need to check if auto-detection is happening when running recipes via build plugins. With the CLI it should work as expected.

[vlsi]

and I've gone ahead and made pgjdbc available there as well

Thank you.
The link responds with "Not found Unable to find the requested resource" error for me. Does that mean the repo is private there?

[timtebeek]

and I've gone ahead and made pgjdbc available there as well

Thank you. The link responds with "Not found Unable to find the requested resource" error for me. Does that mean the repo is private there?

Ah that's unfortunate that you can't access that link! Is it not selectable when you create a custom repository group?

Otherwise I might need to make a public repository group for any project under https://github.com/pgjdbc/ if you'd like to explore the platform. Let me know!