jackmounts
commented
3 years ago how is checkstyle doing
Closed eutampieri closed 3 years ago
jackmounts
commented
3 years ago how is checkstyle doing
eutampieri
commented
3 years ago [ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Bat.java:87:36: 'typecast' is not followed by whitespace. [WhitespaceAfter]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Bat.java:87:84: 'typecast' is not followed by whitespace. [WhitespaceAfter]
> Task :checkstyleMain
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Boss.java:7:16: Using the '.*' form of import should be avoided - java.awt.*. [AvoidStarImport]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Boss.java:84:36: 'typecast' is not followed by whitespace. [WhitespaceAfter]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Boss.java:84:84: 'typecast' is not followed by whitespace. [WhitespaceAfter]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:18:23: Variable 'up' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:18:27: Variable 'down' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:18:33: Variable 'right' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:18:40: Variable 'left' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:22:25: Variable 'face' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:26:19: Variable 'hp' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:30:19: Variable 'width' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:30:26: Variable 'height' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:30:34: Variable 'size' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:34:23: Variable 'tileMap' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:41:55: Expected @param tag for 'width'. [JavadocMethod]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:41:72: Expected @param tag for 'height'. [JavadocMethod]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:42:34: Expected @param tag for 'kind'. [JavadocMethod]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:42:51: Expected @param tag for 'team'. [JavadocMethod]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:212: @return tag should be present and have description. [JavadocMethod]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:214:5: Class 'Entity' looks like designed for extension (can be subclassed), but the method 'isMarkedForDeletion' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Entity' final or making the method 'isMarkedForDeletion' static/final/abstract/empty, or adding allowed annotation for the method. [DesignForExtension]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:219:5: Class 'Entity' looks like designed for extension (can be subclassed), but the method 'isMoving' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Entity' final or making the method 'isMoving' static/final/abstract/empty, or adding allowed annotation for the method. [DesignForExtension]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Entity.java:219:30: '{' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:11:9: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:11:16: Missing a Javadoc comment. [JavadocVariable]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:14: First sentence should end with a period. [JavadocStyle]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:17:26: Variable 'team' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:22:19: Variable 'posX' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:22:25: Variable 'posY' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:26:30: Variable 'kind' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:30:19: Variable 'speedX' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:30:27: Variable 'speedY' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:34:28: Variable 'hitBox' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:41:95: Expected @param tag for 'hitBox'. [JavadocMethod]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:41:114: Expected @param tag for 'team'. [JavadocMethod]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:55:57: Redundant 'final' modifier. [RedundantModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:55:80: Expected @param tag for 'others'. [JavadocMethod]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/GameObject.java:175:5: Class 'GameObject' looks like designed for extension (can be subclassed), but the method 'getTeam' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'GameObject' final or making the method 'getTeam' static/final/abstract/empty, or adding allowed annotation for the method. [DesignForExtension]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:12:19: Variable 'strength' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:16:19: Variable 'ps' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:20:20: Variable 'fireRate' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:24:23: Variable 'canFire' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:28:20: Variable 'fireDelay' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:28:31: Variable 'fireDelayCount' must be private and have accessor methods. [VisibilityModifier]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:64:5: Class 'Weapon' looks like designed for extension (can be subclassed), but the method 'update' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Weapon' final or making the method 'update' static/final/abstract/empty, or adding allowed annotation for the method. [DesignForExtension]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:74:86: '/' is not followed by whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:74:86: '/' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:75:86: '/' is not followed by whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:75:86: '/' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:111:20: '*' is not followed by whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:111:20: '*' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:111:28: '*' is not followed by whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:111:28: '*' is not preceded with whitespace. [WhitespaceAround]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/Weapon.java:116:5: Class 'Weapon' looks like designed for extension (can be subclassed), but the method 'setUser' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Weapon' final or making the method 'setUser' static/final/abstract/empty, or adding allowed annotation for the method. [DesignForExtension]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/gen/SingleObjectFactoryImpl.java:28:5: Class 'SingleObjectFactoryImpl' looks like designed for extension (can be subclassed), but the method 'spawnAt' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'SingleObjectFactoryImpl' final or making the method 'spawnAt' static/final/abstract/empty, or adding allowed annotation for the method. [DesignForExtension]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/model/gen/SingleObjectFactoryImpl.java:38:5: Class 'SingleObjectFactoryImpl' looks like designed for extension (can be subclassed), but the method 'spawnSome' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'SingleObjectFactoryImpl' final or making the method 'spawnSome' static/final/abstract/empty, or adding allowed annotation for the method. [DesignForExtension]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/ui/World.java:3:37: Using the '.*' form of import should be avoided - eu.eutampieri.catacombs.model.*. [AvoidStarImport]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/ui/World.java:45:54: '5' is a magic number. [MagicNumber]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/ui/gamefx/AssetManagerProxy.java:3:37: Using the '.*' form of import should be avoided - eu.eutampieri.catacombs.model.*. [AvoidStarImport]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/ui/gamefx/AssetManagerProxy.java:20:19: 'static' modifier out of order with the JLS suggestions. [ModifierOrder]
[ant:checkstyle] [WARN] /home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/src/main/java/eu/eutampieri/catacombs/ui/gamefx/AssetManagerProxy.java:151:55: '(' is preceded with whitespace. [MethodParamPad]
Checkstyle rule violations were found. See the report at: file:///home/runner/work/OOP20-procedural-dungeon/OOP20-procedural-dungeon/build/reports/checkstyle/main.html
Checkstyle files with violations: 8
Checkstyle violations by severity: [warning:61]not so great
I'm opening this because it'll otherwise be a huge PR