Add Gradle tasks and Git hooks for IntelliJ-based code formatting (#15535)

[sanjana2505006]

Added a formatCode Gradle task that uses the IntelliJ CLI formatter to keep our code style consistent. I also added an installGitHooks task that sets up a git pre-commit hook to automatically format staged files. This should help avoid formatting issues during review. Fixes #15535.

[jdaugherty]

@sanjana2505006 we explicitly decided to not auto-install the hook so it would be optional if people wanted it.

[bito-code-review]

To revert the changes in build.gradle, remove the added plugin block and revert the lambda expressions in the ext block back to method references.

build.gradle

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

import java.time.Instant
import java.time.LocalDate
import java.time.ZoneOffset
import java.time.format.DateTimeFormatter
import org.apache.tools.ant.taskdefs.condition.Os
ext {
    isReproducibleBuild = System.getenv("SOURCE_DATE_EPOCH") != null
    buildInstant = java.util.Optional.ofNullable(System.getenv("SOURCE_DATE_EPOCH"))
            .filter(s -> !s.isEmpty())
            .map(Long::parseLong)
            .map(Instant::ofEpochSecond)
            .orElseGet(Instant::now)

[jdaugherty]

Can you help me understand why this change was necessary?

[sanjana2505006]

I originally added this to focus the initial rollout on production source code and avoid overwhelming the PR with style violations from the existing test suite. However, I agree that tests should ideally follow the same standards. Would you prefer that I remove this block and enable styling for tests as well?

[jdaugherty]

While we do need to eventually format our tests, we have agreed to not do so at this time. We should leave styles and only adjust the styles when working on the tests.

[jdaugherty]

I hadn't considered the useful of having a format task added to the subprojects. I still think we should split the format tasks out from the code style though - otherwise you're trying to apply styling to the root project which we don't want to do.

[sanjana2505006]

I completely agree with the split. I've moved all the formatting logic into a separate grails-format plugin.

[jdaugherty]

Take a look at the publishAllToMavenLocal task for how to do in this a modern Gradle way without referencing project .

[sanjana2505006]

To revert the changes in build.gradle, remove the added plugin block and revert the lambda expressions in the ext block back to method references.

build.gradle

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

import java.time.Instant
import java.time.LocalDate
import java.time.ZoneOffset
import java.time.format.DateTimeFormatter
import org.apache.tools.ant.taskdefs.condition.Os
ext {
    isReproducibleBuild = System.getenv("SOURCE_DATE_EPOCH") != null
    buildInstant = java.util.Optional.ofNullable(System.getenv("SOURCE_DATE_EPOCH"))
            .filter(s -> !s.isEmpty())
            .map(Long::parseLong)
            .map(Instant::ofEpochSecond)
            .orElseGet(Instant::now)

I have reverted the buildInstant calculation to use the original method references and removed the extra filter. I am keeping the plugin application at the root level so that the new formatting tasks remain available for use.

[jdaugherty]

@borinquenkid Can you please take a look at this as well? I think this is very close to being mergeable.

[jdaugherty]

This needs to stay. We decided as a project to not yet do styling changes to the tests.

[jdaugherty]

@sanjana2505006 if you can get the rest of these comments implemented, I'll ping another reviewer and we can get this merged.

[sanjana2505006]

@sanjana2505006 if you can get the rest of these comments implemented, I'll ping another reviewer and we can get this merged.

Done, please have a look and let me know if there's anything I need to update.

[jdaugherty]

@sanjana2505006 this should not be removed.

[testlens-app]

✅ All tests passed ✅

🏷️ Commit: 769f735
▶️ Tests: 23459 executed
⚪️ Checks: 31/31 completed

---

Learn more about TestLens at testlens.app.