From 44081a3b357c3a5a75a7653078f76255dd8a2fd4 Mon Sep 17 00:00:00 2001 From: Martin Sulikowski Date: Wed, 4 Oct 2023 20:47:37 +0200 Subject: [PATCH] Add checkstyle and fix issues reported by checkstyle. --- buildSrc/build.gradle.kts | 1 + .../main/kotlin/eternalcode.java.gradle.kts | 10 + config/checkstyle/checkstyle.xml | 217 ++++++++++++++++++ config/checkstyle/suppressions.xml | 6 + .../eternalcode/formatter/ChatController.java | 6 +- .../formatter/ChatFormatterPlugin.java | 8 +- .../adventure/PlayerSignedMessage.java | 2 +- .../adventure/TextColorTagResolver.java | 17 +- .../eternalcode/formatter/legacy/Legacy.java | 6 +- .../placeholder/PlaceholderRegistry.java | 8 +- .../preparatory/ChatPreparatoryService.java | 2 +- .../preparatory/ChatPrepareResult.java | 6 +- .../formatter/template/Template.java | 8 +- .../formatter/template/TemplateService.java | 2 +- .../LegacyChatComposerProvider.java | 2 +- .../LegacyChatFormatterProvider.java | 2 +- .../ModernChatRendererProvider.java | 2 +- .../paper/adventure/PaperSignedMessage.java | 2 +- .../adventure/PaperSignedMessageProvider.java | 2 +- .../paper/injector/DependencyInjector.java | 5 +- 20 files changed, 278 insertions(+), 36 deletions(-) create mode 100644 config/checkstyle/checkstyle.xml create mode 100644 config/checkstyle/suppressions.xml diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts index 9948709..d6cccac 100644 --- a/buildSrc/build.gradle.kts +++ b/buildSrc/build.gradle.kts @@ -3,6 +3,7 @@ plugins { } repositories { + mavenCentral() gradlePluginPortal() } diff --git a/buildSrc/src/main/kotlin/eternalcode.java.gradle.kts b/buildSrc/src/main/kotlin/eternalcode.java.gradle.kts index 1c919aa..a3580b9 100644 --- a/buildSrc/src/main/kotlin/eternalcode.java.gradle.kts +++ b/buildSrc/src/main/kotlin/eternalcode.java.gradle.kts @@ -1,10 +1,20 @@ plugins { `java-library` + checkstyle } group = "com.eternalcode" version = "1.0.7" +checkstyle { + toolVersion = "10.12.3" + + configFile = file("${rootDir}/config/checkstyle/checkstyle.xml") + + maxErrors = 0 + maxWarnings = 0 +} + repositories { mavenCentral() maven { url = uri("https://hub.spigotmc.org/nexus/content/repositories/snapshots/") } diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml new file mode 100644 index 0000000..ff41fc6 --- /dev/null +++ b/config/checkstyle/checkstyle.xml @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/config/checkstyle/suppressions.xml b/config/checkstyle/suppressions.xml new file mode 100644 index 0000000..d609557 --- /dev/null +++ b/config/checkstyle/suppressions.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/core/src/main/java/com/eternalcode/formatter/ChatController.java b/core/src/main/java/com/eternalcode/formatter/ChatController.java index 4937aaa..eba6d6a 100644 --- a/core/src/main/java/com/eternalcode/formatter/ChatController.java +++ b/core/src/main/java/com/eternalcode/formatter/ChatController.java @@ -127,12 +127,12 @@ void onChat(AsyncPlayerChatEvent event) { message = this.templateService.applyTemplates(message); message = this.placeholderRegistry.format(message, player); - Component messageComponent = miniMessage.deserialize(message, this.createTagResolvers(event)); + Component messageComponent = this.miniMessage.deserialize(message, this.createTagResolvers(event)); Set recipients = event.getRecipients(); - if (!preparatoryService.isEmpty()) { - ChatPrepareResult result = preparatoryService.prepare(player, recipients, GSON.serialize(messageComponent), event.getMessage()); + if (!this.preparatoryService.isEmpty()) { + ChatPrepareResult result = this.preparatoryService.prepare(player, recipients, GSON.serialize(messageComponent), event.getMessage()); if (result.isCancelled()) { return; diff --git a/core/src/main/java/com/eternalcode/formatter/ChatFormatterPlugin.java b/core/src/main/java/com/eternalcode/formatter/ChatFormatterPlugin.java index e713cc4..d0871dc 100644 --- a/core/src/main/java/com/eternalcode/formatter/ChatFormatterPlugin.java +++ b/core/src/main/java/com/eternalcode/formatter/ChatFormatterPlugin.java @@ -87,22 +87,22 @@ public void onDisable() { @Override public PlaceholderRegistry getPlaceholderRegistry() { - return placeholderRegistry; + return this.placeholderRegistry; } @Override public TemplateService getTemplateService() { - return templateService; + return this.templateService; } @Override public ChatRankProvider getRankProvider() { - return rankProvider; + return this.rankProvider; } @Override public ChatPreparatoryService getChatPreparatoryService() { - return chatPreparatoryService; + return this.chatPreparatoryService; } } diff --git a/core/src/main/java/com/eternalcode/formatter/adventure/PlayerSignedMessage.java b/core/src/main/java/com/eternalcode/formatter/adventure/PlayerSignedMessage.java index 863ac21..f16c6fe 100644 --- a/core/src/main/java/com/eternalcode/formatter/adventure/PlayerSignedMessage.java +++ b/core/src/main/java/com/eternalcode/formatter/adventure/PlayerSignedMessage.java @@ -54,7 +54,7 @@ public Signature signature() { @Override public @NotNull Identity identity() { - return identity; + return this.identity; } } diff --git a/core/src/main/java/com/eternalcode/formatter/adventure/TextColorTagResolver.java b/core/src/main/java/com/eternalcode/formatter/adventure/TextColorTagResolver.java index 3f694fe..44a8c54 100644 --- a/core/src/main/java/com/eternalcode/formatter/adventure/TextColorTagResolver.java +++ b/core/src/main/java/com/eternalcode/formatter/adventure/TextColorTagResolver.java @@ -13,7 +13,13 @@ import org.jetbrains.annotations.NotNull; import javax.annotation.Nullable; -import java.util.*; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; + public class TextColorTagResolver implements TagResolver, SerializableResolver.Single { @@ -53,13 +59,14 @@ private TextColorTagResolver(Collection allowedColors) { String colorName; if (isColorOrAbbreviation(name)) { colorName = args.popOr("Expected to find a color parameter: |#RRGGBB").lowerValue(); - } else { + } + else { colorName = name; } TextColor color = resolveColor(colorName, ctx); - if (!allowedColors.contains(color)) { + if (!this.allowedColors.contains(color)) { throw ctx.newException(String.format("Color '%s' is not allowed.", colorName)); } @@ -84,13 +91,13 @@ private TextColorTagResolver(Collection allowedColors) { @Override public boolean has(final @NotNull String name) { - if (isColorOrAbbreviation(name)) { + if (this.isColorOrAbbreviation(name)) { return true; } NamedTextColor textColor = NamedTextColor.NAMES.value(name); - if (textColor != null && allowedColors.contains(textColor)) { + if (textColor != null && this.allowedColors.contains(textColor)) { return true; } diff --git a/core/src/main/java/com/eternalcode/formatter/legacy/Legacy.java b/core/src/main/java/com/eternalcode/formatter/legacy/Legacy.java index b97a9df..4a79184 100644 --- a/core/src/main/java/com/eternalcode/formatter/legacy/Legacy.java +++ b/core/src/main/java/com/eternalcode/formatter/legacy/Legacy.java @@ -13,8 +13,8 @@ public final class Legacy { public static final String SHADOW = ""; public static final Pattern ALL_PATTERN = Pattern.compile(".*"); - public static final Pattern AMPERSAND_PATTERN = Pattern.compile( "(?i)" + AMPERSAND + "[0-9A-FK-ORX#]" ); - public static final Pattern SHADOW_PATTERN = Pattern.compile( "(?i)" + SHADOW + "[0-9A-FK-ORX#]" ); + public static final Pattern AMPERSAND_PATTERN = Pattern.compile("(?i)" + AMPERSAND + "[0-9A-FK-ORX#]"); + public static final Pattern SHADOW_PATTERN = Pattern.compile("(?i)" + SHADOW + "[0-9A-FK-ORX#]"); private Legacy() { } @@ -70,7 +70,7 @@ static String placeholderToAmpersand(String text) { int matched = 0; while (matcher.find()) { int length = (matcher.end() - matcher.start()) - 1; - builder.replace(matcher.start() + matched, matcher.end() + matched - 1, String.valueOf( AMPERSAND )); + builder.replace(matcher.start() + matched, matcher.end() + matched - 1, String.valueOf(AMPERSAND)); matched -= length; matched += 1; } diff --git a/core/src/main/java/com/eternalcode/formatter/placeholder/PlaceholderRegistry.java b/core/src/main/java/com/eternalcode/formatter/placeholder/PlaceholderRegistry.java index 9ebd503..dde2b69 100644 --- a/core/src/main/java/com/eternalcode/formatter/placeholder/PlaceholderRegistry.java +++ b/core/src/main/java/com/eternalcode/formatter/placeholder/PlaceholderRegistry.java @@ -32,11 +32,11 @@ public void playerStack(PlayerPlaceholderStack stack) { } public String format(String text) { - for (PlaceholderStack stack : stacks) { + for (PlaceholderStack stack : this.stacks) { text = stack.apply(text); } - for (Map.Entry entry : placeholders.entrySet()) { + for (Map.Entry entry : this.placeholders.entrySet()) { text = text.replace(entry.getKey(), entry.getValue().extract()); } @@ -44,11 +44,11 @@ public String format(String text) { } public String format(String text, Player target) { - for (PlayerPlaceholderStack stack : playerStacks) { + for (PlayerPlaceholderStack stack : this.playerStacks) { text = stack.apply(text, target); } - for (Map.Entry entry : playerPlaceholders.entrySet()) { + for (Map.Entry entry : this.playerPlaceholders.entrySet()) { text = text.replace(entry.getKey(), entry.getValue().extract(target)); } diff --git a/core/src/main/java/com/eternalcode/formatter/preparatory/ChatPreparatoryService.java b/core/src/main/java/com/eternalcode/formatter/preparatory/ChatPreparatoryService.java index 41fd171..4541244 100644 --- a/core/src/main/java/com/eternalcode/formatter/preparatory/ChatPreparatoryService.java +++ b/core/src/main/java/com/eternalcode/formatter/preparatory/ChatPreparatoryService.java @@ -20,7 +20,7 @@ public boolean isEmpty() { public ChatPrepareResult prepare(Player player, Set receivers, String jsonFormat, String message) { ChatPrepareResult result = new ChatPrepareResult(jsonFormat, receivers, false); - for (ChatPreparatory preparation : preparations) { + for (ChatPreparatory preparation : this.preparations) { result = preparation.prepare(player, result.getReceivers(), result.getRawMessage(), message, result.isCancelled()); } diff --git a/core/src/main/java/com/eternalcode/formatter/preparatory/ChatPrepareResult.java b/core/src/main/java/com/eternalcode/formatter/preparatory/ChatPrepareResult.java index f46537a..77ad26d 100644 --- a/core/src/main/java/com/eternalcode/formatter/preparatory/ChatPrepareResult.java +++ b/core/src/main/java/com/eternalcode/formatter/preparatory/ChatPrepareResult.java @@ -18,15 +18,15 @@ public ChatPrepareResult(String rawMessage, Set receivers, boolean cance } public boolean isCancelled() { - return cancelled; + return this.cancelled; } public String getRawMessage() { - return rawMessage; + return this.rawMessage; } public Set getReceivers() { - return receivers; + return this.receivers; } } diff --git a/core/src/main/java/com/eternalcode/formatter/template/Template.java b/core/src/main/java/com/eternalcode/formatter/template/Template.java index 5d66feb..462be5f 100644 --- a/core/src/main/java/com/eternalcode/formatter/template/Template.java +++ b/core/src/main/java/com/eternalcode/formatter/template/Template.java @@ -29,15 +29,15 @@ private Template(String name, List arguments, String content) { } public String getName() { - return name; + return this.name; } public List getArguments() { - return Collections.unmodifiableList(arguments); + return Collections.unmodifiableList(this.arguments); } public String getContent() { - return content; + return this.content; } public String apply(String text) { @@ -128,7 +128,7 @@ private static List parseArguments(String text, String before) { @Override public String toString() { - return String.format(TEMPLATE_FORMAT, name, Joiner.on(SEPARATOR_FORMAT).join(this.arguments, arg -> String.format(ARGUMENT_FORMAT, arg)), this.content); + return String.format(TEMPLATE_FORMAT, this.name, Joiner.on(SEPARATOR_FORMAT).join(this.arguments, arg -> String.format(ARGUMENT_FORMAT, arg)), this.content); } } diff --git a/core/src/main/java/com/eternalcode/formatter/template/TemplateService.java b/core/src/main/java/com/eternalcode/formatter/template/TemplateService.java index 555f636..ac76f05 100644 --- a/core/src/main/java/com/eternalcode/formatter/template/TemplateService.java +++ b/core/src/main/java/com/eternalcode/formatter/template/TemplateService.java @@ -9,7 +9,7 @@ public TemplateService(TemplateRepository repository) { } public String applyTemplates(String text) { - for (Template template : repository.getTemplates()) { + for (Template template : this.repository.getTemplates()) { text = template.apply(text); } diff --git a/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/LegacyChatComposerProvider.java b/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/LegacyChatComposerProvider.java index dc6b86d..f90b7ca 100644 --- a/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/LegacyChatComposerProvider.java +++ b/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/LegacyChatComposerProvider.java @@ -18,7 +18,7 @@ public Class getType() { @Override public Object getDependency() { - return (ChatComposer) (source, sourceDisplayName, ignoredMessage) -> component; + return (ChatComposer) (source, sourceDisplayName, ignoredMessage) -> this.component; } } diff --git a/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/LegacyChatFormatterProvider.java b/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/LegacyChatFormatterProvider.java index 3e9d8df..91b9824 100644 --- a/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/LegacyChatFormatterProvider.java +++ b/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/LegacyChatFormatterProvider.java @@ -18,7 +18,7 @@ public Class getType() { @Override public Object getDependency() { - return (ChatFormatter) (displayName, message) -> component; + return (ChatFormatter) (displayName, message) -> this.component; } } diff --git a/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/ModernChatRendererProvider.java b/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/ModernChatRendererProvider.java index cd3cc3f..b1beb31 100644 --- a/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/ModernChatRendererProvider.java +++ b/paper-multi-version-support/src/main/java/com/eternalcode/paper/multiversion/ModernChatRendererProvider.java @@ -18,7 +18,7 @@ public Class getType() { @Override public Object getDependency() { - return (ChatRenderer) (source, sourceDisplayName, ignoredMessage, viewer) -> component; + return (ChatRenderer) (source, sourceDisplayName, ignoredMessage, viewer) -> this.component; } } diff --git a/paper-support/src/main/java/com/eternalcode/formatter/paper/adventure/PaperSignedMessage.java b/paper-support/src/main/java/com/eternalcode/formatter/paper/adventure/PaperSignedMessage.java index 0235e09..363f171 100644 --- a/paper-support/src/main/java/com/eternalcode/formatter/paper/adventure/PaperSignedMessage.java +++ b/paper-support/src/main/java/com/eternalcode/formatter/paper/adventure/PaperSignedMessage.java @@ -54,7 +54,7 @@ public Signature signature() { @Override public @NotNull Identity identity() { - return identity; + return this.identity; } } diff --git a/paper-support/src/main/java/com/eternalcode/formatter/paper/adventure/PaperSignedMessageProvider.java b/paper-support/src/main/java/com/eternalcode/formatter/paper/adventure/PaperSignedMessageProvider.java index 0bbaaaf..823a935 100644 --- a/paper-support/src/main/java/com/eternalcode/formatter/paper/adventure/PaperSignedMessageProvider.java +++ b/paper-support/src/main/java/com/eternalcode/formatter/paper/adventure/PaperSignedMessageProvider.java @@ -23,7 +23,7 @@ public Class getType() { @Override public SignedMessage getDependency() { - return new PaperSignedMessage(messageComponent, Identity.identity(player.getUniqueId())); + return new PaperSignedMessage(this.messageComponent, Identity.identity(this.player.getUniqueId())); } } diff --git a/paper-support/src/main/java/com/eternalcode/formatter/paper/injector/DependencyInjector.java b/paper-support/src/main/java/com/eternalcode/formatter/paper/injector/DependencyInjector.java index ebcbf32..bcf3a74 100644 --- a/paper-support/src/main/java/com/eternalcode/formatter/paper/injector/DependencyInjector.java +++ b/paper-support/src/main/java/com/eternalcode/formatter/paper/injector/DependencyInjector.java @@ -19,7 +19,7 @@ public DependencyInjector tryRegister(Supplier> this.registerUnSafe(legacyDependencyProvider.getType(), legacyDependencyProvider.getDependency()); } - catch (NoClassDefFoundError ignored) {} + catch (NoClassDefFoundError ignored) { } return this; } @@ -58,7 +58,8 @@ public T newInstance(Class clazz) { try { return clazz.cast(constructor.newInstance(parameters.toArray(new Object[0]))); - } catch (ReflectiveOperationException e) { + } + catch (ReflectiveOperationException e) { throw new IllegalStateException("Failed to instantiate " + clazz, e); } }