Skip to content
This repository has been archived by the owner on Mar 16, 2020. It is now read-only.

Commit

Permalink
Comply with a coding standard
Browse files Browse the repository at this point in the history
  • Loading branch information
@Parcly-Taxel
Parcly-Taxel committed Aug 18, 2019
1 parent 74a6582 commit 38bb7e5
Show file tree
Hide file tree
Showing 10 changed files with 290 additions and 31 deletions.
5 changes: 5 additions & 0 deletions build.gradle
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
plugins {
id "java"
id "application"
id "checkstyle"
id "com.github.johnrengelman.shadow" version "5.1.0"
}

Expand All @@ -15,6 +16,10 @@ dependencies {
testImplementation "org.junit.jupiter:junit-jupiter:5.5.1"
}

checkstyle {
toolVersion = "8.23"
}

shadowJar {
archiveBaseName = "duke"
archiveVersion = "0.5.0"
Expand Down
257 changes: 257 additions & 0 deletions config/checkstyle/checkstyle.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,257 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">

<!--
Checkstyle configuration that checks the Google coding conventions from Google Java Style
that can be found at https://google.github.io/styleguide/javaguide.html
Checkstyle is very configurable. Be sure to read the documentation at
http://checkstyle.sf.net (or in your downloaded distribution).
To completely disable a check, just comment it out or delete it from the file.
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
-->

<module name = "Checker">
<property name="charset" value="UTF-8"/>

<property name="severity" value="error"/>

<property name="fileExtensions" value="java, properties, xml"/>
<!-- Excludes all 'module-info.java' files -->
<!-- See https://checkstyle.org/config_filefilters.html -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>

<module name="TreeWalker">
<module name="OuterTypeFilename"/>
<module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<property name="format"
value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
<property name="message"
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
</module>
<module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true"/>
<property name="allowByTailComment" value="true"/>
<property name="allowNonPrintableEscapes" value="true"/>
</module>
<module name="LineLength">
<property name="max" value="120"/>
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module>
<module name="AvoidStarImport"/>
<module name="OneTopLevelClass"/>
<module name="NoLineWrap"/>
<module name="EmptyBlock">
<property name="option" value="TEXT"/>
<property name="tokens"
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
</module>
<module name="NeedBraces"/>
<module name="LeftCurly"/>
<module name="RightCurly">
<property name="id" value="RightCurlySame"/>
<property name="tokens"
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
LITERAL_DO"/>
</module>
<module name="RightCurly">
<property name="id" value="RightCurlyAlone"/>
<property name="option" value="alone"/>
<property name="tokens"
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
INSTANCE_INIT"/>
</module>
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyLambdas" value="true"/>
<property name="allowEmptyMethods" value="true"/>
<property name="allowEmptyTypes" value="true"/>
<property name="allowEmptyLoops" value="true"/>
<message key="ws.notFollowed"
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
<message key="ws.notPreceded"
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
</module>
<module name="OneStatementPerLine"/>
<module name="MultipleVariableDeclarations"/>
<module name="ArrayTypeStyle"/>
<module name="MissingSwitchDefault"/>
<module name="FallThrough"/>
<module name="UpperEll"/>
<module name="ModifierOrder"/>
<module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapDot"/>
<property name="tokens" value="DOT"/>
<property name="option" value="nl"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapComma"/>
<property name="tokens" value="COMMA"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
<property name="id" value="SeparatorWrapEllipsis"/>
<property name="tokens" value="ELLIPSIS"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
<property name="id" value="SeparatorWrapArrayDeclarator"/>
<property name="tokens" value="ARRAY_DECLARATOR"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapMethodRef"/>
<property name="tokens" value="METHOD_REF"/>
<property name="option" value="nl"/>
</module>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
<message key="name.invalidPattern"
value="Package name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="TypeName">
<message key="name.invalidPattern"
value="Type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MemberName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
<message key="name.invalidPattern"
value="Member name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="LambdaParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="CatchParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="LocalVariableName">
<property name="tokens" value="VARIABLE_DEF"/>
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ClassTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MethodTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="InterfaceTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="NoFinalizer"/>
<module name="GenericWhitespace">
<message key="ws.followed"
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
<message key="ws.preceded"
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
<message key="ws.illegalFollow"
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
<message key="ws.notPreceded"
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
</module>
<module name="Indentation">
<property name="basicOffset" value="4"/>
<property name="braceAdjustment" value="0"/>
<property name="caseIndent" value="0"/>
<property name="throwsIndent" value="4"/>
<property name="lineWrappingIndentation" value="4"/>
<property name="arrayInitIndent" value="4"/>
</module>
<module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false"/>
<property name="allowedAbbreviationLength" value="1"/>
</module>
<module name="OverloadMethodsDeclarationOrder"/>
<module name="VariableDeclarationUsageDistance"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceBefore">
<property name="tokens"
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
<property name="allowLineBreaks" value="true"/>
</module>
<module name="ParenPad"/>
<module name="OperatorWrap">
<property name="option" value="NL"/>
<property name="tokens"
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
</module>
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationMostCases"/>
<property name="tokens"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
</module>
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationVariables"/>
<property name="tokens" value="VARIABLE_DEF"/>
<property name="allowSamelineMultipleAnnotations" value="true"/>
</module>
<module name="NonEmptyAtclauseDescription"/>
<module name="JavadocTagContinuationIndentation"/>
<module name="SummaryJavadoc">
<property name="forbiddenSummaryFragments"
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
</module>
<module name="JavadocParagraph"/>
<module name="AtclauseOrder">
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
<property name="target"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingThrowsTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowedAnnotations" value="Override, Test"/>
<property name="allowThrowsTagsForSubclasses" value="true"/>
</module>
<module name="MissingJavadocMethod">
<property name="scope" value="public"/>
<property name="minLineCount" value="2"/>
<property name="allowedAnnotations" value="Override, Test"/>
</module>
<module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
<message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="SingleLineJavadoc">
<property name="ignoreInlineTags" value="false"/>
</module>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/>
</module>
<module name="CommentsIndentation"/>
</module>
</module>
12 changes: 6 additions & 6 deletions src/main/java/duke/command/AddCommand.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
* Class representing a command to add a new task.
*/
public class AddCommand extends Command {
private final Task t;
private final Task task;

/**
* Creates a new AddCommand with the given task.
*
* @param t The task to add.
* @param task The task to add.
*/
public AddCommand(Task t) {
this.t = t;
public AddCommand(Task task) {
this.task = task;
}

/**
Expand All @@ -29,9 +29,9 @@ public AddCommand(Task t) {
* @param storage The place where tasks will be stored.
*/
public void execute(TaskList tl, Ui ui, Storage storage) {
tl.add(t);
tl.add(task);
ui.printMessage("Got it. I've added this task:");
ui.printMessage(" " + t);
ui.printMessage(" " + task);
int n = tl.size();
ui.printMessage(String.format("Now you have %d task%s in the list.", n, n == 1 ? "" : "s"));

Expand Down
6 changes: 3 additions & 3 deletions src/main/java/duke/command/DeleteCommand.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* Class representing a command to delete an item from the task list.
*/
public class DeleteCommand extends Command {
private final int i;
private final int ind;

/**
* Creates a new DeleteCommand with the specified index.
Expand All @@ -19,7 +19,7 @@ public class DeleteCommand extends Command {
*/
public DeleteCommand(String s) {
try {
this.i = Integer.parseInt(s);
this.ind = Integer.parseInt(s);
} catch (NumberFormatException e) {
throw new IllegalArgumentException("Task index for the delete command must be an integer.");
}
Expand All @@ -34,7 +34,7 @@ public DeleteCommand(String s) {
*/
public void execute(TaskList tl, Ui ui, Storage storage) {
try {
Task t = tl.delete(i);
Task t = tl.delete(ind);
ui.printMessage("Noted. I've removed this task:");
ui.printMessage(" " + t);
int n = tl.size();
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/duke/command/DoneCommand.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* Class representing a command to mark an item in the task list as done.
*/
public class DoneCommand extends Command {
private final int i;
private final int ind;

/**
* Creates a new DoneCommand with the specified index.
Expand All @@ -18,7 +18,7 @@ public class DoneCommand extends Command {
*/
public DoneCommand(String s) {
try {
this.i = Integer.parseInt(s);
this.ind = Integer.parseInt(s);
} catch (NumberFormatException e) {
throw new IllegalArgumentException("Task index for the done command must be an integer.");
}
Expand All @@ -33,9 +33,9 @@ public DoneCommand(String s) {
*/
public void execute(TaskList tl, Ui ui, Storage storage) {
try {
tl.markDone(i);
tl.markDone(ind);
ui.printMessage("Nice! I've marked this task as done:");
ui.printMessage(" " + tl.get(i));
ui.printMessage(" " + tl.get(ind));
} catch (IndexOutOfBoundsException e) {
ui.printError("Task index must be between 1 and " + tl.size() + ".");
}
Expand Down
6 changes: 2 additions & 4 deletions src/main/java/duke/task/Deadline.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,12 @@ public class Deadline extends Task {
*/
public static Deadline parse(String line) throws IllegalArgumentException {
if (line.isEmpty()) {
throw new IllegalArgumentException("The description " +
"of a deadline cannot be empty.");
throw new IllegalArgumentException("The description of a deadline cannot be empty.");
}

Matcher m = PAT.matcher(line);
if (!m.matches()) {
throw new IllegalArgumentException("Deadline description " +
"must include /by surrounded by spaces.");
throw new IllegalArgumentException("Deadline description must include /by surrounded by spaces.");
}

try {
Expand Down
6 changes: 2 additions & 4 deletions src/main/java/duke/task/Event.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,12 @@ public class Event extends Task {
*/
public static Event parse(String line) throws IllegalArgumentException {
if (line.isEmpty()) {
throw new IllegalArgumentException("The description " +
"of an event cannot be empty.");
throw new IllegalArgumentException("The description of an event cannot be empty.");
}

Matcher m = PAT.matcher(line);
if (!m.matches()) {
throw new IllegalArgumentException("Event description " +
"must include /at surrounded by spaces.");
throw new IllegalArgumentException("Event description must include /at surrounded by spaces.");
}

try {
Expand Down
Loading

0 comments on commit 38bb7e5

Please sign in to comment.