Apache Lucene open-source search software
source patterns: @author/nocommit/TOOD/tabs (#14853)
Robert Muirb098213a4bb4
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.gradleindex 1f0ec9db579..a0781e1f6a1 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@@ -124,10 +124,6 @@ class ValidateSourcePatternsTask extends DefaultTask {@TaskActionpublic void check() {def invalidPatterns = [- (~$/@author\b/$) : '@author javadoc tag',- (~$/(?i)\bno(n|)commit\b/$) : 'nocommit',- (~$/\bTOOD:/$) : 'TOOD instead TODO',- (~$/\t/$) : 'tabs instead spaces',(~$/[\u202A-\u202E\u2066-\u2069]/$) : 'misuse of RTL/LTR (https://trojansource.codes)',(~$/\Q/**\E((?:\s)|(?:\*))*\Q{@inheritDoc}\E((?:\s)|(?:\*))*\Q*/\E/$) : '{@inheritDoc} on its own is unnecessary',(~$/\$$(?:LastChanged)?Date\b/$) : 'svn keyword',diff --git a/gradle/validation/ast-grep/rules/java-patterns.yml b/gradle/validation/ast-grep/rules/java-patterns.ymlindex a924b106e03..72c2b68358f 100644--- a/gradle/validation/ast-grep/rules/java-patterns.yml+++ b/gradle/validation/ast-grep/rules/java-patterns.yml@@ -26,8 +26,9 @@ note: add explicit typing on the RHS when using `var`id: javadoc-style-license-headerlanguage: javarule:- matches: java-license- regex: "^/[*][*]"+ all:+ - matches: java-license+ - matches: javadocpattern: $TEXT# remove extraneous starstransform:@@ -51,3 +52,42 @@ rule:stopBy: endseverity: errormessage: license should be before `package` declaration+---+# yaml-language-server: $schema=https://raw.githubusercontent.com/ast-grep/ast-grep/refs/heads/main/schemas/java_rule.json+id: javadoc-author-tag+language: java+rule:+ matches: javadoc+ regex: "@author"+severity: error+message: javadoc `@author` tags should not be used+---+# yaml-language-server: $schema=https://raw.githubusercontent.com/ast-grep/ast-grep/refs/heads/main/schemas/java_rule.json+id: nocommit-comment+language: java+rule:+ regex: "nocommit:"+ any:+ - kind: line_comment+ - kind: block_comment+severity: error+message: all `nocommit:` comments must be resolved+---+# yaml-language-server: $schema=https://raw.githubusercontent.com/ast-grep/ast-grep/refs/heads/main/schemas/java_rule.json+id: tood-comment+language: java+rule:+ regex: "TOOD:"+ any:+ - kind: line_comment+ - kind: block_comment+ pattern: $TEXT+transform:+ NEWTEXT:+ replace:+ replace: "TOOD:"+ by: "TODO:"+ source: $TEXT+fix: $NEWTEXT+severity: error+message: please write as `TODO:` insteaddiff --git a/gradle/validation/ast-grep/tests/java-patterns.yml b/gradle/validation/ast-grep/tests/java-patterns.ymlindex cfa975180d1..00315e1a479 100644--- a/gradle/validation/ast-grep/tests/java-patterns.yml+++ b/gradle/validation/ast-grep/tests/java-patterns.yml@@ -41,3 +41,32 @@ valid:- |/* BLAH BLAH Unless required by applicable law BLAH BLAH */package foo;+---+id: javadoc-author-tag+invalid:+ - |+ /** @author foo */+valid:+ - |+ // notjavadoc @author+ - |+ /* notjavadoc @author */+---+id: nocommit-comment+invalid:+ - |+ // nocommit: fix this+ - |+ /* nocommit: fix this */+valid:+ - boolean nocommit = false;+---+id: tood-comment+invalid:+ - |+ // TOOD: fix this+ - |+ /* TOOD: fix this */+valid:+ - |+ var foo = "TOOD: whatever";diff --git a/gradle/validation/ast-grep/utils/javadoc.yml b/gradle/validation/ast-grep/utils/javadoc.ymlnew file mode 100644index 00000000000..23b8d33458c--- /dev/null+++ b/gradle/validation/ast-grep/utils/javadoc.yml@@ -0,0 +1,8 @@+---+# yaml-language-server: $schema=https://raw.githubusercontent.com/ast-grep/ast-grep/refs/heads/main/schemas/java_rule.json+id: javadoc+language: java+rule:+ # detect javadoc+ kind: block_comment+ regex: "^/[*][*]"