Add option to explicitly include components

Author: michael-kenzel

README.md

@@ -67,19 +67,23 @@ Secrets and other bot info must be configured in the `config.json` file. An exam
   "id": "<bot id>",
   "guild": "<guild id>",
   "token": "<discord api token>",
-  "mom": "<your user id>", // to be pinged when things go wrong
+  "mom": "<your user id>",  // to be pinged when things go wrong
   "mongo": {
     "user": "wheatley",
     "password": "<mongo password>",
-    "host": "127.0.0.1", // optional
-    "port": 27017 // optional
+    "host": "127.0.0.1",    // optional
+    "port": 27017           // optional
   },
-  "freestanding": false, // optional,
-  "exclude": [
-    // optional
-    "components/shortcuts.js",
-    "modules/tccpp/components/april1/**"
-  ]
+  "freestanding": false,    // optional,
+  "components": {           // optional
+    "exclude": [            // optional, specify patterns of components to exclude
+      "components/shortcuts.js",
+      "modules/tccpp/components/**"
+    ],
+    "include": [            // optional, explicitly specify components to load
+      "modules/tccpp/components/cppref.js"
+    ]
+  }
 }
 ```
 

config.default.json

@@ -10,7 +10,9 @@
         "port": 27017
     },
     "freestanding": true,
-    "exclude": [
-        "modules/tccpp/components/april1/**"
-    ]
+    "components": {
+        "exclude": [
+            "modules/tccpp/components/april1/**"
+        ]
+    }
 }

package-lock.json

@@ -20,6 +20,7 @@
         "gray-matter": "^4.0.3",
         "moment": "^2.30.1",
         "mongodb": "^6.16.0",
+        "path-scurry": "^2.0.0",
         "prom-client": "^15.1.3",
         "stack-trace": "^1.0.0-pre2",
         "typescript": "^5.8.3",

package.json

@@ -8,7 +8,8 @@ import PromClient from "prom-client";
 import { colors, MINUTE } from "./common.js";
 import { unwrap } from "./utils/misc.js";
 import { to_string, is_string } from "./utils/strings.js";
-import { globIterate } from "glob";
+import { globIterateSync } from "glob";
+import { PathScurry } from "path-scurry";
 import { M } from "./utils/debugging-and-logging.js";
 import { BotComponent } from "./bot-component.js";
 
@@ -53,7 +54,10 @@ type core_config = {
     mom?: string;
     mongo?: wheatley_database_credentials;
     freestanding?: boolean;
-    exclude?: string[];
+    components?: {
+        exclude?: string[];
+        include?: string[];
+    };
     sentry?: string;
     metrics?: {
         port: number;
@@ -324,6 +328,30 @@ export class Wheatley {
         this.setup(config).catch(this.critical_error.bind(this));
     }
 
+    private *locate_components(config: core_config) {
+        const visited = config.components?.include ? new Set<string>() : undefined;
+
+        const pw = new PathScurry(import.meta.dirname);
+
+        for (const file of globIterateSync("**/components/**/*.js", {
+            ignore: config.components?.exclude,
+            scurry: pw,
+            withFileTypes: true,
+        })) {
+            yield file.relativePosix();
+            visited?.add(file.fullpath());
+        }
+
+        if (config.components?.include) {
+            for (const file of config.components.include) {
+                const path = pw.resolve(file);
+                if (!visited!.has(path)) {
+                    yield file;
+                }
+            }
+        }
+    }
+
     async setup(config: core_config) {
         assert(this.freestanding || config.mongo, "Missing MongoDB credentials");
         if (config.mongo) {
@@ -368,10 +396,7 @@ export class Wheatley {
             })().catch(this.critical_error.bind(this));
         });
 
-        for await (const file of globIterate("**/components/**/*.js", {
-            ignore: config.exclude,
-            cwd: import.meta.dirname,
-        })) {
+        for (const file of this.locate_components(config)) {
             const default_export = (await import(`./${file}`)).default;
             if (default_export !== undefined) {
                 await this.add_component(default_export);