chore(grabber): add more comments in config.example.yml

Author: SilentDepth

config.example.yml

@@ -1,28 +1,56 @@
-# NyaaStats configuration
-web:
-  title: Nyaa Stats # website title
-  servername: Minecraft Server # Server Name
-  homepage: https://minecraft.example.com # Your homepage
+# NYAA-STATS CONFIGURATION FILE
 
+# Grabber (main program) configuration
 render:
-  crafatar: https://crafatar.com # crafatar service host, required
-  level: data/level.dat # file path here, required
-  playerdata: data/playerdata # directory path here, required
-  stats: data/stats # directory path here, required
-  advancements: data/advancements # advancements path here, required
-  whitelist: whitelist.json # file path here, leave blank to disable
-  banned-players: banned-players.json # file path here, leave blank to disable
-  render-banned: false  # do not render banned players
-  output: web/public/data # directory path here, required
+  # Data sources
+
+  # [Required] `level.dat` file path. Example: "/opt/minecraft/world/level.dat"
+  level: data/level.dat
+  # [Required] `playerdata` directory path. Example: "/opt/minecraft/world/playerdata"
+  playerdata: data/playerdata
+  # [Required] `stats` directory path. Example: "/opt/minecraft/world/stats"
+  stats: data/stats
+  # [Required] `advancements` directory path. Example: "/opt/minecraft/world/advancements"
+  advancements: data/advancements
+  # Whether to only process whitelisted players. Possible values:
+  #   {string} - `whitelist.json` file path. Example: "/opt/minecraft/whitelist.json"
+  #   (unset)  - Disable this feature (to process all reachable players)
+  whitelist: whitelist.json
+  # Banned UUID list. Possible values:
+  #   {string} - `banned-players.json` file path. Example: "/opt/minecraft/banned-players.json"
+  #   (unset)  - Disable this feature (to assume no bans)
+  banned-players: banned-players.json
+  # Whether to render banned players. Default value: `false`
+  render-banned: false
+  # [Required] Crafatar service URL, used for player avatar/skin model generating
+  crafatar: https://crafatar.com
+
+  # Output
+
+  # [Required] Output data directory path (absolute or relative to runtime `config.yml`)
+  # Example: "webroot/data"
+  output: web/public/data
+  # Whether to prompt confirmation to clear output directory. You may want to set `false` if you're
+  # using cronjob. Possible values:
+  #   `true` | (unset) - Prompt confirmation. You can choose yes or no to output directory clearing
+  #   `false`          - Disable this feature (will not clear output directory)
+  confirm-clear-data: true
+  # [Deprecated]
   time-format: # time format on display, details http://momentjs.com/docs/#/displaying/format/
     full: dddd, MMMM Do, YYYY HH:mm:ss ZZ
     short: MMMM Do, YYYY
     compact: YYYY-M-D HH:mm:ss
-  # prompt confirmation to remove old data.
-  # Set to false if you are using cronjob,
-  # true when you run it manually.
-  # data directory will be cleared when manipulating new data.
-  confirm-clear-data: true
 
+# API usage configuration
 api:
-  ratelimit: 2 # set to 1 request per sec as per mojang api rate limit
+  # [Required] Mojang API request rate limit (N req per second)
+  ratelimit: 2
+
+# Web app configuration
+web:
+  # [Required] Web app title, will be displayed at page header and as window title
+  title: Nyaa Stats
+  # [Required] Server name, will be displayed at welcome section and page footer
+  servername: Minecraft Server
+  # [Required] Server homepage URL, will be displayed at welcome section
+  homepage: https://minecraft.example.com

types/nyaa-stats.d.ts

@@ -10,9 +10,9 @@ interface NSConfig {
     playerdata: string
     stats: string
     advancements: string
-    whitelist: string
-    'banned-players': string
-    'render-banned': boolean
+    whitelist?: string
+    'banned-players'?: string
+    'render-banned'?: boolean
     output: string
     'time-format': {
       full: string

utils.ts

@@ -63,15 +63,17 @@ export default class Utils {
 
   getWhitelistedPlayers (): LongUuid[] {
     const uuids: LongUuid[] = []
-    JSON.parse(fs.readFileSync(this.config.render.whitelist, 'utf8')).forEach((p: McWhitelistRecord) => {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    JSON.parse(fs.readFileSync(this.config.render.whitelist!, 'utf8')).forEach((p: McWhitelistRecord) => {
       uuids.push(p.uuid)
     })
     return uuids
   }
 
   getBannedPlayers (): LongUuid[] {
     const banlist: LongUuid[] = []
-    const banned = JSON.parse(fs.readFileSync(path.join(this.config.render['banned-players']), 'utf8')) as McBannedPlayersJson
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const banned = JSON.parse(fs.readFileSync(path.join(this.config.render['banned-players']!), 'utf8')) as McBannedPlayersJson
     banned.forEach((ban) => {
       banlist.push(ban.uuid)
     })
@@ -259,9 +261,9 @@ export default class Utils {
     let data
     try {
       if (fs.existsSync(path.join(playerpath, 'stats.json'))) {
-          data = JSON.parse(fs.readFileSync(path.join(playerpath, 'stats.json'), 'utf-8'))
+        data = JSON.parse(fs.readFileSync(path.join(playerpath, 'stats.json'), 'utf-8'))
       } else {
-          data = await this.getPlayerTotalData(uuid)
+        data = await this.getPlayerTotalData(uuid)
       }
     } catch (error) {
       throw new Error(error)