Remove the need to have separate spotless config #66
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @riggaroo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request aims to simplify and centralize the project's code formatting setup by integrating the Spotless configuration directly into the root build.gradle.kts. This change removes the dependency on external initialization scripts for Spotless, making the build system more self-contained and easier to manage for consistent code style across all subprojects.
Highlights
- Centralized Spotless Configuration: The Spotless formatting configuration for Kotlin, Kotlin script (KTS), and XML files has been moved directly into the root
build.gradle.kts. This configuration is now applied consistently across all subprojects, defining rules forktlint(version 1.5.0) with specific editor config overrides and license header files. - Simplified Spotless Execution: The explicit
--init-scriptparameter pointing togradle/init.gradle.ktshas been removed from thespotlessApplyIntelliJ/Gradle run configuration. This change streamlines the local development setup, as the Spotless configuration is now handled directly by the main build script. - Dependency Management Update: The Spotless Gradle plugin (version 7.0.2) has been added to the
gradle/libs.versions.tomlfile, centralizing its version and plugin ID management within the project's version catalog.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request removes the need for a separate spotless config by integrating the spotless plugin directly into the build.gradle.kts file and adding the spotless plugin to the libs.versions.toml file. The spotless configuration is applied to all subprojects. The changes look good overall, with a few suggestions for improved readability and maintainability.
| profileinstaller = "1.4.1" | ||
| retrofit = "2.11.0" | ||
| robolectric = "4.14.1" | ||
| spotless = "7.0.2" |
There was a problem hiding this comment.
| spotless = "7.0.2" | |
| spotless = "7.0.4" |
| kotlinxCoroutines = "1.10.2" | ||
| kotlinxSerialization = "2.1.20" | ||
| kotlinxSerializationJson = "1.8.1" | ||
| ktlint = "1.5.0" |
There was a problem hiding this comment.
Also, this could be refed by a dependency, so that the version will be tracked and updated by automatons like @renovate-bot.
| target("**/*.kts") | ||
| targetExclude("**/build/**/*.kts") | ||
| // Look for the first line that doesn't have a block comment (assumed to be the license) | ||
| licenseHeaderFile(rootProject.file("spotless/copyright.kts"), "(^(?![\\/ ]\\*).*$)") |
There was a problem hiding this comment.
You can reuse the license config for both kt and kts files. ktlint() should also be applied for kts.
| targetExclude("**/build/**/*.kt") | ||
| ktlint(libs.versions.ktlint.get()).editorConfigOverride( | ||
| mapOf( | ||
| "android" to "true", |
There was a problem hiding this comment.
This rule looks invalid for now.
3 participants
No description provided.