setup spotless for code formatting

This commit is contained in:
adbenitez
2026-03-10 22:57:38 +01:00
parent cd2fc0df0f
commit 64ef656544
4 changed files with 69 additions and 10 deletions
+35
View File
@@ -0,0 +1,35 @@
name: Check code formatting
on:
push:
branches: [main]
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
jobs:
spotless:
name: Check Java formatting (Spotless)
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v5
- uses: actions/setup-java@v5
with:
java-version: 17
distribution: temurin
- uses: actions/cache@v4
with:
path: |
~/.gradle/caches
~/.gradle/wrapper
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
restore-keys: |
${{ runner.os }}-gradle-
- name: Validate Gradle Wrapper
uses: gradle/actions/wrapper-validation@v4
- name: Check formatting
run: ./gradlew spotlessCheck
+7 -10
View File
@@ -73,18 +73,15 @@ esp. before/after screenshots.
### Coding Conventions
Source files are partly derived from different other open source projects
and may follow different coding styles and conventions.
If you do a PR fixing a bug or adding a feature,
please embrace the coding convention you see in the corresponding files,
so that the result fits well together.
Do not refactor or rename things in the same PR
to make the diff small and the PR easy to review.
Project language is Java.
Code formatting is enforced via [Spotless](https://github.com/diffplug/spotless) Gradle plugin.
Auto-format all files by running `./gradlew spotlessApply` before opening a PR.
CI will fail if files are not formatted correctly so make sure to run the formatter before pushing.
If you do a PR fixing a bug or adding a feature, do not refactor or rename things in the same PR
to make the diff small and the PR easy to review.
By using [Delta Chat Core](https://github.com/deltachat/deltachat-core-rust)
there is already a strong separation between "UI" and "Model".
Further separations and abstraction layers are often not helpful
+26
View File
@@ -1,6 +1,7 @@
plugins {
id 'com.android.application' version '8.11.1'
id 'com.google.gms.google-services' version '4.4.1'
id 'com.diffplug.spotless' version '8.3.0'
}
repositories {
@@ -151,6 +152,31 @@ android {
}
spotless {
java {
target 'src/*/java/**/*.java'
targetExclude 'src/main/java/chat/delta/**' // ignore auto-generated code
googleJavaFormat() // Google style = 2-space indent, matches Android Studio defaults
removeUnusedImports()
trimTrailingWhitespace()
endWithNewline()
}
format 'xml', {
target 'src/*/res/**/*.xml', 'src/*/AndroidManifest.xml'
eclipseWtp('xml')
leadingTabsToSpaces(2)
trimTrailingWhitespace()
endWithNewline()
}
groovy {
target '*.gradle'
greclipse()
leadingTabsToSpaces(2)
trimTrailingWhitespace()
endWithNewline()
}
}
dependencies {
def media3_version = "1.8.0" // 1.9.0 need minSdkVersion 23
+1
View File
@@ -1,5 +1,6 @@
pluginManagement {
repositories {
gradlePluginPortal()
google()
mavenCentral()
}