Migrate to JSONC

NullDev · Jul 14, 2024 · 83b33cb · 83b33cb
1 parent dcf0f0e
commit 83b33cb
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 108 deletions.
diff --git a/.github/config.json b/.github/config.json
@@ -1,4 +1,5 @@
 {
+    // This file supports comments and trailing commas
     "auth": {
         "clientId": "<CLIENT_ID>",
         "token": "<BOT_TOKEN>"
@@ -7,16 +8,19 @@
         "dsn": null
     },
     "activity": {
+        // https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
         "type": 0,
         "name": "Die Jungs von der CSZ sind mir heilig."
     },
     "prefix": {
+        // You may want to choose a prefix that does not collide with others on the test server
         "command": ".",
         "modCommand": "~"
     },
     "moderatorRoleIds": [
         "893179190709477413"
     ],
+
     "command": {
         "faulenzerPing": {
             "allowedRoleIds": [],

diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+@jsr:registry=https://npm.jsr.io
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -9,6 +9,9 @@
     "files.eol": "\n",
     "cSpell.language": "de,en",
     "editor.formatOnSaveMode": "modificationsIfAvailable",
+    "files.associations": {
+        "config*.json": "jsonc"
+    },
     "[javascript]": {
         "editor.defaultFormatter": "biomejs.biome"
     },

diff --git a/README.md b/README.md
@@ -62,6 +62,7 @@ bun i
 cp config.template.json config.json
 $EDITOR config.json
 ```
+Hinweis: Die Datei kann Kommentare und Trailing-Commas (JSONC). Wenn du nicht VSCode verwendest, musst du das ggf. noch einstellen.
 2. Das Template ist für die [Coding-Test-Zentrale](https://discord.gg/ekJA6GA3BJ) vorausgefüllt. Es fehlen noch:
     - Um einen Bot zum Testen anzulegen, einfach den Instruktionen im [Discord Developer Portal](https://discord.com/developers/applications) folgen.
         - Die Applikation muss als "Bot" gesetzt werden.

diff --git a/bun.lockb b/bun.lockb
diff --git a/config.new.jsonc b/config.new.jsonc
diff --git a/config.template.json b/config.template.json
@@ -1,4 +1,5 @@
 {
+    // This file supports comments and trailing commas
     "auth": {
         "clientId": "<CLIENT_ID>",
         "token": "<BOT_TOKEN>"
@@ -7,16 +8,19 @@
         "dsn": null
     },
     "activity": {
+        // https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
         "type": 0,
         "name": "Hi!"
     },
     "prefix": {
+        // You may want to choose a prefix that does not collide with others on the test server
         "command": "xd",
         "modCommand": "yd"
     },
     "moderatorRoleIds": [
         "893179190709477413"
     ],
+
     "command": {
         "faulenzerPing": {
             "allowedRoleIds": [],

diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
     "@napi-rs/canvas": "^0.1.53",
     "@resvg/resvg-js": "^2.6.2",
     "@sentry/bun": "^8.17.0",
+    "@std/jsonc": "npm:@jsr/std__jsonc@^1.0.0-rc.2",
     "chrono-node": "^2.7.6",
     "croner": "^8.1.0",
     "discord.js": "^14.15.3",

diff --git a/src/service/configService.ts b/src/service/configService.ts
@@ -2,6 +2,8 @@ import * as fs from "node:fs/promises";
 import * as path from "node:path";
 import { parseArgs } from "node:util";
 
+import * as JSONC from "@std/jsonc";
+
 import type { Snowflake, ActivityType } from "discord.js";
 
 import log from "@log";
@@ -27,7 +29,7 @@ export async function readConfig() {
     }
 
     try {
-        return JSON.parse(jsonString) as Config;
+        return JSONC.parse(jsonString) as unknown as Config;
     } catch (e) {
         log.error(e, "Config is not valid JSON. Stopping...");
         return process.exit(1);