feat(blazebuild): buildSrc plugins

Author: virtual-designer

blazebuild/src/main/typescript/plugins/BlazePlugin.ts

@@ -0,0 +1,11 @@
+import type Blaze from "../core/Blaze";
+import type AbstractTask from "../tasks/AbstractTask";
+import type { Awaitable } from "../types/utils";
+
+abstract class BlazePlugin {
+    public constructor(protected readonly blaze: Blaze) {}
+    public abstract boot(): Awaitable<void>;
+    public tasks?(): Awaitable<Iterable<new (blaze: Blaze) => AbstractTask>>;
+}
+
+export default BlazePlugin;

blazebuild/src/main/typescript/script/BuildScriptManager.ts

@@ -1,8 +1,11 @@
-import { lstat } from "fs/promises";
+import { existsSync } from "fs";
+import { lstat, readdir } from "fs/promises";
 import path from "path";
+import type Blaze from "../core/Blaze";
 import Manager from "../core/Manager";
 import MissingBuildScriptError from "../errors/MissingBuildScriptError";
-import { println } from "../io/IO";
+import IO, { println } from "../io/IO";
+import type BlazePlugin from "../plugins/BlazePlugin";
 
 export const BUILD_SCRIPT_PATH = "build.blaze.ts";
 
@@ -31,6 +34,7 @@ class BuildScriptManager extends Manager {
         }
 
         await this.setupEnvironment(global as Record<string, unknown>);
+        await this.loadBuildSrc();
         await import(buildScriptPath);
     }
 
@@ -40,6 +44,43 @@ class BuildScriptManager extends Manager {
         global.blaze = this.blaze;
         global.println = println;
     }
+
+    private async loadBuildSrc() {
+        const buildSrcPath = path.resolve(process.cwd(), "build_src/src/main/typescript");
+
+        if (!existsSync(buildSrcPath)) {
+            return;
+        }
+
+        const files = await readdir(buildSrcPath);
+        let pluginPath: string | undefined;
+
+        for (const file of files) {
+            const resolved = path.resolve(buildSrcPath, file);
+
+            if (file.endsWith("Plugin.ts") && (await lstat(resolved)).isFile()) {
+                pluginPath = resolved;
+                break;
+            }
+        }
+
+        if (!pluginPath) {
+            IO.fatal("No plugin found in build_src!");
+        }
+
+        // HACK: This is a dummy implementation of plugin loading.
+        const { default: Plugin }: { default: new (blaze: Blaze) => BlazePlugin } = await import(
+            pluginPath
+        );
+        const plugin = new Plugin(this.blaze);
+        await plugin.boot();
+
+        if (plugin.tasks) {
+            for (const task of await plugin.tasks()) {
+                this.blaze.taskManager.register(task);
+            }
+        }
+    }
 }
 
 export default BuildScriptManager;

build.blaze.ts

@@ -1,29 +1,8 @@
-import CleanTask from "@buildSrc/tasks/CleanTask";
-import CompileTask from "@buildSrc/tasks/CompileTask";
-import CompileTypeScriptTask from "@buildSrc/tasks/CompileTypeScriptTask";
-import DependenciesTask from "@buildSrc/tasks/DependenciesTask";
-import LintTask from "@buildSrc/tasks/LintTask";
-import ProcessCoverageReportsTask from "@buildSrc/tasks/ProcessCoverageReportsTask";
-import RunTask from "@buildSrc/tasks/RunTask";
-import TestTask from "@buildSrc/tasks/TestTask";
+import "blazebuild";
 
 project.name = "sudobot";
 project.version = "1.0.0";
 project.description = "Sudobot. A Discord moderation bot.";
 project.structure.sourcesRootDirectory = "src";
 project.structure.sourceModules = ["main", "framework"];
 project.structure.testsDirectory = "test";
-
-tasks.register(DependenciesTask);
-tasks.register(CleanTask);
-tasks.register(CompileTypeScriptTask);
-tasks.register(CompileTask);
-tasks.register(TestTask);
-tasks.register(LintTask);
-tasks.register(ProcessCoverageReportsTask);
-tasks.register(RunTask);
-
-tasks.named("build", {
-    dependsOn: ["compile", "lint", "test"],
-    outputs: [project.structure.buildOutputDirectory],
-});

build_src/src/main/typescript/BuildPlugin.ts

@@ -0,0 +1,34 @@
+import { Awaitable } from "blazebuild";
+import BlazePlugin from "blazebuild/src/main/typescript/plugins/BlazePlugin";
+import CleanTask from "./tasks/CleanTask";
+import CompileTask from "./tasks/CompileTask";
+import CompileTypeScriptTask from "./tasks/CompileTypeScriptTask";
+import DependenciesTask from "./tasks/DependenciesTask";
+import LintTask from "./tasks/LintTask";
+import ProcessCoverageReportsTask from "./tasks/ProcessCoverageReportsTask";
+import RunTask from "./tasks/RunTask";
+import TestTask from "./tasks/TestTask";
+
+class BuildPlugin extends BlazePlugin {
+    public override boot(): Awaitable<void> {
+        this.blaze.taskManager.named("build", {
+            dependsOn: ["compile", "lint", "test"],
+            outputs: [this.blaze.projectManager.properties.structure?.buildOutputDirectory ?? ""]
+        });
+    }
+
+    public override tasks() {
+        return [
+            CleanTask,
+            CompileTask,
+            CompileTypeScriptTask,
+            DependenciesTask,
+            LintTask,
+            ProcessCoverageReportsTask,
+            RunTask,
+            TestTask
+        ];
+    }
+}
+
+export default BuildPlugin;