Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Introduce IdentifierName:AllowInitialismsInTypeName flag #4646

Closed
wants to merge 1 commit into from
Closed

Introduce IdentifierName:AllowInitialismsInTypeName flag #4646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 14 additions & 4 deletions core/src/main/java/com/google/errorprone/bugpatterns/IdentifierName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableSet;
import com.google.errorprone.BugPattern;
import com.google.errorprone.ErrorProneFlags;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher;
import com.google.errorprone.bugpatterns.BugChecker.MethodTreeMatcher;
Expand All @@ -60,6 +61,7 @@
import com.sun.tools.javac.util.Name;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import javax.inject.Inject;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.Modifier;

Expand Down Expand Up @@ -98,17 +100,25 @@ public final class IdentifierName extends BugChecker
", with acronyms treated as words"
+ " (https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)";

private final boolean allowInitialismsInTypeName;

@Inject
IdentifierName(ErrorProneFlags flags) {
this.allowInitialismsInTypeName =
flags.getBoolean("IdentifierName:AllowInitialismsInTypeName").orElse(false);
}

@Override
public Description matchClass(ClassTree tree, VisitorState state) {
ClassSymbol symbol = getSymbol(tree);
String name = tree.getSimpleName().toString();
if (name.isEmpty() || isConformantUpperCamelName(name)) {
if (name.isEmpty() || isConformantTypeName(name)) {
// The name can be empty for enum member declarations, which are desugared early to class
// declarations.
return NO_MATCH;
}
String renamed = suggestedClassRename(name);
String suggested = fixInitialisms(renamed);
String suggested = allowInitialismsInTypeName ? renamed : fixInitialisms(renamed);
boolean fixable = !suggested.equals(name) && canBeRemoved(symbol);
String diagnostic =
"Classes should be named in UpperCamelCase"
Expand Down Expand Up @@ -281,10 +291,10 @@ private static boolean isConformantLowerCamelName(String name) {
&& !PROBABLE_INITIALISM.matcher(name).find();
}

private static boolean isConformantUpperCamelName(String name) {
private boolean isConformantTypeName(String name) {
return !name.contains("_")
&& isUpperCase(name.charAt(0))
&& !PROBABLE_INITIALISM.matcher(name).find();
&& (allowInitialismsInTypeName || !PROBABLE_INITIALISM.matcher(name).find());
}

private static boolean isStaticVariable(Symbol symbol) {
Expand Down
11 changes: 11 additions & 0 deletions core/src/test/java/com/google/errorprone/bugpatterns/IdentifierNameTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,6 +601,17 @@ public void className_badInitialism() {
.doTest();
}

@Test
public void className_badInitialism_allowed() {
helper
.setArgs("-XepOpt:IdentifierName:AllowInitialismsInTypeName=true")
.addSourceLines(
"Test.java", //
"class RPCServiceTester {",
"}")
.doTest();
}

@Test
public void className_lowerCamelCase() {
helper
Expand Down