[CS2113-T12-4] WellNUS++

.github/ISSUE_TEMPLATE/administrative-matters.md

@@ -0,0 +1,36 @@
+---
+name: Administrative Matters
+about: Add chores that must be done
+title: "[Task] Your Chore Name"
+labels: priority.Low, type.Task
+assignees: ''
+
+---
+
+**Describe the Task**
+A clear and concise description of what the Task/Chore is.  
+e.g. Move testing code to new folder
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
+
+**Labels**
+Remember to tag the priority using the labels function.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: File a bug report for WellNUS++
+title: "[Bug] Your Bug Name"
+labels: severity.Low, type.Bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
+
+**Severity**
+Remember to tag the severity of the bug and priority (if applicable) using the labels function.

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,21 @@
+---
+name: Enhancement
+about: Anything that improves on an existing feature/implementation
+title: "[Enhancement] Your Enhancement"
+labels: priority.Low, type.Enhancement
+assignees: ''
+
+---
+
+**What is the current behaviour? Please describe any relevant features.**
+
+**Why should this behaviour be changed/improved? Describe any relevant user stories/frustrations.**
+
+**Describe your proposed enhancement.**
+
+**Screenshots(if any) of the enhancement.**
+
+**Any alternative implementations/enhancements that were considered?**
+If any exist, explain why they were not chosen.
+
+**Why should this enhancement be added? Explain its benefits/significance.**

.github/ISSUE_TEMPLATE/user-story-features.md

@@ -0,0 +1,29 @@
+---
+name: User Story Features
+about: Anything related to adding features that involve user stories
+title: "[User Story Feature] Your Feature"
+labels: priority.Low, type.Story
+assignees: ''
+
+---
+
+**User Story**
+What is the user story this feature aims to achieve?  
+Describe it and label the issue accordingly.  
+- Is it a 'Epic' -> A big feature which can be broken down into smaller stories
+- Is it a 'Story' -> A smaller feature
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.  Optional if it does not value-add to the issue.  
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+
+**Labels**
+Remember to label the feature with the appropriate `priority` and `type`.

.gitignore

@@ -15,3 +15,7 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+/data/
+
+/log/

build.gradle

@@ -29,18 +29,30 @@ test {
 }
 
 application {
-    mainClass = "seedu.duke.Duke"
+    mainClass = "wellnus.WellNus"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
-    archiveClassifier = null
+    archiveBaseName.set('WellNus')
+    archiveClassifier.set('')
+    archiveVersion.set('v2.1')
+}
+
+jar {
+    manifest {
+        attributes "Main-Class": "wellnus.WellNus"
+    }
+
+    from {
+        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
+    }
 }
 
 checkstyle {
     toolVersion = '10.2'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true
 }

config/checkstyle/checkstyle.xml

@@ -5,7 +5,7 @@
 
 <!--
     This configuration file enforces rules for the coding standard at
-    https://se-education.org/guides/conventions/java/basic.html
+    https://se-education.org/guides/conventions/java/intermediate.html
 -->
 
 <module name="Checker">
@@ -48,6 +48,21 @@
         IMPORT CHECKS
         -->
 
+        <!-- Checks the ordering of import statements follow the rules that the default Eclipse formatter uses.
+        The order rule "STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE" consists of:
+          1. STATIC: static imports
+          2. STANDARD_JAVA_PACKAGE: standard java/javax imports
+          3. SPECIAL_IMPORTS: defined as org imports
+          4. THIRD_PARTY_PACKAGE: defined as com imports
+        -->
+        <module name="CustomImportOrder">
+            <property name="customImportOrderRules"
+                      value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
+            <property name="specialImportsRegExp" value="^org\."/>
+            <property name="thirdPartyPackageRegExp" value="^com\."/>
+            <property name="sortImportsInGroupAlphabetically" value="true"/>
+        </module>
+
         <!-- Checks for redundant import statements.
         An import statement is redundant if:
           * It is a duplicate of another import. This is, when a class is imported more than once.
@@ -68,6 +83,12 @@
         NAMING CHECKS
         -->
 
+        <!-- Validate abbreviations (consecutive capital letters) length in identifier name -->
+        <module name="AbbreviationAsWordInName">
+            <property name="ignoreFinal" value="false"/>
+            <property name="allowedAbbreviationLength" value="1"/>
+        </module>
+
         <module name="PackageName">
             <!-- Validates identifiers for package names against the supplied expression. -->
             <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$"/>
@@ -167,13 +188,10 @@
         <module name="NeedBraces">
             <!--
             if (true) return 1; // Not allowed
-
             if (true) { return 1; } // Not allowed
-
             else if {
               return 1; // else if should always be multi line
             }
-
             if (true)
               return 1; // Not allowed
             -->
@@ -200,6 +218,13 @@
 
         <module name="MissingSwitchDefault"/>
 
+        <!-- Checks that Class variables should never be declared public. -->
+        <module name="VisibilityModifier">
+            <property name="protectedAllowed" value="true"/>
+            <property name="allowPublicFinalFields" value="true"/>
+            <property name="ignoreAnnotationCanonicalNames" value="RegisterExtension, TempDir"/>
+        </module>
+
         <!--
         ORDER CHECKS
         -->
@@ -237,13 +262,120 @@
         <!-- Checks that comments are indented relative to their position in the code -->
         <module name="CommentsIndentation"/>
 
+        <module name="WhitespaceAround">
+            <!-- Checks that various tokens are surrounded by whitespace.
+                 This includes most binary operators and keywords followed
+                 by regular or curly braces.
+            -->
+            <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR,
+        BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,
+        EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
+        LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
+        LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS,
+        MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION,
+        RCURLY, SL, SLIST, SL_ASSIGN, SR_ASSIGN, STAR, STAR_ASSIGN"/>
+            <!-- Allow empty constructors e.g. MyClass() {} -->
+            <property name="allowEmptyConstructors" value="true" />
+            <!-- Allow empty methods e.g. void func() {} -->
+            <property name="allowEmptyMethods" value="true" />
+            <!-- Allow empty types e.g. class Foo {}, enum Foo {} -->
+            <property name="allowEmptyTypes" value="true" />
+            <!-- Allow empty loops e.g. for (int i = 1; i > 1; i++) {} -->
+            <property name="allowEmptyLoops" value="true" />
+            <!-- Allow empty lambdas e.g. () -> {} -->
+            <property name="allowEmptyLambdas" value="true" />
+        </module>
+
+        <module name="WhitespaceAfter">
+            <!-- Checks that commas, semicolons and typecasts are followed by whitespace. -->
+            <property name="tokens" value="COMMA, SEMI, TYPECAST"/>
+        </module>
+
+        <module name="NoWhitespaceAfter">
+            <!-- Checks that there is no whitespace after various unary operators. Linebreaks are allowed. -->
+            <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS,
+        UNARY_PLUS"/>
+            <property name="allowLineBreaks" value="true"/>
+        </module>
+
+        <!-- No trailing whitespace -->
+        <module name="Regexp">
+            <property name="format" value="[ \t]+$"/>
+            <property name="illegalPattern" value="true"/>
+            <property name="message" value="Trailing whitespace"/>
+        </module>
+
+        <module name="OperatorWrap">
+            <!-- Checks that the non-assignment type operator is at the next line in a line wrap.
+                 This includes "?", ":", "==", "!=", "/", "+", "-", "*", "%", ">>", ">>>",
+                 ">=", ">", "<<", "<=", "<", "^", "|", "||", "&", "&&", "instanceof",
+                 "&" when used in a generic upper or lower bounds constraints,
+                   e.g. <T extends Foo & Bar>
+                 "::" when used as a reference to a method or constructor without arguments.
+                   e.g. String::compareToIgnoreCase
+            -->
+            <property name="tokens" value="QUESTION, COLON, EQUAL, NOT_EQUAL, DIV, PLUS, MINUS, STAR, MOD, SR, BSR,
+        GE, GT, SL, LE, LT, BXOR, BOR, LOR, BAND, LAND, LITERAL_INSTANCEOF, TYPE_EXTENSION_AND, METHOD_REF"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="OperatorWrap">
+            <!-- Checks that the assignment type operator is at the previous end of line in a line wrap.
+                 This includes "=", "/=", "+=", "-=", "*=", "%=", ">>=", ">>>=", "<<=", "^=", "&=".
+            -->
+            <property name="tokens" value="ASSIGN, DIV_ASSIGN, PLUS_ASSIGN, MINUS_ASSIGN, STAR_ASSIGN, MOD_ASSIGN,
+        SR_ASSIGN, BSR_ASSIGN, SL_ASSIGN, BXOR_ASSIGN, BOR_ASSIGN, BAND_ASSIGN"/>
+            <property name="option" value="eol"/>
+        </module>
+
+        <module name="SeparatorWrap">
+            <!-- Checks that the ".", "@" is at the next line in a line wrap. -->
+            <property name="tokens" value="DOT, AT"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SeparatorWrap">
+            <!-- Checks that the ",", "]", "[", "...", ";", "(" is at the previous end of line in a line wrap. -->
+            <property name="tokens" value="COMMA, RBRACK, ARRAY_DECLARATOR, ELLIPSIS, SEMI, LPAREN"/>
+            <property name="option" value="eol"/>
+        </module>
+
         <module name="Indentation">
             <property name="caseIndent" value="0" />
             <property name="throwsIndent" value="8" />
         </module>
 
+        <module name="NoWhitespaceBefore">
+            <!-- Checks that there is no whitespace before various unary operators. Linebreaks are allowed. -->
+            <property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
+            <property name="allowLineBreaks" value="true"/>
+        </module>
+
         <module name="NoWhitespaceBeforeCaseDefaultColon"/>
 
+        <!-- Checks that there is no whitespace between method/constructor name and open parenthesis. -->
+        <module name="MethodParamPad"/>
+
+        <module name="ParenPad">
+            <!-- Checks that there is no whitespace before close parenthesis or after open parenthesis. -->
+            <property name="severity" value="warning"/>
+        </module>
+
+        <!-- Checks that non-whitespace characters are separated by no more than one whitespace character.
+             a = 1; // Allowed
+             a  = 1; // Not allowed (more than one space before =)
+        -->
+        <module name="SingleSpaceSeparator">
+            <!-- Validate whitespace surrounding comments as well.
+                 a = 1; // Allowed (single space before start of comment)
+                 a = 1; /* Allowed (single space before start of comment) */
+                 /* Allowed (single space after end of comment) */ a = 1;
+                 a = 1;  // Not allowed (more than one space before start of comment)
+                 a = 1;  /* Not allowed (more than one space before start of comment) */
+                 /* Not allowed (more than one space after end of comment) */  a = 1;
+                 This doesn't validate whitespace within comments so a comment /* like  this */ is allowed.
+            -->
+            <property name="validateComments" value="true"/>
+        </module>
+
         <!--
         JAVADOC CHECKS
         -->
@@ -271,7 +403,7 @@
             <property name="allowMissingParamTags" value="true"/>
         </module>
 
-        <!-- Checks the Javadoc's format for every method (excluding getters, setters and constructors). -->
+        <!-- Checks the Javadoc's format for every public method (excluding getters, setters and constructors). -->
         <module name="JavadocMethod">
             <property name="allowedAnnotations" value="Override, Test, BeforeAll, BeforeEach, AfterAll, AfterEach, Subscribe"/>
             <property name="accessModifiers" value="public"/>
@@ -283,5 +415,15 @@
 
         <module name="InvalidJavadocPosition"/>
 
+        <!-- Checks that every public method (excluding getters, setters and constructors) has a header comment. -->
+        <module name="MissingJavadocMethodCheck">
+            <property name="minLineCount" value="1"/>
+            <property name="allowMissingPropertyJavadoc" value="true"/>
+            <property name="ignoreMethodNamesRegex" value="(set.*|get.*)"/>
+        </module>
+
+        <!-- Checks that every public class, enumeration and interface has a header comment. -->
+        <module name="MissingJavadocType"/>
+
     </module>
-</module>
+</module>