NihalJain commented on code in PR #2023:
URL: https://github.com/apache/phoenix/pull/2023#discussion_r1831469646
##########
pom.xml:
##########
@@ -700,6 +701,119 @@
<extensions>true</extensions>
<inherited>true</inherited>
</plugin>
+ <plugin>
+ <groupId>com.diffplug.spotless</groupId>
+ <artifactId>spotless-maven-plugin</artifactId>
+ <version>${spotless.version}</version>
+ <configuration>
+ <!-- define a language-specific format -->
+ <java>
+ <excludes>
+ <exclude>**/generated/*</exclude>
+ <exclude>**/package-info.java</exclude>
+ </excludes>
+ <!--
+ e.g., remove the following lines:
+ "* @param paramName"
+ "* @throws ExceptionType"
+ "* @return returnType"'
+ Multiline to allow anchors on newlines
+ See https://errorprone.info/bugpattern/EmptyBlockTag
+ -->
+ <replaceRegex>
+ <name>Remove unhelpful javadoc stubs</name>
+ <searchRegex>(?m)^ *\* *@(?:param|throws|return) *\w*
*\n</searchRegex>
+ <replacement/>
+ </replaceRegex>
+ <!--
+ e.g., rewrite
+ /** @return blabla */
+ or
+ /**
+ * @return blabla
+ */
+ to
+ /** Returns blabla */
+ See https://errorprone.info/bugpattern/MissingSummary
+
https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment
+ -->
+ <replaceRegex>
+ <name>Purge single returns tag multi line</name>
+ <searchRegex>(?m)^ */\*\*\n *\* *@return *(.*) *\n
*\*/$</searchRegex>
+ <replacement>/** Returns $1 */</replacement>
+ </replaceRegex>
+ <replaceRegex>
+ <name>Purge single returns tag single line</name>
+ <searchRegex>^ */\*\* *@return *(.*) *\*/$</searchRegex>
+ <replacement>/** Returns $1 */</replacement>
+ </replaceRegex>
+ <!-- apply a specific flavor -->
+ <eclipse>
+
<file>${session.executionRootDirectory}/dev/PhoenixCodeTemplate.xml</file>
+ </eclipse>
+ <importOrder>
+
<file>${session.executionRootDirectory}/dev/phoenix.importorder</file>
+ </importOrder>
+ <trimTrailingWhitespace/>
+ <endWithNewline/>
+ <removeUnusedImports/>
+ </java>
+ <pom>
+ <sortPom>
+ <expandEmptyElements>false</expandEmptyElements>
+ </sortPom>
+ </pom>
+ <formats>
+ <!-- you can define as many formats as you want, each is
independent -->
+ <format>
+ <!-- define the files to apply to -->
+ <includes>
+ <include>**/*.xml</include>
+ <include>**/*.sh</include>
+ <include>**/*.py</include>
+ <include>**/Jenkinsfile*</include>
+ <include>**/Dockerfile*</include>
+ <include>**/*.md</include>
+ <include>*.md</include>
+ <include>**/*.txt</include>
+ <include>*.txt</include>
+ </includes>
+ <excludes>
+ <exclude>**/target/**</exclude>
+ <exclude>**/dependency-reduced-pom.xml</exclude>
+ </excludes>
+ <!-- define the steps to apply to those files -->
+ <trimTrailingWhitespace/>
+ <endWithNewline/>
+ </format>
+ <format>
+ <!--
+ We have some files which have special license header which
must be kept, so
+ here we add a special format section to apply license header,
and leave the
+ java/scala section above only used for formatting code style
+ -->
+ <includes>
+ <include>src/main/java/**/*.java</include>
+ <include>src/test/java/**/*.java</include>
+ </includes>
+ <excludes>
+ <exclude>**/generated/*</exclude>
+ <exclude>**/package-info.java</exclude>
+ </excludes>
+ <licenseHeader>
+
<file>${session.executionRootDirectory}/src/main/config/checkstyle/header.txt</file>
+ <delimiter>package</delimiter>
+ </licenseHeader>
+ </format>
+ </formats>
+ <!-- Spotless considers processing same file twice: a bug!
Review Comment:
This change is no longer needed but good to have it to ensure we don't break
again in future when we move to 2.35.0+
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@phoenix.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
