feat(gource): commits tree visualisation with gource (#14)

README.md

@@ -16,8 +16,9 @@
 2. 🔨 [Installation](#installation)
 3. 💯 [Tests](#tests)
 4. ☑️ [Code analysis and consistency](#code-analysis-and-consistency)
-5. ©️ [License](#license)
-6. ❤️ [Contributors](#contributors)
+5. ✨ [Misc commands](#misc-commands)
+6. ©️ [License](#license)
+7. ❤️ [Contributors](#contributors)
 
 ## <a name="what-is-this-api">🐺 What is this API ?</a>
 Werewolves Assistant API provides over HTTP requests a way of manage Werewolves games to help the game master.
@@ -102,6 +103,14 @@ npm run lint
 npm run lint:fix
 ```
 
+## <a name="misc-commands">✨ Misc commands</a>
+
+### 🌳 Animated tree visualisation of the project's evolution with [Gource](https://gource.io/)
+```shell
+# Please ensure that `gource` is installed on your system.
+npm run gource
+```
+
 ## <a name="license">©️ License</a>
 
 This project is licensed under the [MIT License](http://opensource.org/licenses/MIT).

config/gource/gource.config

@@ -0,0 +1,11 @@
+[display]
+viewport=1920x1080
+high-dpi=true
+
+[gource]
+auto-skip-seconds=0.001
+time-scale=2
+title=Werewolves Assistant API
+date-format=%d/%m/%Y
+user-image-dir=./config/gource/assets/images/users
+user-filter=(Antoine ZANARDI)

package.json

@@ -22,15 +22,16 @@
     "test:watch": "NODE_ENV=test jest --watch --config config/jest/jest-global.ts",
     "test:cov": "NODE_ENV=test jest --coverage --config config/jest/jest-global.ts",
     "test:stryker": "NODE_ENV=test rimraf tests/stryker/coverage && stryker run config/stryker/stryker.conf.json",
-    "test:stryker:force": "NODE_ENV=test rimraf tests/stryker/incremental.json && rimraf tests/stryker/coverage && stryker run config/stryker/stryker.conf.json --force",
+    "test:stryker:force": "NODE_ENV=test rimraf tests/stryker/incremental.json tests/stryker/coverage && stryker run config/stryker/stryker.conf.json --force",
     "test:unit": "NODE_ENV=test jest --config config/jest/jest-unit.ts",
     "test:unit:watch": "NODE_ENV=test jest --watch --detectOpenHandles --config config/jest/jest-unit.ts",
     "test:unit:cov": "NODE_ENV=test rimraf tests/unit/coverage && jest --coverage --config config/jest/jest-unit.ts --logHeapUsage",
     "test:unit:debug": "NODE_ENV=test node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand --config tests/unit/jest-unit.ts",
     "test:e2e": "NODE_ENV=test jest --config config/jest/jest-e2e.ts",
     "test:e2e:watch": "NODE_ENV=test jest --watch --config config/jest/jest-e2e.ts",
     "test:e2e:cov": "NODE_ENV=test rimraf tests/e2e/coverage && jest --coverage --config config/jest/jest-e2e.ts",
-    "test:e2e:debug": "NODE_ENV=test node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand --config config/jest/jest-e2e.ts"
+    "test:e2e:debug": "NODE_ENV=test node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand --config config/jest/jest-e2e.ts",
+    "gource": "gource --load-config config/gource/gource.config"
   },
   "repository": {
     "type": "git",
@@ -54,7 +55,7 @@
     "@nestjs/terminus": "^9.2.1",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
-    "mongoose": "^6.10.1",
+    "mongoose": "^6.10.2",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.0"
   },
@@ -84,7 +85,7 @@
     "jest": "^29.5.0",
     "jest-when": "^3.5.2",
     "lint-staged": "^13.1.2",
-    "rimraf": "^4.3.1",
+    "rimraf": "^4.4.0",
     "semantic-release": "^20.1.1",
     "source-map-support": "^0.5.20",
     "ts-jest": "^29.0.5",