indentWithTabs removes leading single space

Having standard Javadoc comments, like:

/**
 * <h3>Logging Configuration</h3>
 *
...

After running…

spotless {
	java {
		googleJavaFormat('1.3') // indents with 2 spaces
		indentWithTabs(2)
	}
}

All Javadoc stars are in the fly-on-the-left-wall position:

/**
* <h3>Logging Configuration</h3>
*
...

See https://github.com/junit-team/junit5/compare/google_java_format#diff-65f0a88c2a9307f19525f2d3c03dc8f3 for a complete example.

[nedtwigg]

conflating this issue with googleJavaFormat … the problem is much more general.

Most of the other formatters (or at least eclipse and greclipse) allow you to configure indentation to use tabs in the first place, so I did see this as a GJF-specific usecase.

But you raise a good point, C-style multiline comments are not unusual, we should “just work” for that case. I’m going to open another issue for that.

[nedtwigg]

Proposal 1 (bad idea, probably wouldn’t merge a PR)

We have a mechanism for implicitly modifying license steps based on context, e.g. this is how we keep the license step from messing up package-info.java

https://github.com/diffplug/spotless/blob/3a845e9c1d8992b12636d680c4aa2e3949d71436/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java#L219-L225

You could add something like:

if (steps.contains(::isGoogleJavaFormatStep) && steps.contains(::isIdentWithTabsStep)) {
  steps.add(replaceRegex 'class-level javadoc indentation fix', /^\*/, ' *')
  steps.add(replaceRegex 'method-level javadoc indentation fix', /\t\*/, '\t *')
}

I think that’s okay, but not great because it’s hard for users to opt out of.

Proposal 2 (okay idea, would happily merge a PR)

A better solution would be to support something like this: googleJavaFormat().indentWithTabs(), which I would add roughly here

https://github.com/diffplug/spotless/blob/3a845e9c1d8992b12636d680c4aa2e3949d71436/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java#L154-L156

and it would look something like this

public void indentWithTabs() {
  // needs to be terminal (returns void) because unlike the other methods in GoogleJavaFormatConfig, this is hard to undo. */
  indentWithTabs(2)
  replaceRegex 'class-level javadoc indentation fix', /^\*/, ' *'
  replaceRegex 'method-level javadoc indentation fix', /\t\*/, '\t *'
}