Use Provider API for Gradle properties

Author: simonlebras

CHANGES.md

@@ -13,7 +13,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ### Changes
 * Bump default `ktfmt` version to latest `0.58` -> `0.59`. ([#2681](https://github.com/diffplug/spotless/pull/2681)
 ### Fixed
-- palantirJavaFormat is no longer arbitrarily set to outdated versions on Java 17, latest available version is always used ([#2686](https://github.com/diffplug/spotless/pull/2686) fixes [#2685](https://github.com/diffplug/spotless/issues/2685))
+* palantirJavaFormat is no longer arbitrarily set to outdated versions on Java 17, latest available version is always used ([#2686](https://github.com/diffplug/spotless/pull/2686) fixes [#2685](https://github.com/diffplug/spotless/issues/2685))
+* Use Provider API for Gradle properties.
 ### Removed
 * **BREAKING** Drop support for older Ktlint versions. ([#2711](https://github.com/diffplug/spotless/pull/2711))
 

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/FormatExtension.java

@@ -80,7 +80,9 @@
 
 import groovy.lang.Closure;
 
-/** Adds a {@code spotless{Name}Check} and {@code spotless{Name}Apply} task. */
+/**
+ * Adds a {@code spotless{Name}Check} and {@code spotless{Name}Apply} task.
+ */
 public class FormatExtension {
 
 	private static final Logger LOGGER = LoggerFactory.getLogger(FormatExtension.class);
@@ -150,7 +152,9 @@ public void setEncoding(String name) {
 
 	private String ratchetFrom = RATCHETFROM_NOT_SET_AT_FORMAT_LEVEL;
 
-	/** @see #setRatchetFrom(String) */
+	/**
+	 * @see #setRatchetFrom(String)
+	 */
 	public String getRatchetFrom() {
 		return ratchetFrom == RATCHETFROM_NOT_SET_AT_FORMAT_LEVEL ? spotless.getRatchetFrom() : ratchetFrom;
 	}
@@ -163,7 +167,9 @@ public void setRatchetFrom(String ratchetFrom) {
 		this.ratchetFrom = ratchetFrom;
 	}
 
-	/** @see #setRatchetFrom(String) */
+	/**
+	 * @see #setRatchetFrom(String)
+	 */
 	public void ratchetFrom(String ratchetFrom) {
 		setRatchetFrom(ratchetFrom);
 	}
@@ -178,7 +184,9 @@ public void setEncoding(Charset charset) {
 
 	final List<LintSuppression> lintSuppressions = new ArrayList<>();
 
-	/** Suppresses any lints which meet the supplied criteria. */
+	/**
+	 * Suppresses any lints which meet the supplied criteria.
+	 */
 	public void suppressLintsFor(Action<LintSuppression> lintSuppression) {
 		LintSuppression suppression = new LintSuppression();
 		lintSuppression.execute(suppression);
@@ -216,11 +224,15 @@ public void encoding(String charset) {
 		setEncoding(charset);
 	}
 
-	/** The files to be formatted = (target - targetExclude). */
+	/**
+	 * The files to be formatted = (target - targetExclude).
+	 */
 	protected FileCollection target;
 	protected FileCollection targetExclude;
 
-	/** The value from which files will be excluded if their content contain it. */
+	/**
+	 * The value from which files will be excluded if their content contain it.
+	 */
 	@Nullable protected String targetExcludeContentPattern;
 
 	protected boolean isLicenseHeaderStep(FormatterStep formatterStep) {
@@ -351,10 +363,14 @@ private static void relativizeIfSubdir(List<String> relativePaths, File root, Fi
 		}
 	}
 
-	/** The steps that need to be added. */
+	/**
+	 * The steps that need to be added.
+	 */
 	protected final List<FormatterStep> steps = new ArrayList<>();
 
-	/** Adds a new step. */
+	/**
+	 * Adds a new step.
+	 */
 	public void addStep(FormatterStep newStep) {
 		requireNonNull(newStep);
 		int existingIdx = getExistingStepIdx(newStep.getName());
@@ -365,7 +381,9 @@ public void addStep(FormatterStep newStep) {
 		steps.add(newStep);
 	}
 
-	/** Adds a new step that requires a Provisioner. */
+	/**
+	 * Adds a new step that requires a Provisioner.
+	 */
 	public void addStep(Function<Provisioner, FormatterStep> createStepFn) {
 		requireNonNull(createStepFn);
 		FormatterStep newStep = createStepFn.apply(provisioner());
@@ -385,7 +403,9 @@ protected int getExistingStepIdx(String stepName) {
 		return -1;
 	}
 
-	/** Replaces the given step. */
+	/**
+	 * Replaces the given step.
+	 */
 	protected void replaceStep(FormatterStep replacementStep) {
 		int existingIdx = getExistingStepIdx(replacementStep.getName());
 		if (existingIdx == -1) {
@@ -395,7 +415,9 @@ protected void replaceStep(FormatterStep replacementStep) {
 		steps.set(existingIdx, replacementStep);
 	}
 
-	/** Clears all of the existing steps. */
+	/**
+	 * Clears all of the existing steps.
+	 */
 	public void clearSteps() {
 		steps.clear();
 	}
@@ -478,32 +500,44 @@ public void custom(String name, FormatterFunc formatter) {
 		addStep(FormatterStep.createLazy(name, () -> globalState, SerializedFunction.alwaysReturns(formatter)));
 	}
 
-	/** Highly efficient find-replace char sequence. */
+	/**
+	 * Highly efficient find-replace char sequence.
+	 */
 	public void replace(String name, CharSequence original, CharSequence after) {
 		addStep(ReplaceStep.create(name, original, after));
 	}
 
-	/** Highly efficient find-replace regex. */
+	/**
+	 * Highly efficient find-replace regex.
+	 */
 	public void replaceRegex(String name, String regex, String replacement) {
 		addStep(ReplaceRegexStep.create(name, regex, replacement));
 	}
 
-	/** A regex which generates a lint. */
+	/**
+	 * A regex which generates a lint.
+	 */
 	public void forbidRegex(String name, String regex, String lintDetail) {
 		addStep(ReplaceRegexStep.lint(name, regex, lintDetail));
 	}
 
-	/** Removes trailing whitespace. */
+	/**
+	 * Removes trailing whitespace.
+	 */
 	public void trimTrailingWhitespace() {
 		addStep(TrimTrailingWhitespaceStep.create());
 	}
 
-	/** Ensures that files end with a single newline. */
+	/**
+	 * Ensures that files end with a single newline.
+	 */
 	public void endWithNewline() {
 		addStep(EndWithNewlineStep.create());
 	}
 
-	/** Ensures that the files are indented using spaces. */
+	/**
+	 * Ensures that the files are indented using spaces.
+	 */
 	public void leadingTabsToSpaces(int spacesPerTab) {
 		addStep(IndentStep.Type.SPACE.create(spacesPerTab));
 	}
@@ -514,7 +548,9 @@ public void indentWithSpaces(int numSpacesPerTab) {
 		leadingTabsToSpaces(numSpacesPerTab);
 	}
 
-	/** Ensures that the files are indented using spaces. */
+	/**
+	 * Ensures that the files are indented using spaces.
+	 */
 	public void leadingTabsToSpaces() {
 		addStep(IndentStep.Type.SPACE.create());
 	}
@@ -525,7 +561,9 @@ public void indentWithSpaces() {
 		leadingTabsToSpaces();
 	}
 
-	/** Ensures that the files are indented using tabs. */
+	/**
+	 * Ensures that the files are indented using tabs.
+	 */
 	public void leadingSpacesToTabs(int spacesPerTab) {
 		addStep(IndentStep.Type.TAB.create(spacesPerTab));
 	}
@@ -536,7 +574,9 @@ public void indentWithTabs(int tabToSpaces) {
 		leadingSpacesToTabs(tabToSpaces);
 	}
 
-	/** Ensures that the files are indented using tabs. */
+	/**
+	 * Ensures that the files are indented using tabs.
+	 */
 	public void leadingSpacesToTabs() {
 		addStep(IndentStep.Type.TAB.create());
 	}
@@ -551,7 +591,9 @@ private static void logDeprecation(String methodName, String replacement) {
 		LOGGER.warn("'{}' is deprecated, use '{}' in your gradle build script instead.", methodName, replacement);
 	}
 
-	/** Ensures formatting of files via native binary. */
+	/**
+	 * Ensures formatting of files via native binary.
+	 */
 	public void nativeCmd(String name, String pathToExe, List<String> arguments) {
 		addStep(NativeCmdStep.create(name, new File(pathToExe), arguments));
 	}
@@ -630,8 +672,11 @@ public LicenseHeaderConfig updateYearWithLatest(boolean updateYearWithLatest) {
 
 		FormatterStep createStep() {
 			return builder.withYearModeLazy(() -> {
-				if ("true".equals(spotless.project
-						.findProperty(LicenseHeaderStep.FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY()))) {
+				if (spotless.project
+						.getProviders()
+						.gradleProperty(LicenseHeaderStep.FLAG_SET_LICENSE_HEADER_YEARS_FROM_GIT_HISTORY())
+						.map(Boolean::parseBoolean)
+						.getOrElse(false)) {
 					return YearMode.SET_FROM_GIT;
 				} else {
 					boolean updateYear = updateYearWithLatest == null ? getRatchetFrom() != null : updateYearWithLatest;
@@ -846,17 +891,23 @@ protected BiomeGeneric getThis() {
 		}
 	}
 
-	/** Uses the default version of prettier. */
+	/**
+	 * Uses the default version of prettier.
+	 */
 	public PrettierConfig prettier() {
 		return prettier(PrettierFormatterStep.defaultDevDependencies());
 	}
 
-	/** Uses the specified version of prettier. */
+	/**
+	 * Uses the specified version of prettier.
+	 */
 	public PrettierConfig prettier(String version) {
 		return prettier(PrettierFormatterStep.defaultDevDependenciesWithPrettier(version));
 	}
 
-	/** Uses exactly the npm packages specified in the map. */
+	/**
+	 * Uses exactly the npm packages specified in the map.
+	 */
 	public PrettierConfig prettier(Map<String, String> devDependencies) {
 		PrettierConfig prettierConfig = new PrettierConfig(devDependencies);
 		addStep(prettierConfig.createStep());
@@ -872,19 +923,25 @@ public BiomeStepConfig<?> biome() {
 		return biome(null);
 	}
 
-	/** Downloads the given Biome version from the network. */
+	/**
+	 * Downloads the given Biome version from the network.
+	 */
 	public BiomeStepConfig<?> biome(String version) {
 		var biomeConfig = new BiomeGeneric(version);
 		addStep(biomeConfig.createStep());
 		return biomeConfig;
 	}
 
-	/** Uses the default version of clang-format. */
+	/**
+	 * Uses the default version of clang-format.
+	 */
 	public ClangFormatConfig clangFormat() {
 		return clangFormat(ClangFormatStep.defaultVersion());
 	}
 
-	/** Uses the specified version of clang-format. */
+	/**
+	 * Uses the specified version of clang-format.
+	 */
 	public ClangFormatConfig clangFormat(String version) {
 		return new ClangFormatConfig(version);
 	}
@@ -897,7 +954,9 @@ public class ClangFormatConfig {
 			addStep(createStep());
 		}
 
-		/** Any of: LLVM, Google, Chromium, Mozilla, WebKit. */
+		/**
+		 * Any of: LLVM, Google, Chromium, Mozilla, WebKit.
+		 */
 		public ClangFormatConfig style(String style) {
 			stepCfg = stepCfg.withStyle(style);
 			replaceStep(createStep());
@@ -1051,12 +1110,16 @@ public void toggleOffOnRegex(String regex) {
 		this.toggleFence = FenceStep.named(FenceStep.defaultToggleName()).regex(regex);
 	}
 
-	/** Disables formatting between the given tags. */
+	/**
+	 * Disables formatting between the given tags.
+	 */
 	public void toggleOffOn(String off, String on) {
 		this.toggleFence = FenceStep.named(FenceStep.defaultToggleName()).openClose(off, on);
 	}
 
-	/** Disables formatting between {@code spotless:off} and {@code spotless:on}. */
+	/**
+	 * Disables formatting between {@code spotless:off} and {@code spotless:on}.
+	 */
 	public void toggleOffOn() {
 		toggleOffOn(FenceStep.defaultToggleOff(), FenceStep.defaultToggleOn());
 	}
@@ -1071,7 +1134,9 @@ public void toggleOffOnDisable() {
 
 	private @Nullable FenceStep toggleFence;
 
-	/** Sets up a format task according to the values in this extension. */
+	/**
+	 * Sets up a format task according to the values in this extension.
+	 */
 	protected void setupTask(SpotlessTask task) {
 		task.setEncoding(getEncoding().name());
 		task.setLintSuppressions(lintSuppressions);
@@ -1098,12 +1163,16 @@ protected void setupTask(SpotlessTask task) {
 		task.setupRatchet(getRatchetFrom() != null ? getRatchetFrom() : "");
 	}
 
-	/** Returns the project that this extension is attached to. */
+	/**
+	 * Returns the project that this extension is attached to.
+	 */
 	protected Project getProject() {
 		return spotless.project;
 	}
 
-	/** Eager version of {@link #createIndependentApplyTaskLazy(String)} */
+	/**
+	 * Eager version of {@link #createIndependentApplyTaskLazy(String)}
+	 */
 	public SpotlessApply createIndependentApplyTask(String taskName) {
 		return createIndependentApplyTaskLazy(taskName).get();
 	}