@moonlight-mod/esbuild-config 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright © 2025 moonlight contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# `@moonlight-mod/esbuild-config`
+
+A simple and effective `esbuild` configuration for moonlight extensions and builds.

package/dist/factory.d.ts

@@ -0,0 +1,63 @@
+import fs from "node:fs";
+import type { Plugin, BuildResult, BuildOptions } from "esbuild";
+import betterLogging from "./plugins/betterLogging.js";
+import webpackImports from "./plugins/webpackImports.js";
+declare const sides: readonly ["index", "webpackModules", "node", "host"];
+export interface ESBuildFactoryOptions {
+    /**
+     * The name of your extension.
+     * @remarks This is used for logging purposes, and should match the ID in your `manifest.json` file.
+     */
+    ext: string;
+    /**
+     * The input directory containing your extension's source (e.g. `./src`).
+     * @remarks If you use moonlight's `create-extension`, this is automatically generated.
+     */
+    entry: string;
+    /**
+     * The input directory containing your extension's source (e.g. `./src`).
+     * @remarks If you use moonlight's `create-extension`, this is automatically generated.
+     * @deprecated Use {@link entry} instead. This will be removed in a major version.
+     */
+    src: string;
+    /**
+     * The output directory containing your compiled extension (e.g. `./dist`).
+     * @remarks If you use moonlight's `create-extension`, this is automatically generated.
+     */
+    output: string;
+    /**
+     * The output directory containing your compiled extension (e.g. `./dist`).
+     * @remarks If you use moonlight's `create-extension`, this is automatically generated.
+     * @deprecated Use {@link output} instead. This will be removed in a major version.
+     */
+    dst: string;
+    /**
+     * A string determining what target to compile your extension to.
+     * @remarks In utility functions other than {@link defineConfig}, this is automatically generated.
+     */
+    side: typeof sides[number];
+    /**
+     * A list of extra "external" dependencies, (i.e., dependencies that the
+     * {@link side}'s runtime already provides and thus doesn't need to be bundled)
+     */
+    extraExternal?: string[];
+    /**
+     * A list of extra ESBuild {@link Plugin}s to be applied after the default ones.
+     */
+    extraPlugins?: Plugin[];
+    /**
+     * Extra {@link BuildOptions} to append to the finalized ESBuild config.
+     * Alternatively, you can destructure {@link defineConfig} and override default options.
+     */
+    extraConfig?: BuildOptions;
+    /**
+     * Whether or not to compile the extension's main entrypoint (e.g.`index.ts`) to ESM.
+     * @remarks Note that this doesn't compile webpackModules to ESM.
+     */
+    esm?: boolean;
+}
+export declare function defineConfig(options: ESBuildFactoryOptions): BuildOptions | null;
+export declare function defineConfigs(options: Omit<ESBuildFactoryOptions, "side">): BuildOptions[];
+export declare function buildExtension(options: Omit<ESBuildFactoryOptions, "side">): Promise<BuildResult[]>;
+export declare function watchExtension(options: Omit<ESBuildFactoryOptions, "side">): Promise<fs.FSWatcher[]>;
+export { defineConfig as makeExtConfig, defineConfigs as makeExtConfigs, buildExtension as buildExt, watchExtension as watchExt, betterLogging as deduplicatedLogging, webpackImports as wpImport, };

package/dist/factory.js

@@ -0,0 +1,105 @@
+import fs from "node:fs";
+import path from "node:path";
+import { build, context } from "esbuild";
+import betterLogging from "./plugins/betterLogging.js";
+import webpackImports from "./plugins/webpackImports.js";
+import copyFile from "./plugins/copyFile.js";
+const prod = process.env.NODE_ENV === "production";
+const external = [
+    "electron",
+    "fs",
+    "path",
+    "module",
+    "events",
+    "original-fs",
+    "discord" // mappings
+];
+const sides = ["index", "webpackModules", "node", "host"];
+const fileExts = ["js", "jsx", "ts", "tsx"];
+export function defineConfig(options) {
+    const entry = options.entry ?? options.src;
+    const output = options.output ?? options.dst;
+    const { ext, side, extraExternal = [], extraPlugins = [], extraConfig = {}, esm = false } = options;
+    const entryPoints = [];
+    if (side !== "webpackModules") {
+        for (const fileExt of fileExts) {
+            const filePath = path.join(entry, `${side}.${fileExt}`);
+            if (fs.existsSync(filePath))
+                entryPoints.push(filePath);
+        }
+    }
+    const wpModulesDir = path.join(entry, "webpackModules");
+    if (side === "webpackModules" && fs.existsSync(wpModulesDir)) {
+        const wpModules = fs.readdirSync(wpModulesDir);
+        for (const wpModule of wpModules) {
+            if (fs.statSync(path.join(wpModulesDir, wpModule)).isDirectory()) {
+                for (const fileExt of fileExts) {
+                    const filePath = path.join(wpModulesDir, wpModule, `index.${fileExt}`);
+                    if (fs.existsSync(filePath))
+                        entryPoints.push({
+                            in: filePath,
+                            out: wpModule
+                        });
+                }
+            }
+            else {
+                entryPoints.push(path.join(wpModulesDir, wpModule));
+            }
+        }
+    }
+    if (entryPoints.length === 0)
+        return null;
+    return {
+        entryPoints: entryPoints,
+        outdir: side === "webpackModules" ? path.join(output, "webpackModules") : output,
+        format: esm && side === "index" ? "esm" : "iife",
+        globalName: "module.exports",
+        platform: ["index", "webpackModules"].includes(side) ? "browser" : "node",
+        treeShaking: true,
+        bundle: true,
+        minify: prod,
+        sourcemap: "inline",
+        external: [...external, ...extraExternal],
+        plugins: [
+            copyFile(path.join(entry, "manifest.json"), path.join(output, "manifest.json")),
+            copyFile(path.join(entry, "style.css"), path.join(output, "style.css")),
+            webpackImports,
+            betterLogging(`${ext}/${side}`),
+            ...extraPlugins
+        ],
+        ...extraConfig
+    };
+}
+export function defineConfigs(options) {
+    return sides
+        .map((side) => defineConfig({ ...options, side }))
+        .filter((config) => config != null);
+}
+export async function buildExtension(options) {
+    const configs = defineConfigs(options);
+    const builds = [];
+    configs.forEach(async (config) => builds.push(await build(config)));
+    return builds;
+}
+export async function watchExtension(options) {
+    const buildConfigs = defineConfigs(options);
+    const watchers = [];
+    for (const config of buildConfigs) {
+        const ctx = await context(config);
+        async function rebuild() {
+            try {
+                await ctx.rebuild();
+            }
+            catch {
+                // esbuild will log errors, we just need to not do anything
+            }
+        }
+        await rebuild();
+        const watcher = fs.watch(options.entry, { recursive: true }, async () => await rebuild());
+        watchers.push(watcher);
+    }
+    return watchers;
+}
+// In GitHub PR #3, these original names were modified to be more descriptive.
+// We re-export these as to not break backwards compatibility with older plugins.
+export { defineConfig as makeExtConfig, defineConfigs as makeExtConfigs, buildExtension as buildExt, watchExtension as watchExt, betterLogging as deduplicatedLogging, webpackImports as wpImport, };

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./factory.js";
+export * from "./plugins/index.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./factory.js";
+export * from "./plugins/index.js";

package/dist/plugins/betterLogging.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from "esbuild";
+export declare const betterLogging: (tag: string) => Plugin;
+export default betterLogging;

package/dist/plugins/betterLogging.js

@@ -0,0 +1,31 @@
+import { formatMessages } from "esbuild";
+const lastMessages = new Set();
+const timeFormatter = new Intl.DateTimeFormat(undefined, {
+    hour: "numeric",
+    minute: "numeric",
+    second: "numeric",
+    hour12: false
+});
+export const betterLogging = (tag) => ({
+    name: "better-logging",
+    setup(build) {
+        build.onStart(() => lastMessages.clear());
+        build.onEnd(async (result) => {
+            const formatted = await Promise.all([
+                formatMessages(result.warnings, {
+                    kind: "warning",
+                    color: true
+                }),
+                formatMessages(result.errors, { kind: "error", color: true }),
+            ]).then((a) => a.flat());
+            for (const message of formatted) {
+                if (lastMessages.has(message))
+                    continue;
+                lastMessages.add(message);
+                console.log(message.trim());
+            }
+            console.log(`[${timeFormatter.format(new Date())}] [${tag}] build finished`);
+        });
+    }
+});
+export default betterLogging;

package/dist/plugins/copyFile.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from "esbuild";
+export declare const copyFile: (src: string, dest: string) => Plugin;
+export default copyFile;

package/dist/plugins/copyFile.js

@@ -0,0 +1,14 @@
+import fs from "node:fs";
+import path from "node:path";
+export const copyFile = (src, dest) => ({
+    name: "copy-files",
+    setup: build => build.onEnd(() => {
+        if (!fs.existsSync(src))
+            return;
+        const dir = path.dirname(dest);
+        if (!fs.existsSync(dir))
+            fs.mkdirSync(dir, { recursive: true });
+        fs.copyFileSync(src, dest);
+    }),
+});
+export default copyFile;

package/dist/plugins/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./betterLogging.js";
+export * from "./copyFile.js";
+export * from "./webpackImports.js";

package/dist/plugins/index.js

@@ -0,0 +1,3 @@
+export * from "./betterLogging.js";
+export * from "./copyFile.js";
+export * from "./webpackImports.js";

package/dist/plugins/webpackImports.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from "esbuild";
+declare const webpackImports: Plugin;
+export default webpackImports;

package/dist/plugins/webpackImports.js

@@ -0,0 +1,8 @@
+const webpackImports = {
+    name: "webpack-imports",
+    setup: build => build.onResolve({ filter: /^@moonlight-mod\/wp\// }, args => ({
+        path: args.path.replace(/^@moonlight-mod\/wp\//, ""),
+        external: true
+    })),
+};
+export default webpackImports;

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/factory.ts","../src/index.ts","../src/plugins/betterLogging.ts","../src/plugins/copyFile.ts","../src/plugins/index.ts","../src/plugins/webpackImports.ts"],"version":"5.8.3"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@moonlight-mod/esbuild-config",
+  "version": "1.0.0",
+  "type": "module",
+  "private": false,
+  "description": "Yet another Discord mod's shared esbuild config",
+  "license": "MIT",
+  "homepage": "https://moonlight-mod.github.io/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moonlight-mod/esbuild-config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/moonlight-mod/esbuild-config/issues"
+  },
+  "engines": {
+    "node": ">=22",
+    "pnpm": ">=10",
+    "npm": "pnpm",
+    "yarn": "pnpm"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^22.14.0",
+    "prettier": "^3.4.2",
+    "esbuild": "^0.25.2",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "esbuild": ">= 0.19"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "pnpm build --clean"
+  }
+}