Skip to content

Apache Lucene open-source search software

build: move missing-spi-block-tag out of source-patterns.gradle (#14918)

Robert Muir71477002f082
diff --git a/build-tools/build-infra/src/main/groovy/lucene.validation.source-patterns.gradle b/build-tools/build-infra/src/main/groovy/lucene.validation.source-patterns.gradle
index a0781e1f6a1..9710f5a4d42 100644
--- a/build-tools/build-infra/src/main/groovy/lucene.validation.source-patterns.gradle
+++ b/build-tools/build-infra/src/main/groovy/lucene.validation.source-patterns.gradle
@@ -146,7 +146,6 @@ class ValidateSourcePatternsTask extends DefaultTask {
def xmlCommentPattern = ~$/(?sm)\Q<!--\E(.*?)\Q-->\E/$;
def lineSplitter = ~$/[\r\n]+/$;
def xmlTagPattern = ~$/(?m)\s*<[a-zA-Z].*/$;
- def validSPINameJavadocTag = ~$/(?s)\s*\*\s*@lucene\.spi\s+\{@value #NAME\}/$;
def isLicense = { matcher, ratDocument ->
// See LUCENE-10419 - rat is not thread safe.
@@ -202,18 +201,6 @@ class ValidateSourcePatternsTask extends DefaultTask {
reportViolation(f, String.format(Locale.ROOT, '%s [start=%d, end=%d]', name, matcher.start(), matcher.end()));
}
}
- if (f.name.endsWith('.java')) {
- // make sure that SPI names of all tokenizers/charfilters/tokenfilters are documented
- if (!f.name.contains("Test") && !f.name.contains("Mock") && !f.name.contains("Fake") && !text.contains("abstract class") &&
- !f.name.equals("TokenizerFactory.java") && !f.name.equals("CharFilterFactory.java") && !f.name.equals("TokenFilterFactory.java") &&
- (f.name.contains("TokenizerFactory") && text.contains("extends TokenizerFactory") ||
- f.name.contains("CharFilterFactory") && text.contains("extends CharFilterFactory") ||
- f.name.contains("FilterFactory") && text.contains("extends TokenFilterFactory"))) {
- if (!validSPINameJavadocTag.matcher(text).find()) {
- reportViolation(f, 'invalid spi name documentation')
- }
- }
- }
if (f.name.endsWith('.xml')) {
def ratDocument = new FileDocument(f);
checkLicenseHeaderPrecedes(f, '<tag>', xmlTagPattern, xmlCommentPattern, text, ratDocument);
diff --git a/gradle/validation/ast-grep/rules/java-patterns.yml b/gradle/validation/ast-grep/rules/java-patterns.yml
index 469adea8e5f..503416aad5e 100644
--- a/gradle/validation/ast-grep/rules/java-patterns.yml
+++ b/gradle/validation/ast-grep/rules/java-patterns.yml
@@ -91,3 +91,35 @@ transform:
fix: $NEWTEXT
severity: error
message: please write as `TODO:` instead
+---
+# yaml-language-server: $schema=https://raw.githubusercontent.com/ast-grep/ast-grep/refs/heads/main/schemas/java_rule.json
+id: missing-spi-block-tag
+language: java
+ignores:
+ - "**/src/test/**"
+rule:
+ pattern:
+ selector: superclass
+ context: class $CLASS extends $SUPERCLASS
+ inside:
+ kind: class_declaration
+ # public, and not abstract
+ has:
+ kind: modifiers
+ has:
+ regex: public
+ not:
+ has:
+ regex: abstract
+ # not documented
+ not:
+ follows:
+ matches: javadoc
+ regex: "@lucene.spi [{]@value #NAME[}]"
+constraints:
+ SUPERCLASS:
+ regex: ^(Tokenizer|TokenFilter|CharFilter)Factory$
+severity: error
+message: Public factory is missing @lucene.spi javadoc block tag.
+note: |
+ Document with `@lucene.spi {@value #NAME}`
diff --git a/gradle/validation/ast-grep/tests/java-patterns.yml b/gradle/validation/ast-grep/tests/java-patterns.yml
index bc6d8ed7deb..64994248295 100644
--- a/gradle/validation/ast-grep/tests/java-patterns.yml
+++ b/gradle/validation/ast-grep/tests/java-patterns.yml
@@ -72,3 +72,33 @@ invalid:
valid:
- |
var foo = "TOOD: whatever";
+---
+id: missing-spi-block-tag
+invalid:
+ - |
+ public class X extends TokenizerFactory {}
+ - |
+ public class X extends TokenFilterFactory implements A,B,C {}
+ - |
+ public final class X extends CharFilterFactory {}
+ - |
+ @Foo
+ public class X extends CharFilterFactory {}
+ - |
+ /** boo */
+ public class X extends TokenizerFactory {}
+ - |
+ /* not javadoc
+ * @lucene.spi {@value #NAME}
+ */
+ public class X extends TokenizerFactory {}
+valid:
+ - |
+ /** this is javadoc
+ * @lucene.spi {@value #NAME}
+ */
+ public class X extends TokenizerFactory {}
+ - |
+ public abstract class X extends TokenizerFactory {}
+ - |
+ private class X extends TokenizerFactory {}