! update after release v0.5.3

foldright · Apr 6, 2024 · 8e74c6d · 8e74c6d
1 parent 8b3167d
commit 8e74c6d
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -27,10 +27,10 @@ The purpose of **Inspectable Wrappers** is to provide a standard for wrapper cha
 
 - [🍡 Files](#-files)
 - [🌰 Usage Demo](#-usage-demo)
-  - [wrapper implementations in your application code](#wrapper-implementations-in-your-application-code)
+  - [demo wrapper implementations in your application code](#demo-wrapper-implementations-in-your-application-code)
   - [inspection of the wrapper chain](#inspection-of-the-wrapper-chain)
 - [🌰 Integration Demo](#-integration-demo)
-  - [the demo existed wrapper cannot be modified](#the-demo-existed-wrapper-cannot-be-modified)
+  - [the demo existed wrapper which cannot be modified](#the-demo-existed-wrapper-which-cannot-be-modified)
   - [the integration code](#the-integration-code)
 - [🌰 Integration Demo using `WrapperAdapterUtils`](#-integration-demo-using-wrapperadapterutils)
 - [🍼 Java API Docs](#-java-api-docs)
@@ -362,20 +362,20 @@ For `Maven` projects:
 <dependency>
   <groupId>io.foldright</groupId>
   <artifactId>inspectable-wrappers</artifactId>
-  <version>0.5.2</version>
+  <version>0.5.3</version>
 </dependency>
 ```
 
 For `Gradle` projects:
 
 ```groovy
 // Gradle Kotlin DSL
-implementation("io.foldright:inspectable-wrappers:0.5.2")
+implementation("io.foldright:inspectable-wrappers:0.5.3")
 ```
 
 ```groovy
 // Gradle Groovy DSL
-implementation 'io.foldright:inspectable-wrappers:0.5.2'
+implementation 'io.foldright:inspectable-wrappers:0.5.3'
 ```
 
 `inspectable-wrappers` has published to maven central, find the latest version at [central.sonatype.com](https://central.sonatype.com/artifact/io.foldright/inspectable-wrappers/0.3.0/versions).
diff --git a/pom.xml b/pom.xml
@@ -496,32 +496,33 @@
 							<excludePackageNames>${javadoc.default.exclude.packages}</excludePackageNames>
 							<!-- https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#detectOfflineLinks -->
 							<detectOfflineLinks>false</detectOfflineLinks>
-							<offlineLinks>
-								<offlineLink>
-									<url>https://www.javadoc.io/doc/com.google.code.findbugs/jsr305/${jsr305.version}/</url>
-									<location>${javadoc.package.list.dir}/jsr305/</location>
-								</offlineLink>
-								<offlineLink>
-									<url>
-										https://www.javadoc.io/doc/com.github.spotbugs/spotbugs-annotations/${spotbugs.annotations.version}/
-									</url>
-									<location>${javadoc.package.list.dir}/spotbugs-annotations/</location>
-								</offlineLink>
-								<offlineLink>
-									<url>https://www.javadoc.io/doc/org.jetbrains/annotations/${jetbrains.annotations.version}/</url>
-									<location>${javadoc.package.list.dir}/jetbrains-annotations/</location>
-								</offlineLink>
-								<offlineLink>
-									<url>https://docs.oracle.com/en/java/javase/${perform.release.jdk.version}/docs/api/java.base/</url>
-									<location>${javadoc.package.list.dir}/java/</location>
-								</offlineLink>
-							</offlineLinks>
 							<additionalOptions>
 								<!--
 									Maven javadoc Search redirects to "/undefined/.." url - Stack Overflow
 									https://stackoverflow.com/questions/52326318
 								-->
 								<additionalOption>-html5</additionalOption>
+
+								<additionalOption>-linkoffline</additionalOption>
+								<additionalOption>
+									https://www.javadoc.io/doc/com.github.spotbugs/spotbugs-annotations/${spotbugs.annotations.version}/
+								</additionalOption>
+								<additionalOption>${javadoc.package.list.dir}/spotbugs-annotations/</additionalOption>
+								<additionalOption>-linkoffline</additionalOption>
+								<additionalOption>
+									https://www.javadoc.io/doc/org.jetbrains/annotations/${jetbrains.annotations.version}/
+								</additionalOption>
+								<additionalOption>${javadoc.package.list.dir}/jetbrains-annotations/</additionalOption>
+								<additionalOption>-linkoffline</additionalOption>
+								<additionalOption>
+									https://www.javadoc.io/doc/com.google.code.findbugs/jsr305/${jsr305.version}/
+								</additionalOption>
+								<additionalOption>${javadoc.package.list.dir}/jsr305/</additionalOption>
+								<additionalOption>-linkoffline</additionalOption>
+								<additionalOption>
+									https://docs.oracle.com/en/java/javase/${perform.release.jdk.version}/docs/api/java.base/
+								</additionalOption>
+								<additionalOption>${javadoc.package.list.dir}/java/</additionalOption>
 							</additionalOptions>
 							<additionalJOptions>
 								<additionalJOption>-J-Duser.language=en</additionalJOption>

diff --git a/scripts/check-forbidden-classes.sh b/scripts/check-forbidden-classes.sh
@@ -5,25 +5,27 @@ set -eEuo pipefail
 cd "${0%/*}"/..
 
 readonly forbidden_classes=(
-  # use edu.umd.cs.findbugs.annotations.Nullable
+  # prefer edu.umd.cs.findbugs.annotations.Nullable
   javax.annotation.Nullable
   org.jetbrains.annotations.Nullable
 
-  # use edu.umd.cs.findbugs.annotations.NonNull
+  # prefer edu.umd.cs.findbugs.annotations.NonNull
   javax.annotation.Nonnull
   org.jetbrains.annotations.NotNull
 
-  # use edu.umd.cs.findbugs.annotations.CheckForNull
+  # prefer edu.umd.cs.findbugs.annotations.CheckForNull
   javax.annotation.CheckReturnValue
   org.jetbrains.annotations.CheckReturnValue
 
-  # use @edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters(NonNull.class)
+  # prefer @edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters(NonNull.class)
   javax.annotation.ParametersAreNonnullByDefault
+
+  # prefer static import methods of `Assertions`
+  org.junit.jupiter.api.Assertions\;
 )
 
 grep_pattern=$(printf '%s\n' "${forbidden_classes[@]}")
+[[ "${GITHUB_ACTIONS:-}" = true || -t 1 ]] && more_grep_options=(--color=always)
+readonly grep_pattern more_grep_options
 
-grep_options=("$grep_pattern" -F -n -C2 -r src/)
-[[ "${GITHUB_ACTIONS:-}" = true || -t 1 ]] && grep_options=("${grep_options[@]}" --color=always)
-
-! grep "${grep_options[@]}"
+! grep "$grep_pattern" -F ${more_grep_options[@]:+"${more_grep_options[@]}"} -n -C2 -r src/