Initial commit

Author: raharrison

.github/workflows/build.yml

@@ -0,0 +1,24 @@
+name: Java CI with Gradle
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+      - name: Build with Gradle Wrapper
+        run: chmod +x gradlew && ./gradlew --no-daemon --stacktrace build

.gitignore

@@ -0,0 +1,39 @@
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

README.md

@@ -0,0 +1,24 @@
+# Java JSpecify Example
+
+Aa minimal Java project demonstrating the usage of `JSpecify` annotations, `NullAway`, and `Error Prone` static analysis tools.
+This project aims to showcase how to integrate and configure these tools in a Java project using `Gradle`.
+
+---
+
+### Usage
+
+```bash
+git clone https://github.com/raharrison/java-jspecify-example.git
+cd java-jspecify-example
+./gradlew build
+```
+
+### Notes
+
+- The `UserRepo` class is annotated using `JSpecify`
+- By default, the build is set up to fail if any `NullAway` error is reported
+- Uncomment the line in `Main` to use a nullable object without a check beforehand. This will fail the build
+- `NullAway` will not run on test code
+- `NullAway` is configured to check all files in the specified project package. You can alternatively check only `NullMarked` code
+  by annotating each class
+  or through an annotated `package-info.java` file

build.gradle.kts

@@ -0,0 +1,54 @@
+import net.ltgt.gradle.errorprone.errorprone
+
+plugins {
+    application
+    id("java")
+    id("com.gradleup.shadow") version "8.3.6"
+    id("net.ltgt.errorprone") version "4.3.0"
+}
+
+group = "com.example.myapp"
+version = "1.0-SNAPSHOT"
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    testImplementation(platform("org.junit:junit-bom:5.11.4"))
+    testImplementation("org.junit.jupiter:junit-jupiter")
+
+    implementation("org.jspecify:jspecify:1.0.0")
+    errorprone("com.google.errorprone:error_prone_core:2.40.0")
+    errorprone("com.uber.nullaway:nullaway:0.12.7")
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(21)
+    }
+}
+
+application {
+    mainClass.set("com.example.myapp.Main")
+}
+
+tasks.withType<JavaCompile> {
+    options.errorprone {
+        disableAllChecks = true
+        option("NullAway:JSpecifyMode", "true")
+//        option("NullAway:OnlyNullMarked", "true")
+        option("NullAway:AnnotatedPackages", "com.example.myapp")
+        error("NullAway")
+    }
+    // Disable NullAway on test code
+    if (name.lowercase().contains("test")) {
+        options.errorprone {
+            disable("NullAway")
+        }
+    }
+}

gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists