diff --git a/.github/workflows/check-pr-style.yml b/.github/workflows/check-pr-style.yml new file mode 100644 index 000000000..7ac69d24b --- /dev/null +++ b/.github/workflows/check-pr-style.yml @@ -0,0 +1,31 @@ +name: Check PR code style + +on: + pull_request: + branches: [ master ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up JDK 11 + uses: actions/setup-java@v1 + with: + java-version: 1.11 + - name: Run java checkstyle + uses: nikitasavinov/checkstyle-action@d87d526a914fc5cb0b003908e35038dbb2d6e1b7 + with: + # Report level for reviewdog [info,warning,error] + level: info + # Reporter of reviewdog command [github-pr-check,github-pr-review] + reporter: github-pr-check + # Filtering for the reviewdog command [added,diff_context,file,nofilter]. + filter_mode: added + # Exit code for reviewdog when errors are found [true,false]. + fail_on_error: false + # Checkstyle config file + checkstyle_config: minestom_checks.xml + checkstyle_version: "8.37" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index a3cf9d6c7..c6d8bda7c 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -31,5 +31,5 @@ jobs: net/minestom/ - name: Build Minestom run: ./gradlew classes testClasses - - name: Run tests - run: ./gradlew check + - name: Run Minestom tests + run: ./gradlew test diff --git a/build.gradle b/build.gradle index f84f82d6d..f01a523cc 100644 --- a/build.gradle +++ b/build.gradle @@ -6,6 +6,7 @@ plugins { id 'maven-publish' id 'net.ltgt.apt' version '0.10' id 'org.jetbrains.kotlin.jvm' version '1.4.10' + id 'checkstyle' } group 'net.minestom.server' @@ -36,7 +37,7 @@ allprojects { maven { url 'https://jitpack.io' } maven { name 'sponge' - url 'http://repo.spongepowered.org/maven' + url 'https://repo.spongepowered.org/maven' } } javadoc { @@ -45,6 +46,11 @@ allprojects { addBooleanOption('html5', true) } } + + checkstyle { + toolVersion "8.37" + configFile file("${projectDir}/minestom_checks.xml") + } } sourceSets { diff --git a/minestom_checks.xml b/minestom_checks.xml new file mode 100644 index 000000000..eb513ae72 --- /dev/null +++ b/minestom_checks.xml @@ -0,0 +1,303 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/main/java/net/minestom/server/entity/Player.java b/src/main/java/net/minestom/server/entity/Player.java index b26b531e6..cceb40ecd 100644 --- a/src/main/java/net/minestom/server/entity/Player.java +++ b/src/main/java/net/minestom/server/entity/Player.java @@ -1163,8 +1163,7 @@ public class Player extends LivingEntity implements CommandSender { /** * Gets the player display name in the tab-list. * - * @return the player display name, - * null means that {@link #getUsername()} is displayed + * @return the player display name, null means that {@link #getUsername()} is displayed */ @Nullable public ColoredText getDisplayName() {