[CS2103-W14-3]: ConText

.github/auto_assign.yml

@@ -0,0 +1,37 @@
+# https://probot.github.io/apps/auto-assign/
+
+
+
+# Set to true to add reviewers to PRs
+addReviewers: true
+
+# List of reviewers to add to PRs (GitHub username)
+reviewers:
+  - bwangpj
+  - Cloud7050
+  - mamayuan
+  - rayshawntan
+
+# Number of reviewers to randomly add to PRs.
+# Set 0 to add all reviewers.
+# Defaults to 0
+# numberOfReviewers: 0
+
+# Set to true to add assignees to PRs
+# addAssignees: true
+
+# List of assignees to add to PRs (GitHub username).
+# Presumably takes priority over reviewers, for usernames set in both
+# assignees:
+#   - assigneeA
+#   - assigneeB
+#   - assigneeC
+
+# Number of assignees to randomly add to PRs.
+# Set to 0 to add all assignees.
+# Defaults to numberOfReviewers
+# numberOfAssignees: 0
+
+# Keywords used to decide whether to skip all adding for a PR
+skipKeywords:
+  - no-assign

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+[Enter your description here...]
+
+[Closes #0.]
+
+(Please remember to assign the appropriate milestone, via the sidebar at the bottom right. This will allow your PR to be counted by the grading scripts (https://nus-cs2103-ay2324s1.github.io/dashboards/contents/tp-progress.html). Feel free to delete this message when done.)

.gitignore

@@ -1,23 +1,24 @@
-# Gradle build files
-/.gradle/
-/build/
-src/main/resources/docs/
+# macOS Finder files
+.DS_Store
 
 # IDEA files
 /.idea/
 /out/
 /*.iml
 
-# Storage/log files
+# VSCode extension build files
+/bin/
+
+# JVM crash logs
+/hs_err_pid[0-9]*.log
+
+# Gradle build files
+/.gradle/
+/build/
+/src/main/resources/docs/
+
+# App data/log files
 /data/
 /config.json
-/preferences.json
+/settings.json
 /*.log.*
-hs_err_pid[0-9]*.log
-
-# Test sandbox files
-src/test/data/sandbox/
-
-# MacOS custom attributes files created by Finder
-.DS_Store
-docs/_site/

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "editor.detectIndentation": false,
+    "editor.insertSpaces": true
+}

README.md

@@ -1,14 +1,10 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
-
-![Ui](docs/images/Ui.png)
-
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+# ConText
+
+[![Java CI](https://github.com/AY2324S1-CS2103-W14-3/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2324S1-CS2103-W14-3/tp/actions/workflows/gradle.yml)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103-W14-3/tp/graph/badge.svg?token=KT7MNHKALX)](https://codecov.io/gh/AY2324S1-CS2103-W14-3/tp)
+
+For information as well as detailed user/developer documentation, check out the [product website](https://ay2324s1-cs2103-w14-3.github.io/tp/).
+
+![UI](./docs/images/Ui.png)
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -1,23 +1,76 @@
 plugins {
-    id 'java'
-    id 'checkstyle'
-    id 'com.github.johnrengelman.shadow' version '7.1.2'
+    // application includes java
     id 'application'
+    id 'checkstyle'
+
     id 'jacoco'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
 }
 
-mainClassName = 'seedu.address.Main'
-
-sourceCompatibility = JavaVersion.VERSION_11
-targetCompatibility = JavaVersion.VERSION_11
-
 repositories {
     mavenCentral()
-    maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
-checkstyle {
-    toolVersion = '10.2'
+dependencies {
+    String versionJUnit = '5.10.0'
+    /* NOTE
+     * Upgrading Jackson to 2.15.2 causes some tests to fail, as saving Config's
+     * Path results in a full path instead of the original relative one.
+    */
+    String versionJackson = '2.7.0'
+    /* NOTE
+     * We stay on JavaFX 17 instead of 21, for better Java 11 compatibility in
+     * general.
+     *
+     * The documentation states that Java 17 is required for either, but Gluon's
+     * download page states otherwise:
+     * • https://openjfx.io/openjfx-docs/
+     * • https://gluonhq.com/products/javafx/
+    */
+    String versionJavaFx = '17.0.9'
+
+    implementation group: 'org.openjfx', name: 'javafx-base', version: versionJavaFx, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: versionJavaFx, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: versionJavaFx, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: versionJavaFx, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: versionJavaFx, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: versionJavaFx, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: versionJavaFx, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: versionJavaFx, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: versionJavaFx, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: versionJavaFx, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: versionJavaFx, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: versionJavaFx, classifier: 'linux'
+
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: versionJackson
+    implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: versionJackson
+
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: versionJUnit
+    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: versionJUnit
+}
+
+
+
+// https://docs.gradle.org/current/userguide/img/javaPluginTasks.png
+defaultTasks 'clean', 'test'
+
+java {
+    // targetCompatibility also defaults to sourceCompatibility
+    sourceCompatibility JavaVersion.VERSION_11
+}
+
+application {
+    mainClass = 'swe.context.Main'
+}
+
+clean {
+    delete './data/'
+    delete './settings.json'
+    delete fileTree('./') { include '*.log.*' }
+}
+
+run {
+    enableAssertions true
 }
 
 test {
@@ -26,6 +79,11 @@ test {
 }
 
 task coverage(type: JacocoReport) {
+    // "Task ':coverage' uses this output of task ':test' without declaring an
+    // explicit or implicit dependency. This can lead to incorrect results being
+    // produced, depending on what order the tasks are executed."
+    dependsOn test
+
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
     executionData.from files(jacocoTestReport.executionData)
@@ -40,33 +98,10 @@ task coverage(type: JacocoReport) {
     }
 }
 
-dependencies {
-    String jUnitVersion = '5.4.0'
-    String javaFxVersion = '17.0.7'
-
-    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
-    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
-    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
-    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
-    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
-    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
-    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
-    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
-    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
-    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
-    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
-    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
-
-    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
-    implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
-
-    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
-
-    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+checkstyle {
+    toolVersion = '10.2'
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'context.jar'
 }
-
-defaultTasks 'clean', 'test'