Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configure documentation URL for StringJoin check #331

Merged
merged 3 commits into from
Nov 3, 2022
+4 −2
Merged

Configure documentation URL for StringJoin check #331

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
21854c9
Added the missing link on the StringJoin bug checker
gtoison Nov 3, 2022
d62cafd
Removed unused static import
gtoison Nov 3, 2022
6ca7a9d
Updated the linkType to CUSTOM (default is AUTOGENERATED)
gtoison Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/StringJoin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
package tech.picnic.errorprone.bugpatterns;

import static com.google.errorprone.BugPattern.LinkType.NONE;
import static com.google.errorprone.BugPattern.LinkType.CUSTOM;
import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION;
import static com.google.errorprone.BugPattern.StandardTags.SIMPLIFICATION;
import static com.google.errorprone.matchers.method.MethodMatchers.staticMethod;
import static tech.picnic.errorprone.bugpatterns.util.Documentation.BUG_PATTERNS_BASE_URL;

import com.google.auto.service.AutoService;
import com.google.common.base.Splitter;
Expand Down Expand Up @@ -40,7 +41,8 @@
@AutoService(BugChecker.class)
@BugPattern(
summary = "Prefer `String#join` over `String#format`",
linkType = NONE,
link = BUG_PATTERNS_BASE_URL + "StringJoin",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
link = BUG_PATTERNS_BASE_URL + "StringJoin",
link = BUG_PATTERNS_BASE_URL + "StringJoin",
linkType = CUSTOM,

We should define the linkType as well, otherwise the URL won't be shown as the default is LinkType.AUTOGENERATED.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this should be better now, thanks!

linkType = CUSTOM,
severity = SUGGESTION,
tags = SIMPLIFICATION)
public final class StringJoin extends BugChecker implements MethodInvocationTreeMatcher {
Expand Down