Update

Author: mxmadr

.gitignore

@@ -7,6 +7,7 @@ package-lock.json
 
 # IDE directory
 .idea
+.vscode
 
 # Test
 coverage

.gitlab-ci.yml

@@ -16,77 +16,77 @@ variables:
 # Application building
 
 building:
-   stage: build
-   only:
-     - master # Restricts the building to the master branch.
-     - develop # Restricts the building to the develop branch.
-   script:
-     - echo "--Building--"
+  stage: build
+  only:
+    - master # Restricts the building to the master branch.
+    - develop # Restricts the building to the develop branch.
+  script:
+    - echo "--Building--"
 
-     # npm
+    # npm
 
-     - npm install # Installs the dependencies.
+    - npm install # Installs the dependencies.
 
-     # Swagger
+    # Swagger
 
-     - npm run swagger # Generates the application documentation (Swagger).
+    - npm run swagger # Generates the application documentation (Swagger).
 
-     # CodeQL: Directories
+    # CodeQL: Directories
 
-     - New-Item -Name "lib" -ItemType "directory" # Creates the lib directory.
-     - cd lib
-     - New-Item -Name "codeql-cli" -ItemType "directory" # Creates the codeql-cli directory.
-     - New-Item -Name "codeql-lib" -ItemType "directory" # Creates the codeql-lib directory.
-     - cd ..
+    - New-Item -Name "lib" -ItemType "directory" # Creates the lib directory.
+    - cd lib
+    - New-Item -Name "codeql-cli" -ItemType "directory" # Creates the codeql-cli directory.
+    - New-Item -Name "codeql-lib" -ItemType "directory" # Creates the codeql-lib directory.
+    - cd ..
 
-     # CodeQL: CLI
+    # CodeQL: CLI
 
-     - git clone git@gitlab.unamur.be:denim/codeql-cli-2.13.0.git lib/codeql-cli # Downloads the CodeQL CLI.
-     - '& ${env:ProgramFiles}\7-Zip\7z.exe x -olib/codeql-cli lib/codeql-cli/codeql-cli.zip' # Unzips the CodeQL CLI.
-     - Remove-Item -Path lib/codeql-cli/codeql-cli.zip
-     #- Move-Item -Path ${env:ProgramFiles}/codeql/codeql-cli -Destination lib/codeql-cli # CodeQL CLI moving to right folder.
+    - git clone git@gitlab.unamur.be:denim/codeql-cli-2.13.0.git lib/codeql-cli # Downloads the CodeQL CLI.
+    - '& ${env:ProgramFiles}\7-Zip\7z.exe x -olib/codeql-cli lib/codeql-cli/codeql-cli.zip' # Unzips the CodeQL CLI.
+    - Remove-Item -Path lib/codeql-cli/codeql-cli.zip
+    #- Move-Item -Path ${env:ProgramFiles}/codeql/codeql-cli -Destination lib/codeql-cli # CodeQL CLI moving to right folder.
 
-     # CodeQL: libraries
+    # CodeQL: libraries
 
-     - git clone git@gitlab.unamur.be:denim/codeql-lib-2.13.0.git lib/codeql-lib # Downloads the CodeQL CLI.
-     - '& ${env:ProgramFiles}\7-Zip\7z.exe x -olib/codeql-lib lib/codeql-lib/codeql-lib.zip' # Unzips the CodeQL CLI.
-     - Remove-Item -Path lib/codeql-lib/codeql-lib.zip
-     #- Move-Item -Path ${env:ProgramFiles}/codeql/codeql-lib -Destination lib/codeql-lib # CodeQL CLI moving to right folder.
+    - git clone git@gitlab.unamur.be:denim/codeql-lib-2.13.0.git lib/codeql-lib # Downloads the CodeQL CLI.
+    - '& ${env:ProgramFiles}\7-Zip\7z.exe x -olib/codeql-lib lib/codeql-lib/codeql-lib.zip' # Unzips the CodeQL CLI.
+    - Remove-Item -Path lib/codeql-lib/codeql-lib.zip
+    #- Move-Item -Path ${env:ProgramFiles}/codeql/codeql-lib -Destination lib/codeql-lib # CodeQL CLI moving to right folder.
 
-     # Environment variables
+    # Environment variables
 
-     - New-Item -Name ".env" -ItemType "file" # Creates the environment variables file.
-     - Add-Content .env 'FILE_SYSTEM_SEPARATOR="\"' # Adds the file system separator environment variable for Windows.
-     - New-Item -Name "TEMP" -ItemType "directory" # Creates the temporary working directory for analysis files.
+    - New-Item -Name ".env" -ItemType "file" # Creates the environment variables file.
+    - Add-Content .env 'FILE_SYSTEM_SEPARATOR="\"' # Adds the file system separator environment variable for Windows.
+    - New-Item -Name "TEMP" -ItemType "directory" # Creates the temporary working directory for analysis files.
 
 # Unit testing
 
 unit-testing:
-   stage: test
-   only:
-     - master # Restricts the unit testing to the master branch.
-     - develop # Restricts the unit testing to the develop branch.
-   variables:
-     GIT_STRATEGY: none # Skips the 'git fetch'.
-   script:
-     - echo "--Unit testing--"
-     - npm run test_unit # Starts the unit testing.
+  stage: test
+  only:
+    - master # Restricts the unit testing to the master branch.
+    - develop # Restricts the unit testing to the develop branch.
+  variables:
+    GIT_STRATEGY: none # Skips the 'git fetch'.
+  script:
+    - echo "--Unit testing--"
+    - npm run test_unit # Starts the unit testing.
 
 # Integration testing
 
 integration-testing:
-   stage: test
-   only:
-     - master # Restricts the integration testing to the master branch.
-     - develop # Restricts the unit testing to the develop branch.
-   variables:
-     GIT_STRATEGY: none # Skips the 'git fetch'.
-   needs: [ unit-testing ]
-   script:
-     - echo "--Integration testing--"
-     - Set-Content .env 'FILE_SYSTEM_SEPARATOR="/"' # Sets the file system separator environment variable for Linux.
-     - docker-compose up -d # Sets up and starts the docker container via docker-compose started in background.
-     - npm run test_integration # Launches the integration testing.
+  stage: test
+  only:
+    - master # Restricts the integration testing to the master branch.
+    - develop # Restricts the unit testing to the develop branch.
+  variables:
+    GIT_STRATEGY: none # Skips the 'git fetch'.
+  needs: [unit-testing]
+  script:
+    - echo "--Integration testing--"
+    - Set-Content .env 'FILE_SYSTEM_SEPARATOR="/"' # Sets the file system separator environment variable for Linux.
+    - docker-compose up -d # Sets up and starts the docker container via docker-compose started in background.
+    - npm run test_integration # Launches the integration testing.
 
 # Application deployment
 
@@ -119,4 +119,4 @@ cleaning:
     - docker rmi $(docker images -a -q) # Removes ALL the images on the host machine runner.
     - New-Item -Path ../ -Name "empty" -ItemType "directory" # Creates an empty folder for file deletion.
     - robocopy ../empty ./ /MIR; if ($lastexitcode -lt 8) { $global:LASTEXITCODE = $null } # Removes ALL the source files on the host machine runner.
-    - rm ..\empty\
+    - rm ..\empty\

.prettierignore

@@ -0,0 +1,10 @@
+node_modules
+evaluation
+coverage
+lib
+.vscode
+.idea
+
+package-lock.json
+yarn.lock
+.env

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none"
+}

INSTALL.md

@@ -5,11 +5,14 @@
 ### Prerequisites
 
 1. NodeJS:
-  - [Install NodeJS](https://nodejs.org/fr/download).
+
+- [Install NodeJS](https://nodejs.org/fr/download).
+
 2. Docker:
-  - Linux : [Install Docker Engine](https://docs.docker.com/engine/install/) or [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/linux/).
-  - Windows : [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/).
-  - MacOS : [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/).
+
+- Linux : [Install Docker Engine](https://docs.docker.com/engine/install/) or [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/linux/).
+- Windows : [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/).
+- MacOS : [Install Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/).
 
 ### Launching
 
@@ -21,13 +24,14 @@ You have the tree following options.
 
 #### Launching from source code
 
-- [Download the last CodeQL CLI 2.13.0 binaries zip file](https://github.com/github/codeql-cli-binaries/releases)
-  and extract it at `/lib/codeql-cli`).
+- Create the `/lib` directory and then the `/lib/codeql-cli` and `/lib/codeql-lib` directories.
 
-- [Download last CodeQL 2.13.0 libraries](https://github.com/github/codeql) and extract them next to CodeQL CLI at
-  `/lib/codeql-lib`).
+- [Download the last CodeQL CLI 2.13.0 binaries zip file](https://github.com/github/codeql-cli-binaries/releases) and extract it at `/lib/codeql-cli`.
+
+- [Download last CodeQL 2.13.0 libraries](https://github.com/github/codeql) and extract them next to CodeQL CLI at `/lib/codeql-lib`.
 
 - Open the project in an IDE and install the dependencies.
+
   ```shell
   npm install
   ```
@@ -39,10 +43,12 @@ You have the tree following options.
   ```
 
 - Create an `.env` file with the following content.
+
   ```shell
   # Windows
   FILE_SYSTEM_SEPARATOR="\"
   ```
+
   ```shell
   # Linux
   FILE_SYSTEM_SEPARATOR="/"
@@ -59,13 +65,14 @@ The app runs at [http://localhost:3000](http://localhost:3000).
 
 #### Launching from source code with Docker
 
-- [Download the last CodeQL CLI 2.13.0 binaries zip file](https://github.com/github/codeql-cli-binaries/releases)
-  and extract it at `/lib/codeql-cli`).
+- Create the `/lib` directory and then the `/lib/codeql-cli` and `/lib/codeql-lib` directories.
+
+- [Download the last CodeQL CLI 2.13.0 binaries zip file](https://github.com/github/codeql-cli-binaries/releases) and extract it at `/lib/codeql-cli`.
 
-- [Download last CodeQL 2.13.0 libraries](https://github.com/github/codeql) and extract them next to CodeQL CLI at
-  `/lib/codeql-lib`).
+- [Download last CodeQL 2.13.0 libraries](https://github.com/github/codeql) and extract them next to CodeQL CLI at `/lib/codeql-lib`.
 
 - Open the project in an IDE and install the dependencies.
+
   ```shell
   npm install
   ```
@@ -77,10 +84,12 @@ The app runs at [http://localhost:3000](http://localhost:3000).
   ```
 
 - Create an `.env` file with the following content.
+
   ```shell
   # Windows
   FILE_SYSTEM_SEPARATOR="\"
   ```
+
   ```shell
   # Linux
   FILE_SYSTEM_SEPARATOR="/"
@@ -98,5 +107,5 @@ A `docker-compose.yml` file also exists at the root in order to launch easily a
   docker-compose up
   ```
 
-Warning! This command must be executed at the location of the `docker-compose.yml` file and have to be run as with the
-right privileges (administrator).
+⚠️ This command must be executed at the location of the `docker-compose.yml` file and have to be run as with the
+right privileges (administrator).