Fix spotlessApply conflict with black

[ChristopheDuong]

What

Trying to make spotlessApply on python files equivalent to black formatting...

How

Spotless for python is adding trailing whitespace in headers which is removed by black producing many diffs if one is run and not the other
(seems airbyte-cdk was checked in with trailing whitespace so I'm removing them)

Recommended reading order

1. build.gradle
2. the rest

[davinchia]

for my own undersanding: what is the purpose of these if conditions? might be misunderstanding but it seems like the end state is this will always write for java and not for python, which is the equivalent to what is being set in the start and end comments for either language.

triimTrailingWhitespace() by itself is not enough to get rid of the spaces?

[ChristopheDuong]

In java, we don't have a second linter/styling tool other than spotless so it doesn't really matter if we write a newline or not for startComment/endComment.

However, in python, we are using black that double-checks and reformats the code.
Thus, writing an extra empty newline (not removed by trimTrailingWhitespace() is actually a big deal and would be reformatted (removed) because in black's specs, there should be exactly one (or two?) empty lines between license header and imports etc

So in python, if you don't use a startComment/endComment syntax, then those lines shouldn't be written at all.
If you do specify some startComment/endComment characters, the lines won't be empty so it should be ok...

[davinchia]

Thanks for the explanation!

Makes sense. Can we drop a comment capturing this:

In java, we don't have a second linter/styling tool other than spotless so it doesn't really matter if we write a newline or not for startComment/endComment.

However, in python, we are using black that double-checks and reformats the code.
Thus, writing an extra empty newline (not removed by trimTrailingWhitespace() is actually a big deal and would be reformatted (removed) because in black's specs, there should be exactly one (or two?) empty lines between license header and imports etc

I'm pretty sure I would not remember this after a month heh

Suggestion - maybe simplify the if conditions to just:

if (!isPython) {
            w.writeLine(startComment)
        }
        license.eachLine {
            w << lineComment
            w.writeLine(it)
        }
        if (!isPython) {
            w.writeLine(endComment)
        }

since the python relevant logic is already centralised in createPythonLicenseWith. I can see argue for checking either parameter, so leave this to your judgement.

[davinchia]

tested this locally using ./gradlew :airbyte-integrations:connectors:destination-redshift:build -x test and this seemed to work!

I have one question for my own understanding before approving.

[davinchia]

This is awesome! Thanks Chris!

[cgardens]

Thanks, @ChristopheDuong !!!