Formatting Java source code

.github/workflows/cli-unit-tests.yml

@@ -27,4 +27,4 @@ jobs:
       - name: Test with JBang
         run: |
           export PATH="$HOME/.jbang/bin:$PATH"
-          jbang TestJythonCli.java execute --disable-ansi-colors --select-class=TestJythonCli
+          jbang src/test/java/TestJythonCli.java execute --disable-ansi-colors --select-class=TestJythonCli

.gitignore

@@ -2,3 +2,6 @@
 /jython-jbang-catalog.iml
 
 /.vscode/
+/.gradle/
+/build/
+/target/

.sdkmanrc

@@ -2,8 +2,8 @@
 # Add key=value pairs of SDKs to use below
 
 # Java
-java=8.0.452-tem
+java=17.0.16-tem
 
 # JBang
-jbang=0.126.1
+jbang=0.132.1
 

README.md

@@ -252,18 +252,13 @@ Also test the jython-cli script with Java 8:
 * jbang run --java 8 jython-cli examples/turtle.py
 * jbang run --java 8 jython-cli examples/simpletest.py
 
-On Linux or MacOS the JythonCli.java script can be run directly for testing purposes:
-
-* ./JythonCli.java -V
-* ./JythonCli.java examples/banner.py
-
 ## Java Source File Formatting
 
-Use the `google-java-format` to format the `JythonCli.java` and `TestJythonCli.java` programs.
+Use the Gradle task `spotlessApply` to format the `JythonCli.java` and `TestJythonCli.java` programs. Task `spotlessCheck` will only check if the Java source files are correctly formatted.
 
-```
-jbang run com.google.googlejavaformat:google-java-format:1.29.0 --aosp -r *.java
-```
+The configuration file used by the Eclipse Java Formatter, when running the `spotless` tasks, can be imported into your preferred IDE (if supported).
+
+* See file `tools\eclipse-java-formatter\Jython-2017-v2.xml`
 
 ## Articles about Jython and JBang
 

build.gradle

@@ -0,0 +1,46 @@
+import dev.jbang.gradle.tasks.JBangTask
+
+// Apply the standard Java plugin
+plugins {
+    id 'java'
+    // Apply the Spotless plugin (using the same version as in the Kotlin DSL)
+    id 'com.diffplug.spotless' version '7.2.1'
+    id 'dev.jbang' version '0.3.0'
+}
+
+// Standard repository configuration
+repositories {
+    mavenCentral()
+}
+
+// === Spotless Configuration ===
+spotless {
+    // Define the formatting rules for Java files
+    java {
+        eclipse().configFile('tools/eclipse-java-formatter/Jython-2017-v2.xml')
+
+        importOrder()
+        removeUnusedImports()
+        toggleOffOn()
+    }
+}
+
+// Define a custom task to run jython-cli tests
+tasks.register("runTests", JBangTask) {
+    // Specify the script file to run
+    script = "src/test/java/TestJythonCli.java"
+
+    // Optional: Pass arguments to the script
+    jbangArgs = ["--java", "17"]
+    args = ["execute", "--disable-ansi-colors", "--select-class=TestJythonCli"]
+}
+
+// Add a standard task for running the application
+tasks.register('hello') {
+    doLast {
+        println 'Spotless is now configured using Groovy DSL with Google Java Format. To format your code, run:'
+        println './gradlew spotlessApply'
+        println 'To check if files need formatting (useful for CI), run:'
+        println './gradlew spotlessCheck'
+    }
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists