Implement one stop config file v2

.gitignore

@@ -8,6 +8,7 @@
 *.tmp
 
 ft_temp/
+rc_temp/
 /target/
 .gradle/
 build/

config/report-config.yaml

@@ -0,0 +1 @@
+title: RepoSense Report

docs/_markbind/layouts/ug-sitenav.md

@@ -6,6 +6,7 @@
   {name: "Sharing reports", link: "ug/sharingReports.html"},
   {name: "Appendices"},
   {level: 2, name: "CLI syntax reference", link: "ug/cli.html"},
+  {level: 2, name: "Getting started with `report-config.yaml`", link: "ug/reportConfig.html"},
   {level: 2, name: "Config files format", link: "ug/configFiles.html"},
   {level: 2, name: "Advanced syntax: `author-config.csv`", link: "ug/authorConfigSyntax.html"},
   {level: 2, name: "Using `@@author` tags", link: "ug/usingAuthorTags.html"},

docs/dg/cli.md

@@ -17,7 +17,7 @@ syntax reference under Appendix section of User Guide.
 
 <box type="info" seamless>
 
-* Used in `ConfigSystemTest`.
+* Used in `ConfigSystemTest` and `ReportConfigSystemTest`.
 * Some test cases performs shallow cloning while some does not. Fresh cloning ensures that the test cases that does
 not perform shallow cloning will clone the repo again if the previous test case uses shallow cloning, ensuring
 correctness of the analysis.

docs/ug/cli.md

@@ -68,14 +68,15 @@ partial credit.
 <div id="section-config">
 
 **`--config CONFIG_DIRECTORY`**: Specifies that config files located in `CONFIG_DIRECTORY` should be used to customize the report.
-* Parameter: `CONFIG_DIRECTORY` The directory containing the config files. Should contain a `repo-config.csv` file. Optionally, can contain an `author-config.csv` file or/and a `group-config.csv` file or/and a `report-config.json` file or/and a `blurbs.md` file.
+* Parameter: `CONFIG_DIRECTORY` The directory containing the config files. Should contain a `repo-config.csv` file or/and a `report-config.yaml` file. Optionally, can contain an `author-config.csv` file or/and a `group-config.csv` file or/and a `blurbs.md` file.
 * Alias: `-c`
 * Example: `java -jar RepoSense.jar --config  ./config`
 
 <box type="info" seamless>
 
 * Cannot be used with `--repos`. The `--repos` flag will take precedence over this flag.
 * If both `--repos` and `--config` are not specified, RepoSense looks for config files in the `./config` directory.
+* If both `repo-config.csv` and `report-config.yaml` are present in the config file, `report-config.yaml` will take precedence over **all CSV files** as long as the `repos` field is correctly formatted.
 * Config files must follow [this](./configFiles.html) format.
 </box>
 </div>
@@ -253,6 +254,8 @@ Cannot be used with `--last-modified-date`. This may result in an incorrect last
 
 ### `--since`, `-s`
 
+<div id="section-since-date">
+
 **`--since START_DATE`**: Specifies the start date for the period to be analyzed.
 * Parameter: `START_DATE` The first day of the period to be analyzed (with optional time specification), in one of the following formats:<br>
   ```
@@ -272,6 +275,7 @@ Cannot be used with `--last-modified-date`. This may result in an incorrect last
 * If `d1` is specified as the start date (`--since d1` or `-s d1`), then the program will search for the earliest commit date of all repositories and use that as the start date.
 * If `d1` is specified together with `--period`, then the program will warn that the date range being analyzed may be incorrect.
 </box>
+</div>
 
 <!-- ------------------------------------------------------------------------------------------------------ -->
 
@@ -301,6 +305,8 @@ Cannot be used with `--last-modified-date`. This may result in an incorrect last
 
 ### `--until`, `-u`
 
+<div id="section-until-date">
+
 **`--until END_DATE`**: Specifies the end date of the analysis period.
 * Parameter: `END_DATE` The last date of the period to be analyzed (with optional time specification), in one of the following formats:<br>
   ```
@@ -318,6 +324,7 @@ Default:
 
 Note: If the end date is not specified, the date of generating the report will be taken as the end date.
 </box>
+</div>
 
 <!-- ------------------------------------------------------------------------------------------------------ -->
 

docs/ug/configFiles.md

@@ -46,7 +46,7 @@ Given below are the details of the various config files used by RepoSense.
 | Ignore File Size Limit                | Enter **`yes`** to ignore both the default file size limit and the file size limit possibly set by the user in `repo-config.csv`.                                                                                                                                                                                                                       |
 | Skip Ignored File Analysis            | Enter **`yes`** to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.                                                                                                |
 | Since Date                            | Enter since date in the format of `yyyy/mm/dd` to signify the start date of analysis. If the field is ignored, the date will be set to the default one or the date indicated in CLI flags                                                                                                                                                               |
-| Until Date                            | Enter since date in the format of `yyyy/mm/dd` to signify the end date of analysis. If the field is ignored, the date will be set to the default one or the date indicated in CLI flags                                                                                                                                                                 |
+| Until Date                            | Enter until date in the format of `yyyy/mm/dd` to signify the end date of analysis. If the field is ignored, the date will be set to the default one or the date indicated in CLI flags                                                                                                                                                                 |
 
 <box type="info" seamless>
 The Shallow Cloning option is incompatible with the "--last-modified-date" CLI flag.
@@ -98,11 +98,11 @@ If `author-config.csv` is not given and the repo has not provided author details
 
 Optionally, you can provide a `group-config.csv`(which should be in the same directory as `repo-config.csv` file) to provide details on any custom groupings for files in specified repositories ([example](group-config.csv)). It should contain the following columns:
 
-| Column Name | Explanation |
-|-------------|-------------|
-| Repository's Location | Same as `repo-config.csv`. Default: all the repos in `repo-config.csv` |
-| Group Name {{ mandatory }} | Name of the group, e.g.,`test`. |
-| Globs * {{ mandatory }} | The list of file path globs to include for specified group, e.g.,`**/test/*;**.java`. |
+| Column Name                | Explanation                                                                           |
+|----------------------------|---------------------------------------------------------------------------------------|
+| Repository's Location      | Same as `repo-config.csv`. Default: all the repos in `repo-config.csv`                |
+| Group Name {{ mandatory }} | Name of the group, e.g.,`test`.                                                       |
+| Globs * {{ mandatory }}    | The list of file path globs to include for specified group, e.g.,`**/test/*;**.java`. |
 
 <sup>* **Multi-value column**: multiple values can be entered in this column using a semicolon `;` as the separator.</sup>
 
@@ -111,12 +111,12 @@ e.g.: `example.java` in `example-repo` can either be in the `test` group or the
 
 <!-- ==================================================================================================== -->
 
-## `report-config.json`
+## `report-config.yaml`
 
-You can optionally use `report-config.json` to customize report generation by providing the following information. ([example](report-config.json))
+You can also optionally use a `report-config.yaml` file to quickly define the repository information for the repositories you are interested in tracking and generating your very own code portfolio.
+The configurations of this file will override the CSV files if the `repos` field of the file is present and correctly formatted.
 
-**Fields to provide**:
-* `title`: Title of the generated report, which is also the title of the deployed dashboard. Default: "RepoSense Report"
+Please refer to this [guide](./reportConfig.html#advanced-report-configuration).
 
 <!-- ==================================================================================================== -->
 

docs/ug/customizingReports.md

@@ -15,6 +15,21 @@ The report can be customized using several ways, as explained below.
 
 <!-- ------------------------------------------------------------------------------------------------------ -->
 
+### Configuration Options Overview
+
+RepoSense offers multiple ways to customize your reports, with varying levels of complexity and flexibility:
+
+1. **CLI flags** - The simplest, most direct approach for basic customization
+2. **report-config.yaml** - A user-friendly single file for typical use cases
+3. **CSV config files** - A more powerful option with granular control for advanced scenarios
+
+When deciding which configuration method to use:
+- **CLI flags** are ideal for quick, one-off reports with minimal customization.
+- **report-config.yaml** is recommended for most users as it provides a good balance of usability and features in a single file.
+- **CSV config files** offer the most flexibility for complex scenarios, such as managing large teams or requiring fine-grained control.
+
+<!-- ------------------------------------------------------------------------------------------------------ -->
+
 ### Customize using CLI flags
 
 **The simplest approach is to provide additional flags when running RepoSense.** The various flags are given in the panel below.
@@ -23,9 +38,20 @@ The report can be customized using several ways, as explained below.
 
 <!-- ------------------------------------------------------------------------------------------------------ -->
 
+### Customize using report-config.yaml
+
+**The `report-config.yaml` file provides a more user-friendly way for users to customize their reports in more detail compared to the CLI flags.**
+
+Please refer to this [page](./reportConfig.html) to get started.
+
+Note that configurations in `report-config.yaml` will override the configurations in the CSV config files when both are present.
+<!-- ------------------------------------------------------------------------------------------------------ -->
+
 ### Customize using CSV config files
 
-**Another, more powerful, way to customize the report is by using dedicated config files.** In this case you need to use the `--config` flag instead of the `--repo` flag when running RepoSense, as follows:
+**Another, more powerful, way to customize the report is by using dedicated config files.** You can refer to this [section](./configFiles.html) to find out more about the CSV file formats.
+
+In this case you need to use the `--config` flag instead of the `--repo` flag when running RepoSense, as follows:
 
   {{ embed("Appendix: **CLI syntax reference → `config` flag**", "cli.md#section-config") }}