Add generic ForbidRegex to gradle and maven.

Author: nedtwigg

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

@@ -490,6 +490,11 @@ public void replaceRegex(String name, String regex, String replacement) {
 		addStep(ReplaceRegexStep.create(name, regex, replacement));
 	}
 
+	/** A regex which generates a lint. */
+	public void forbidRegex(String name, String regex, String lintDetail) {
+		addStep(ReplaceRegexStep.lint(name, regex, lintDetail));
+	}
+
 	/** Removes trailing whitespace. */
 	public void trimTrailingWhitespace() {
 		addStep(TrimTrailingWhitespaceStep.create());

plugin-maven/src/main/java/com/diffplug/spotless/maven/FormatterFactory.java

@@ -38,6 +38,7 @@
 import com.diffplug.spotless.LineEnding;
 import com.diffplug.spotless.maven.generic.EclipseWtp;
 import com.diffplug.spotless.maven.generic.EndWithNewline;
+import com.diffplug.spotless.maven.generic.ForbidRegex;
 import com.diffplug.spotless.maven.generic.Idea;
 import com.diffplug.spotless.maven.generic.Indent;
 import com.diffplug.spotless.maven.generic.Jsr223;
@@ -140,6 +141,10 @@ public final void addReplaceRegex(ReplaceRegex replaceRegex) {
 		addStepFactory(replaceRegex);
 	}
 
+	public final void addForbidRegex(ForbidRegex forbidRegex) {
+		addStepFactory(forbidRegex);
+	}
+
 	public final void addEclipseWtp(EclipseWtp eclipseWtp) {
 		addStepFactory(eclipseWtp);
 	}

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/ForbidRegex.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2016-2025 DiffPlug
+ *
+ * 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
+ *
+ *     http://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 com.diffplug.spotless.maven.generic;
+
+import org.apache.maven.plugins.annotations.Parameter;
+
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.generic.ReplaceRegexStep;
+import com.diffplug.spotless.maven.FormatterStepConfig;
+import com.diffplug.spotless.maven.FormatterStepFactory;
+
+public class ForbidRegex implements FormatterStepFactory {
+
+	@Parameter
+	private String name;
+
+	@Parameter
+	private String searchRegex;
+
+	@Parameter
+	private String lintDetail;
+
+	@Override
+	public FormatterStep newFormatterStep(FormatterStepConfig config) {
+		if (name == null || searchRegex == null) {
+			throw new IllegalArgumentException("Must specify 'name' and 'searchRegex'.");
+		}
+		// Use empty string if replacement is not provided. In pom.xml there is no way to specify
+		// an empty string as a property value as maven will always trim the value and if it is
+		// empty, maven will consider the property as not provided.
+		return ReplaceRegexStep.lint(name, searchRegex, lintDetail);
+	}
+}