From 4b98cfb1a444f10a0881854f2c20e87da254dc52 Mon Sep 17 00:00:00 2001 From: Brian Clozel Date: Tue, 3 Jun 2025 09:03:25 +0200 Subject: [PATCH] Use "io.spring.nullability" Gradle plugin Closes gh-1232 --- build.gradle | 6 +- buildSrc/build.gradle | 4 - .../build/nullability/NullabilityPlugin.java | 78 ------------------- 3 files changed, 5 insertions(+), 83 deletions(-) delete mode 100644 buildSrc/src/main/java/org/springframework/graphql/build/nullability/NullabilityPlugin.java diff --git a/build.gradle b/build.gradle index c4d709c0..59aacf9a 100644 --- a/build.gradle +++ b/build.gradle @@ -1,3 +1,7 @@ +plugins { + id "io.spring.nullability" version "0.0.1" apply false +} + description = "Spring for GraphQL" ext { @@ -10,7 +14,7 @@ ext { subprojects { apply plugin: 'org.springframework.graphql.conventions' apply plugin: 'org.springframework.graphql.architecture' - apply plugin: 'org.springframework.graphql.nullability' + apply plugin: "io.spring.nullability" group = 'org.springframework.graphql' ext.javadocLinks = [ diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle index f49d05a5..73b5d4de 100644 --- a/buildSrc/build.gradle +++ b/buildSrc/build.gradle @@ -41,10 +41,6 @@ gradlePlugin { id = "org.springframework.graphql.architecture" implementationClass = "org.springframework.graphql.build.architecture.ArchitecturePlugin" } - nullability { - id = "org.springframework.graphql.nullability" - implementationClass = "org.springframework.graphql.build.nullability.NullabilityPlugin" - } } } diff --git a/buildSrc/src/main/java/org/springframework/graphql/build/nullability/NullabilityPlugin.java b/buildSrc/src/main/java/org/springframework/graphql/build/nullability/NullabilityPlugin.java deleted file mode 100644 index d790fede..00000000 --- a/buildSrc/src/main/java/org/springframework/graphql/build/nullability/NullabilityPlugin.java +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright 2020-2025 the original author or authors. - * - * Licensed 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. - */ - -package org.springframework.graphql.build.nullability; - -import java.util.function.Consumer; -import java.util.regex.Pattern; - -import net.ltgt.gradle.errorprone.ErrorProneOptions; -import net.ltgt.gradle.errorprone.ErrorPronePlugin; -import org.gradle.api.Plugin; -import org.gradle.api.Project; -import org.gradle.api.artifacts.DependencySet; -import org.gradle.api.plugins.ExtensionAware; -import org.gradle.api.plugins.JavaPlugin; -import org.gradle.api.tasks.compile.CompileOptions; -import org.gradle.api.tasks.compile.JavaCompile; - -/** - * {@link Plugin} for enforcing Nullability checks on the source code. - * - * @author Brian Clozel - */ -public class NullabilityPlugin implements Plugin { - - private static final Pattern COMPILE_MAIN_SOURCES_TASK_NAME = Pattern.compile("compile(\\d+)?Java"); - - @Override - public void apply(Project project) { - project.getPlugins().apply(ErrorPronePlugin.class); - DependencySet errorproneConfig = project.getConfigurations().getByName("errorprone").getDependencies(); - errorproneConfig.add(project.getDependencies().create("com.uber.nullaway:nullaway:0.12.6")); - errorproneConfig.add(project.getDependencies().create("com.google.errorprone:error_prone_core:2.37.0")); - - project.getTasks() - .withType(JavaCompile.class) - .configureEach((javaCompile) -> { - if (compilesMainSources(javaCompile)) { - doWithErrorProneOptions(javaCompile, (errorProneOptions) -> { - errorProneOptions.getDisableAllChecks().set(true); - errorProneOptions.option("NullAway:OnlyNullMarked", "true"); - errorProneOptions.option("NullAway:CustomContractAnnotations", "org.springframework.lang.Contract"); - errorProneOptions.option("NullAway:JSpecifyMode", "true"); - errorProneOptions.error("NullAway"); - }); - } - else { - doWithErrorProneOptions(javaCompile, (errorProneOptions) -> { - errorProneOptions.getEnabled().set(false); - }); - } - }); - } - - private boolean compilesMainSources(JavaCompile compileTask) { - return COMPILE_MAIN_SOURCES_TASK_NAME.matcher(compileTask.getName()).matches(); - } - - private void doWithErrorProneOptions(JavaCompile compileTask, Consumer optionsConsumer) { - CompileOptions options = compileTask.getOptions(); - ErrorProneOptions errorProneOptions = ((ExtensionAware) options).getExtensions().getByType(ErrorProneOptions.class); - optionsConsumer.accept(errorProneOptions); - } - -}