@steambrew/ttc 3.0.1 → 3.1.1

package/.claude/settings.local.json

@@ -3,7 +3,8 @@
     "allow": [
       "Bash(npm show:*)",
       "Bash(bun remove:*)",
-      "Bash(bun run:*)"
+      "Bash(bun run:*)",
+      "Bash(node:*)"
     ]
   }
 }

package/dist/index.js

@@ -13,18 +13,18 @@ import terser from '@rollup/plugin-terser';
 import typescript from '@rollup/plugin-typescript';
 import url from '@rollup/plugin-url';
 import nodePolyfills from 'rollup-plugin-polyfill-node';
-import { rollup } from 'rollup';
+import { watch, rollup } from 'rollup';
 import { minify_sync } from 'terser';
 import scss from 'rollup-plugin-scss';
 import * as sass from 'sass';
 import dotenv from 'dotenv';
 import injectProcessEnv from 'rollup-plugin-inject-process-env';
+import { performance } from 'perf_hooks';
 import * as parser from '@babel/parser';
 import { createFilter } from '@rollup/pluginutils';
 import * as glob from 'glob';
 import MagicString from 'magic-string';
 import _traverse from '@babel/traverse';
-import { performance as performance$1 } from 'perf_hooks';
 
 const version = JSON.parse(readFileSync(path.resolve(dirname(fileURLToPath(import.meta.url)), '../package.json'), 'utf8')).version;
 const Logger = {
@@ -59,6 +59,10 @@ const Logger = {
             meta.push(`${envCount} env var${envCount > 1 ? 's' : ''}`);
         console.log(`${chalk.green('Finished')} ${buildType} in ${elapsed} ` + chalk.dim('(' + meta.join(', ') + ')'));
     },
+    failed({ elapsedMs, buildType }) {
+        const elapsed = `${(elapsedMs / 1000).toFixed(2)}s`;
+        console.error(`${chalk.red('Failed')} ${buildType} in ${elapsed} ` + chalk.dim(`(ttc v${version})`));
+    },
 };
 
 const PrintParamHelp = () => {
@@ -69,6 +73,7 @@ const PrintParamHelp = () => {
         'options:',
         '  --build <dev|prod>   build type (prod enables minification)',
         '  --target <path>      plugin directory (default: current directory)',
+        '  --watch              enable watch mode for continuous rebuilding',
         '  --no-update          skip update check',
         '  --help               show this message',
         '',
@@ -80,7 +85,7 @@ var BuildType;
     BuildType[BuildType["ProdBuild"] = 1] = "ProdBuild";
 })(BuildType || (BuildType = {}));
 const ValidateParameters = (args) => {
-    let typeProp = BuildType.DevBuild, targetProp = process.cwd(), isMillennium = false;
+    let typeProp = BuildType.DevBuild, targetProp = process.cwd(), isMillennium = false, watch = false;
     if (args.includes('--help')) {
         PrintParamHelp();
         process.exit();
@@ -116,11 +121,15 @@ const ValidateParameters = (args) => {
         if (args[i] == '--millennium-internal') {
             isMillennium = true;
         }
+        if (args[i] === '--watch') {
+            watch = true;
+        }
     }
     return {
         type: typeProp,
         targetPlugin: targetProp,
-        isMillennium: isMillennium,
+        isMillennium,
+        watch,
     };
 };
 
@@ -415,6 +424,7 @@ function constSysfsExpr(options = {}) {
                                             fileName: path.relative(searchBasePath, singleFilePath),
                                         };
                                         embeddedContent = JSON.stringify(fileInfo);
+                                        this.addWatchFile(singleFilePath);
                                     }
                                     catch (fileError) {
                                         let message = String(fileError instanceof Error ? fileError.message : fileError ?? 'Unknown file read error');
@@ -438,6 +448,7 @@ function constSysfsExpr(options = {}) {
                                                 filePath: fullPath,
                                                 fileName: path.relative(searchBasePath, fullPath),
                                             });
+                                            this.addWatchFile(fullPath);
                                         }
                                         catch (fileError) {
                                             let message = String(fileError instanceof Error ? fileError.message : fileError ?? 'Unknown file read error');
@@ -554,6 +565,8 @@ function stripPluginPrefix(message) {
     message = message.replace(/^@?[\w-]+\/[\w-]+\s+/, '');
     return message;
 }
+class BuildFailedError extends Error {
+}
 class MillenniumBuild {
     isExternal(id) {
         const hint = this.forbidden.get(id);
@@ -563,6 +576,25 @@ class MillenniumBuild {
         }
         return this.externals.has(id);
     }
+    async watchConfig(input, sysfsPlugin, isMillennium) {
+        return {
+            input,
+            plugins: await this.plugins(sysfsPlugin),
+            onwarn: (warning) => {
+                const msg = stripPluginPrefix(warning.message);
+                const loc = logLocation(warning);
+                if (warning.plugin === 'typescript') {
+                    Logger.error(msg, loc);
+                }
+                else {
+                    Logger.warn(msg, loc);
+                }
+            },
+            context: 'window',
+            external: (id) => this.isExternal(id),
+            output: this.output(isMillennium),
+        };
+    }
     async build(input, sysfsPlugin, isMillennium) {
         let hasErrors = false;
         const config = {
@@ -585,7 +617,7 @@ class MillenniumBuild {
         };
         await (await rollup(config)).write(config.output);
         if (hasErrors)
-            process.exit(1);
+            throw new BuildFailedError();
     }
 }
 class FrontendBuild extends MillenniumBuild {
@@ -679,10 +711,47 @@ class WebkitBuild extends MillenniumBuild {
         };
     }
 }
-const TranspilerPluginComponent = async (isMillennium, pluginJson, props) => {
+function RunWatchMode(frontendConfig, webkitConfig) {
+    const configs = webkitConfig ? [frontendConfig, webkitConfig] : [frontendConfig];
+    const watcher = watch(configs);
+    console.log(chalk.blueBright.bold('watch'), 'watching for file changes...');
+    watcher.on('event', async (event) => {
+        if (event.code === 'BUNDLE_START') {
+            const label = event.output.some((f) => f.includes('index.js')) ? 'frontend' : 'webkit';
+            console.log(chalk.yellowBright.bold('watch'), `rebuilding ${label}...`);
+        }
+        else if (event.code === 'BUNDLE_END') {
+            const label = event.output.some((f) => f.includes('index.js')) ? 'frontend' : 'webkit';
+            console.log(chalk.greenBright.bold('watch'), `${label} built in ${chalk.green(`${event.duration}ms`)}`);
+            await event.result.close();
+        }
+        else if (event.code === 'ERROR') {
+            const err = event.error;
+            const msg = stripPluginPrefix(err?.message ?? String(err));
+            Logger.error(msg, logLocation(err));
+            if (event.result)
+                await event.result.close();
+        }
+    });
+    const shutdown = () => {
+        console.log(chalk.yellowBright.bold('watch'), 'stopping...');
+        watcher.close();
+        process.exit(0);
+    };
+    process.on('SIGINT', shutdown);
+    process.on('SIGUSR2', shutdown);
+}
+const TranspilerPluginComponent = async (pluginJson, props) => {
     const webkitDir = './webkit/index.tsx';
     const frontendDir = getFrontendDir(pluginJson);
     const sysfs = constSysfsExpr();
+    const isMillennium = props.isMillennium ?? false;
+    if (props.watch) {
+        const frontendConfig = await new FrontendBuild(frontendDir, props).watchConfig(resolveEntryFile(frontendDir), sysfs.plugin, isMillennium);
+        const webkitConfig = fs.existsSync(webkitDir) ? await new WebkitBuild(props).watchConfig(webkitDir, sysfs.plugin, isMillennium) : null;
+        RunWatchMode(frontendConfig, webkitConfig);
+        return;
+    }
     try {
         await new FrontendBuild(frontendDir, props).build(resolveEntryFile(frontendDir), sysfs.plugin, isMillennium);
         if (fs.existsSync(webkitDir)) {
@@ -696,7 +765,10 @@ const TranspilerPluginComponent = async (isMillennium, pluginJson, props) => {
         });
     }
     catch (exception) {
-        Logger.error(stripPluginPrefix(exception?.message ?? String(exception)), logLocation(exception));
+        if (!(exception instanceof BuildFailedError)) {
+            Logger.error(stripPluginPrefix(exception?.message ?? String(exception)), logLocation(exception));
+        }
+        Logger.failed({ elapsedMs: performance.now() - global.PerfStartTime, buildType: props.minify ? 'prod' : 'dev' });
         process.exit(1);
     }
 };
@@ -717,16 +789,18 @@ const StartCompilerModule = () => {
         .then((json) => {
         const props = {
             minify: bTersePlugin,
-            pluginName: json?.name,
+            pluginName: json.name,
+            watch: parameters.watch || false,
+            isMillennium: bIsMillennium,
         };
-        TranspilerPluginComponent(bIsMillennium, json, props);
+        TranspilerPluginComponent(json, props);
     })
         .catch(() => {
         process.exit();
     });
 };
 const Initialize = () => {
-    global.PerfStartTime = performance$1.now();
+    global.PerfStartTime = performance.now();
     // Check for --no-update flag
     if (process.argv.includes('--no-update')) {
         StartCompilerModule();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@steambrew/ttc",
-  "version": "3.0.1",
+  "version": "3.1.1",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -9,6 +9,7 @@
   },
   "scripts": {
     "build": "rollup -c",
+    "dev": "rollup -c -w",
     "prepare": "bun run build"
   },
   "publishConfig": {

package/src/check-health.ts

@@ -1,9 +1,10 @@
 import path from 'path';
 import { existsSync, readFile } from 'fs';
 import { Logger } from './logger';
+import { PluginJson } from './plugin-json';
 
-export const ValidatePlugin = (bIsMillennium: boolean, target: string): Promise<any> => {
-	return new Promise<any>((resolve, reject) => {
+export const ValidatePlugin = (bIsMillennium: boolean, target: string): Promise<PluginJson> => {
+	return new Promise<PluginJson>((resolve, reject) => {
 		if (!existsSync(target)) {
 			Logger.error(`target path does not exist: ${target}`);
 			reject();

package/src/index.ts

@@ -8,6 +8,7 @@
 import { BuildType, ValidateParameters } from './query-parser';
 import { CheckForUpdates } from './version-control';
 import { ValidatePlugin } from './check-health';
+import { PluginJson } from './plugin-json';
 import { TranspilerPluginComponent, TranspilerProps } from './transpiler';
 import { performance } from 'perf_hooks';
 
@@ -25,13 +26,15 @@ const StartCompilerModule = () => {
 	const bTersePlugin = parameters.type == BuildType.ProdBuild;
 
 	ValidatePlugin(bIsMillennium, parameters.targetPlugin)
-		.then((json: any) => {
+		.then((json: PluginJson) => {
 			const props: TranspilerProps = {
 				minify: bTersePlugin,
-				pluginName: json?.name,
+				pluginName: json.name,
+				watch: parameters.watch || false,
+				isMillennium: bIsMillennium,
 			};
 
-			TranspilerPluginComponent(bIsMillennium, json, props);
+			TranspilerPluginComponent(json, props);
 		})
 		.catch(() => {
 			process.exit();

package/src/logger.ts

@@ -44,6 +44,11 @@ const Logger = {
 		if (envCount) meta.push(`${envCount} env var${envCount > 1 ? 's' : ''}`);
 		console.log(`${chalk.green('Finished')} ${buildType} in ${elapsed} ` + chalk.dim('(' + meta.join(', ') + ')'));
 	},
+
+	failed({ elapsedMs, buildType }: Pick<DoneOptions, 'elapsedMs' | 'buildType'>) {
+		const elapsed = `${(elapsedMs / 1000).toFixed(2)}s`;
+		console.error(`${chalk.red('Failed')} ${buildType} in ${elapsed} ` + chalk.dim(`(ttc v${version})`));
+	},
 };
 
 export { Logger };

package/src/plugin-json.d.ts

@@ -0,0 +1,16 @@
+/**
+ * generated from https://raw.githubusercontent.com/SteamClientHomebrew/Millennium/main/src/sys/plugin-schema.json
+ */
+export interface PluginJson {
+	backend?: string;
+	common_name?: string;
+	description?: string;
+	frontend?: string;
+	include?: string[];
+	name: string;
+	splash_image?: string;
+	thumbnail?: string;
+	useBackend?: boolean;
+	venv?: string;
+	version?: string;
+}

package/src/query-parser.ts

@@ -9,6 +9,7 @@ export const PrintParamHelp = () => {
 			'options:',
 			'  --build <dev|prod>   build type (prod enables minification)',
 			'  --target <path>      plugin directory (default: current directory)',
+			'  --watch              enable watch mode for continuous rebuilding',
 			'  --no-update          skip update check',
 			'  --help               show this message',
 			'',
@@ -25,12 +26,14 @@ export interface ParameterProps {
 	type: BuildType;
 	targetPlugin: string; // path
 	isMillennium?: boolean;
+	watch?: boolean;
 }
 
 export const ValidateParameters = (args: Array<string>): ParameterProps => {
 	let typeProp: BuildType = BuildType.DevBuild,
 		targetProp: string = process.cwd(),
-		isMillennium: boolean = false;
+		isMillennium: boolean = false,
+		watch: boolean = false;
 
 	if (args.includes('--help')) {
 		PrintParamHelp();
@@ -73,11 +76,16 @@ export const ValidateParameters = (args: Array<string>): ParameterProps => {
 		if (args[i] == '--millennium-internal') {
 			isMillennium = true;
 		}
+
+		if (args[i] === '--watch') {
+			watch = true;
+		}
 	}
 
 	return {
 		type: typeProp,
 		targetPlugin: targetProp,
-		isMillennium: isMillennium,
+		isMillennium,
+		watch,
 	};
 };

package/src/static-embed.ts

@@ -206,7 +206,8 @@ export default function constSysfsExpr(options: EmbedPluginOptions = {}): SysfsP
 											fileName: path.relative(searchBasePath, singleFilePath),
 										};
 										embeddedContent = JSON.stringify(fileInfo);
-									} catch (fileError: unknown) {
+									this.addWatchFile(singleFilePath);
+								} catch (fileError: unknown) {
 										let message = String(fileError instanceof Error ? fileError.message : fileError ?? 'Unknown file read error');
 										this.error(`Error reading file ${singleFilePath}: ${message}`, node.loc?.start.index);
 										return;
@@ -230,6 +231,7 @@ export default function constSysfsExpr(options: EmbedPluginOptions = {}): SysfsP
 												filePath: fullPath,
 												fileName: path.relative(searchBasePath, fullPath),
 											});
+											this.addWatchFile(fullPath);
 										} catch (fileError: unknown) {
 											let message = String(fileError instanceof Error ? fileError.message : fileError ?? 'Unknown file read error');
 											this.warn(`Error reading file ${fullPath}: ${message}`);

package/src/transpiler.ts

@@ -7,7 +7,8 @@ import terser from '@rollup/plugin-terser';
 import typescript from '@rollup/plugin-typescript';
 import url from '@rollup/plugin-url';
 import nodePolyfills from 'rollup-plugin-polyfill-node';
-import { InputPluginOption, OutputBundle, OutputOptions, Plugin, RollupOptions, rollup } from 'rollup';
+import chalk from 'chalk';
+import { InputPluginOption, OutputBundle, OutputOptions, Plugin, RollupOptions, rollup, watch as rollupWatch } from 'rollup';
 import { minify_sync } from 'terser';
 import scss from 'rollup-plugin-scss';
 import * as sass from 'sass';
@@ -16,8 +17,10 @@ import path from 'path';
 import { pathToFileURL } from 'url';
 import dotenv from 'dotenv';
 import injectProcessEnv from 'rollup-plugin-inject-process-env';
+import { performance } from 'perf_hooks';
 import { ExecutePluginModule, InitializePlugins } from './plugin-api';
 import { Logger } from './logger';
+import { PluginJson } from './plugin-json';
 import constSysfsExpr from './static-embed';
 
 const env = dotenv.config().parsed ?? {};
@@ -41,6 +44,8 @@ declare const __call_server_method__: (methodName: string, kwargs: any) => any;
 export interface TranspilerProps {
 	minify: boolean;
 	pluginName: string;
+	watch?: boolean;
+	isMillennium?: boolean;
 }
 
 enum BuildTarget {
@@ -129,6 +134,8 @@ function stripPluginPrefix(message: string): string {
 	return message;
 }
 
+class BuildFailedError extends Error {}
+
 abstract class MillenniumBuild {
 	protected abstract readonly externals: ReadonlySet<string>;
 	protected abstract readonly forbidden: ReadonlyMap<string, string>;
@@ -144,6 +151,25 @@ abstract class MillenniumBuild {
 		return this.externals.has(id);
 	}
 
+	async watchConfig(input: string, sysfsPlugin: InputPluginOption, isMillennium: boolean): Promise<RollupOptions> {
+		return {
+			input,
+			plugins: await this.plugins(sysfsPlugin),
+			onwarn: (warning) => {
+				const msg = stripPluginPrefix(warning.message);
+				const loc = logLocation(warning);
+				if (warning.plugin === 'typescript') {
+					Logger.error(msg, loc);
+				} else {
+					Logger.warn(msg, loc);
+				}
+			},
+			context: 'window',
+			external: (id) => this.isExternal(id),
+			output: this.output(isMillennium),
+		};
+	}
+
 	async build(input: string, sysfsPlugin: InputPluginOption, isMillennium: boolean): Promise<void> {
 		let hasErrors = false;
 
@@ -167,7 +193,7 @@ abstract class MillenniumBuild {
 
 		await (await rollup(config)).write(config.output as OutputOptions);
 
-		if (hasErrors) process.exit(1);
+		if (hasErrors) throw new BuildFailedError();
 	}
 }
 
@@ -273,10 +299,50 @@ class WebkitBuild extends MillenniumBuild {
 	}
 }
 
-export const TranspilerPluginComponent = async (isMillennium: boolean, pluginJson: any, props: TranspilerProps) => {
+function RunWatchMode(frontendConfig: RollupOptions, webkitConfig: RollupOptions | null): void {
+	const configs = webkitConfig ? [frontendConfig, webkitConfig] : [frontendConfig];
+	const watcher = rollupWatch(configs);
+
+	console.log(chalk.blueBright.bold('watch'), 'watching for file changes...');
+
+	watcher.on('event', async (event) => {
+		if (event.code === 'BUNDLE_START') {
+			const label = (event.output as readonly string[]).some((f) => f.includes('index.js')) ? 'frontend' : 'webkit';
+			console.log(chalk.yellowBright.bold('watch'), `rebuilding ${label}...`);
+		} else if (event.code === 'BUNDLE_END') {
+			const label = (event.output as readonly string[]).some((f) => f.includes('index.js')) ? 'frontend' : 'webkit';
+			console.log(chalk.greenBright.bold('watch'), `${label} built in ${chalk.green(`${event.duration}ms`)}`);
+			await event.result.close();
+		} else if (event.code === 'ERROR') {
+			const err = event.error;
+			const msg = stripPluginPrefix(err?.message ?? String(err));
+			Logger.error(msg, logLocation(err as any));
+			if (event.result) await event.result.close();
+		}
+	});
+
+	const shutdown = () => {
+		console.log(chalk.yellowBright.bold('watch'), 'stopping...');
+		watcher.close();
+		process.exit(0);
+	};
+
+	process.on('SIGINT', shutdown);
+	process.on('SIGUSR2', shutdown);
+}
+
+export const TranspilerPluginComponent = async (pluginJson: PluginJson, props: TranspilerProps) => {
 	const webkitDir = './webkit/index.tsx';
 	const frontendDir = getFrontendDir(pluginJson);
 	const sysfs = constSysfsExpr();
+	const isMillennium = props.isMillennium ?? false;
+
+	if (props.watch) {
+		const frontendConfig = await new FrontendBuild(frontendDir, props).watchConfig(resolveEntryFile(frontendDir), sysfs.plugin, isMillennium);
+		const webkitConfig = fs.existsSync(webkitDir) ? await new WebkitBuild(props).watchConfig(webkitDir, sysfs.plugin, isMillennium) : null;
+		RunWatchMode(frontendConfig, webkitConfig);
+		return;
+	}
 
 	try {
 		await new FrontendBuild(frontendDir, props).build(resolveEntryFile(frontendDir), sysfs.plugin, isMillennium);
@@ -292,7 +358,10 @@ export const TranspilerPluginComponent = async (isMillennium: boolean, pluginJso
 			envCount: Object.keys(env).length || undefined,
 		});
 	} catch (exception: any) {
-		Logger.error(stripPluginPrefix(exception?.message ?? String(exception)), logLocation(exception));
+		if (!(exception instanceof BuildFailedError)) {
+			Logger.error(stripPluginPrefix(exception?.message ?? String(exception)), logLocation(exception));
+		}
+		Logger.failed({ elapsedMs: performance.now() - global.PerfStartTime, buildType: props.minify ? 'prod' : 'dev' });
 		process.exit(1);
 	}
 };