Add code formatter and linter #140

Huulivoide · 2024-06-12T11:12:55Z

Add Spotless with Palantir style for Java formatting

Add Cleanthat to Spotless config

Codebase is already following the wast majority of the enabled rules/mutators. Config uses Composite mutators, that map to the following list of mutators:

ArithmethicAssignment
ArraysDotStream
AvoidMultipleUnaryOperators
AvoidUncheckedExceptionsInSignatures
CastMathOperandsBeforeAssignement
CollectionIndexOfToContains
CollectionToOptional
ComparisonWithNaN
CreateTempFilesUsingNio
EmptyControlStatement
EnumsWithoutEquals
ForEachAddToStreamCollectToCollection
ForEachIfBreakElseToStreamTakeWhile
ForEachIfBreakToStreamFindFirst
ForEachIfToIfStreamAnyMatch
ForEachToIterableForEach
GuavaImmutableMapBuilderOverVarargs
GuavaInlineStringsRepeat
GuavaInlineStringsRepeat
GuavaStringsIsNullOrEmpty
LambdaIsMethodReference
LambdaReturnsSingleStatement
LiteralsFirstInComparisons
LocalVariableTypeInference
LoopIntRangeToIntStreamForEach
ModifierOrder
ObjectEqualsForPrimitives
ObjectsHashCodePrimitive
OptionalNotEmpty
OptionalWrappedIfToFilter
OptionalWrappedVariableToMap
PrimitiveWrapperInstantiation
RedundantLogicalComplementsInStream
RemoveAllToClearCollection
RemoveExplicitCallToSuper
SimplifyBooleanExpression
SimplifyBooleanInitialization
SimplifyStartsWith
StreamAnyMatch
StreamFlatMapStreamToFlatMap
StreamForEachNestingForLoopToFlatMap
StreamMapIdentity
StreamWrappedIfToFilter
StreamWrappedMethodRefToMap
StreamWrappedVariableToMap
StringIndexOfToContains
StringReplaceAllWithQuotableInput
StringToString
ThreadRunToThreadStart
UnnecessaryBoxing
UnnecessaryFullyQualifiedName
UnnecessaryImport
UnnecessaryLambdaEnclosingParameters
UnnecessaryModifier
UnnecessarySemicolon
UseCollectionIsEmpty
UseIndexOfChar
UseStringIsEmpty
UseTextBlocks

This change is

jarkkoka

A good change! Always preferred a consistent code style. The formatting of the comments is mostly ok, but there are also strange formatting in a few places. I left some remarks.

Reviewed 442 of 442 files at r1, all commit messages.
Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @Huulivoide)

src/main/java/fi/hsl/jore/importer/config/jooq/converter/date_range/DateRange.java line 29 at r1 (raw file):

        // See section 8.17.7:
        // > The built-in range types int4range, int8range, and daterange all use a canonical form
        // that includes the

This needs manual intervention. Use of > does not go as originally intended.

src/main/java/fi/hsl/jore/importer/feature/batch/line/support/LineImportRepository.java line 88 at r1 (raw file):

        // TODO: At the moment we don't have any updatable fields in the NETWORK_LINES tables,
        //       but this may change when we decide how to handle e.g. PublicTransportDestination
        // fields

inconsistent indentation

src/main/java/fi/hsl/jore/importer/feature/batch/route_link/RouteLinksReader.java line 108 at r1 (raw file):

                return ImmutableReaderState.copyOf(this)
                        // We _must_ update the attributes, because while some of the fields (joined
                        // from the

The lines could be joined in a better way. Only two short words on one line.

src/main/java/fi/hsl/jore/importer/feature/batch/route_link/RoutePointConstructor.java line 33 at r1 (raw file):

                entity.routeLinks()
                        // The order number property is NOT guaranteed to be strictly incremental by
                        // 1,

Here again. This could be more readable. Needs manual intervention.

src/main/java/fi/hsl/jore/importer/feature/mapmatching/dto/request/MapMatchingRequestBuilder.java line 91 at r1 (raw file):

                                                                                    + " the route"
                                                                                    + " point is"
                                                                                    + " stop point"

Whoops! Not the most readable form. :D

src/main/java/fi/hsl/jore/importer/feature/network/route_point/repository/RoutePointExportRepository.java line 76 at r1 (raw file):

                                                                .and(
                                                                        length(
                                                                                        SCHEDULED_STOP_POINTS

Feels a bit too sparse, but probably nothing can be done with this style configuration...

src/test/java/fi/hsl/jore/importer/feature/batch/link/support/TransitTypeToNetworkTypeMapperTest.java line 24 at r1 (raw file):

    public void testEachNetworkTypeSupported() {
        // Note that at the moment there is a comprehensive 1:1 mapping from
        // TransitType->NetworkType,

These lines could be joined in a better way.

jarkkoka

"Palantir" style

Reviewed 286 of 286 files at r2, all commit messages.
Reviewable status: all files reviewed, 9 unresolved discussions (waiting on @Huulivoide)

pom.xml line 712 at r2 (raw file):

                        </cleanthat>

                        <!-- Format the code according to Plantir code style. -->

typo => "Palantir"

.github/workflows/spotless.yml line 24 at r2 (raw file):

      - name: Cache Maven packages
        uses: actions/cache@v3

=> actions/cache@v4. v4 is the most recent version.

Huulivoide

Reviewable status: 445 of 449 files reviewed, 8 unresolved discussions (waiting on @jarkkoka)

.github/workflows/spotless.yml line 24 at r2 (raw file):