cluaupp 1.0.0 → 1.4.0

package/src/utils/project.ts

@@ -3,10 +3,12 @@ import path from "node:path";
 import type { BuildOptions, BuildResult, ProjectConfig } from "../types.js";
 import { pkg } from "../package-info.js";
 import { collectSources, toLuauPath } from "../clpp/paths.js";
+import { collectFlareFiles, compileFlareFile } from "../flare/index.js";
+import { collectNativeSchemaFiles, compileNativeSchemaFile } from "../native/index.js";
 import { syncEditorSupport } from "../intellisense.js";
 import { ProcessOrchestrator } from "./process-orchestrator.js";
 import { RojoMapper } from "./rojo-mapper.js";
-import { transpileSource } from "../transpile.js";
+import { transpileSource, transpileSourceAsync } from "../transpile.js";
 import { assertInitDest, assertInside, isInside, safeProjectSubdir, safeRelPath } from "./safe-paths.js";
 
 function readProjectConfig(file: string): Partial<ProjectConfig> {
@@ -89,15 +91,17 @@ function tryRm(target: string, root?: string): boolean {
 }
 
 function copyFileIfChanged(src: string, dest: string, mode = "fill"): void {
-	if (mode === "fill" && fs.existsSync(dest)) {
-		return;
-	}
-	if (mode === "update" && fs.existsSync(dest)) {
-		const from = fs.statSync(src);
-		const to = fs.statSync(dest);
-		if (from.size === to.size && from.mtimeMs <= to.mtimeMs) {
+	if (mode !== "force") {
+		if (mode === "fill" && fs.existsSync(dest)) {
 			return;
 		}
+		if (mode === "update" && fs.existsSync(dest)) {
+			const from = fs.statSync(src);
+			const to = fs.statSync(dest);
+			if (from.size === to.size && from.mtimeMs <= to.mtimeMs) {
+				return;
+			}
+		}
 	}
 	fs.mkdirSync(path.dirname(dest), { recursive: true });
 	try {
@@ -128,12 +132,55 @@ function syncDir(from: string, to: string, mode = "fill"): void {
 	}
 }
 
+function pruneStaleLibs(libs: string): void {
+	if (!fs.existsSync(libs)) {
+		return;
+	}
+	const staleNames = [
+		"Janitor",
+		"Signal",
+		"MathUtils",
+		"FormatNumber",
+		"Module3D",
+		"Twinkle",
+		"EzVisualz",
+		"Spring",
+		"Display",
+		"StickyBillboard",
+		"Icon",
+		"TopbarPlus",
+		"Cmdr",
+		"Chrono",
+		"Iris",
+		"Fusion",
+		"StateMachine",
+		"VfxUtil",
+		"DataService",
+		"TutorialKit",
+		"TutorialServer",
+		"QuickNet",
+	];
+	const stale = [
+		...staleNames.map((name) => path.join(libs, name)),
+		path.join(libs, "Keep", "Packages"),
+		path.join(libs, "Keep", "ProfileStore.luau"),
+	];
+	for (const target of stale) {
+		if (!fs.existsSync(target)) {
+			continue;
+		}
+		fs.rmSync(target, { recursive: true, force: true });
+	}
+}
+
 function copyRuntime(dest: string): void {
 	const runtime = path.join(__dirname, "..", "..", "runtime");
 	if (!fs.existsSync(runtime)) {
 		return;
 	}
-	syncDir(runtime, path.join(dest, "libs"));
+	const libs = path.join(dest, "libs");
+	pruneStaleLibs(libs);
+	syncDir(runtime, libs, "force");
 }
 
 function copyHeaders(dest: string): void {
@@ -245,26 +292,108 @@ function createMapper(root: string, config: ProjectConfig, rojoPath?: string): R
 	return mapper;
 }
 
-function compileProject(root: string, config: ProjectConfig, mapper: RojoMapper) {
+function compileOptions(root: string, config: ProjectConfig, file: string, rel: string) {
 	const srcDir = path.join(root, config.rootDir);
-	const files = collectSources(srcDir);
+	return {
+		...config,
+		filePath: file,
+		relativeName: rel,
+		outName: toLuauPath(rel),
+		architecture: config.architecture === true,
+		includeDirs: [path.dirname(file), srcDir, path.join(root, "include")],
+		srcDir,
+		outDir: config.outDir,
+	};
+}
+
+function compileSchemaJobs(root: string, config: ProjectConfig, srcDir: string) {
 	const jobs: Array<{ rel: string; files: Array<{ name: string; contents: string }>; stale: string[] }> = [];
 	const errors: Array<{ rel: string; prefixes: string[]; message: string }> = [];
+	const flare = compileFlareJobs(root, config, srcDir);
+	jobs.push(...flare.jobs);
+	errors.push(...flare.errors);
+	for (const file of collectNativeSchemaFiles(srcDir)) {
+		const rel = posixRel(srcDir, file);
+		try {
+			const emit = compileNativeSchemaFile(file, srcDir);
+			const headerDest = path.join(srcDir, emit.headerRel);
+			if (!isInside(path.resolve(root, config.rootDir), headerDest) && !isInside(srcDir, headerDest)) {
+				throw new Error(`cluaupp schema: skip unsafe header ${emit.headerRel}`);
+			}
+			writeTextIfChanged(headerDest, emit.header);
+			jobs.push({
+				rel,
+				files: [{ name: emit.luauRel, contents: emit.luau }],
+				stale: [],
+			});
+		} catch (err) {
+			errors.push({
+				rel,
+				prefixes: sourcePrefixes(rel.replace(/\.(mint|bloom|helm|shift|hive|axiom)$/i, ".clh")),
+				message: (err as Error).message,
+			});
+		}
+	}
+	return { jobs, errors };
+}
+
+function compileFlareJobs(root: string, config: ProjectConfig, srcDir: string) {
+	const jobs: Array<{ rel: string; files: Array<{ name: string; contents: string }>; stale: string[] }> = [];
+	const errors: Array<{ rel: string; prefixes: string[]; message: string }> = [];
+	for (const file of collectFlareFiles(srcDir)) {
+		const rel = posixRel(srcDir, file);
+		try {
+			const { emit } = compileFlareFile(file, srcDir);
+			const headerDest = path.join(srcDir, emit.headerRel);
+			if (!isInside(path.resolve(root, config.rootDir), headerDest) && !isInside(srcDir, headerDest)) {
+				throw new Error(`cluaupp flare: skip unsafe header ${emit.headerRel}`);
+			}
+			writeTextIfChanged(headerDest, emit.header);
+			jobs.push({
+				rel,
+				files: [{ name: emit.luauRel, contents: emit.luau }],
+				stale: [],
+			});
+		} catch (err) {
+			errors.push({ rel, prefixes: sourcePrefixes(rel.replace(/\.flare$/i, ".clh")), message: (err as Error).message });
+		}
+	}
+	return { jobs, errors };
+}
+
+function compileProject(root: string, config: ProjectConfig, mapper: RojoMapper) {
+	const srcDir = path.join(root, config.rootDir);
+	const schema = compileSchemaJobs(root, config, srcDir);
+	const files = collectSources(srcDir);
+	const jobs = [...schema.jobs];
+	const errors = [...schema.errors];
 
 	for (const file of files) {
 		const source = fs.readFileSync(file, "utf8");
 		const rel = posixRel(srcDir, file);
 		try {
-			const result = transpileSource(source, rel, {
-				...config,
-				filePath: file,
-				relativeName: rel,
-				outName: toLuauPath(rel),
-				architecture: config.architecture === true,
-				includeDirs: [path.dirname(file), srcDir, path.join(root, "include")],
-				srcDir,
-				outDir: config.outDir,
-			}, mapper);
+			const result = transpileSource(source, rel, compileOptions(root, config, file, rel), mapper);
+			jobs.push({ rel, files: result.files, stale: result.stale || [] });
+		} catch (err) {
+			errors.push({ rel, prefixes: sourcePrefixes(rel), message: (err as Error).message });
+		}
+	}
+
+	return { files, jobs, errors };
+}
+
+async function compileProjectAsync(root: string, config: ProjectConfig, mapper: RojoMapper) {
+	const srcDir = path.join(root, config.rootDir);
+	const schema = compileSchemaJobs(root, config, srcDir);
+	const files = collectSources(srcDir);
+	const jobs = [...schema.jobs];
+	const errors = [...schema.errors];
+
+	for (const file of files) {
+		const source = fs.readFileSync(file, "utf8");
+		const rel = posixRel(srcDir, file);
+		try {
+			const result = await transpileSourceAsync(source, rel, compileOptions(root, config, file, rel), mapper);
 			jobs.push({ rel, files: result.files, stale: result.stale || [] });
 		} catch (err) {
 			errors.push({ rel, prefixes: sourcePrefixes(rel), message: (err as Error).message });
@@ -332,28 +461,15 @@ function ensureVendor(root: string): void {
 	copyHeaders(root);
 }
 
-export function build(root: string, options: BuildOptions = {}): BuildResult {
+function finishBuild(
+	root: string,
+	config: ProjectConfig,
+	compiled: { jobs: Array<{ rel: string; files: Array<{ name: string; contents: string }>; stale: string[] }>; errors: Array<{ rel: string; prefixes: string[]; message: string }> },
+	options: BuildOptions,
+): BuildResult {
 	const exitOnError = options.exitOnError !== false;
 	const holdOnError = options.holdOnError === true;
 	const format = options.format === true;
-	const config = loadConfig(root);
-	if (options.syncVendor !== false) {
-		ensureVendor(root);
-	}
-	const srcDir = path.join(root, config.rootDir);
-	if (!fs.existsSync(srcDir) || collectSources(srcDir).length === 0) {
-		console.error("no .clpp/.clp/.clh files in", config.rootDir);
-		if (!holdOnError) {
-			pruneOut(root, config, new Set(), []);
-		}
-		if (exitOnError) {
-			process.exit(1);
-		}
-		return { failed: 0, written: new Set() };
-	}
-
-	const mapper = createMapper(root, config, options.rojo);
-	const compiled = compileProject(root, config, mapper);
 	if (compiled.errors.length > 0) {
 		for (const err of compiled.errors) {
 			console.error(err.message);
@@ -395,6 +511,48 @@ export function build(root: string, options: BuildOptions = {}): BuildResult {
 	return { failed: compiled.errors.length, written };
 }
 
+function prepareBuild(root: string, options: BuildOptions) {
+	const exitOnError = options.exitOnError !== false;
+	const holdOnError = options.holdOnError === true;
+	const config = loadConfig(root);
+	if (options.strict === true) {
+		config.strict = true;
+	}
+	if (options.syncVendor !== false) {
+		ensureVendor(root);
+	}
+	const srcDir = path.join(root, config.rootDir);
+	if (!fs.existsSync(srcDir) || collectSources(srcDir).length === 0) {
+		console.error("no .clpp/.clp/.clh files in", config.rootDir);
+		if (!holdOnError) {
+			pruneOut(root, config, new Set(), []);
+		}
+		if (exitOnError) {
+			process.exit(1);
+		}
+		return null;
+	}
+	return { config, mapper: createMapper(root, config, options.rojo) };
+}
+
+export function build(root: string, options: BuildOptions = {}): BuildResult {
+	const prepared = prepareBuild(root, options);
+	if (!prepared) {
+		return { failed: 0, written: new Set() };
+	}
+	const compiled = compileProject(root, prepared.config, prepared.mapper);
+	return finishBuild(root, prepared.config, compiled, options);
+}
+
+export async function buildAsync(root: string, options: BuildOptions = {}): Promise<BuildResult> {
+	const prepared = prepareBuild(root, options);
+	if (!prepared) {
+		return { failed: 0, written: new Set() };
+	}
+	const compiled = await compileProjectAsync(root, prepared.config, prepared.mapper);
+	return finishBuild(root, prepared.config, compiled, options);
+}
+
 export async function init(dest: string): Promise<void> {
 	const target = assertInitDest(dest);
 	const template = path.join(__dirname, "..", "..", "templates", "game");
@@ -451,7 +609,6 @@ function acquireWatchLock(root: string): void {
 
 export function watch(root: string, options: BuildOptions = {}): void {
 	acquireWatchLock(root);
-	build(root, { exitOnError: false, syncVendor: false, holdOnError: true, format: options.format, rojo: options.rojo });
 	const config = loadConfig(root);
 	const dir = path.join(root, config.rootDir);
 	let timer: NodeJS.Timeout | null = null;
@@ -464,23 +621,24 @@ export function watch(root: string, options: BuildOptions = {}): void {
 			return;
 		}
 		running = true;
-		try {
-			build(root, { exitOnError: false, syncVendor: false, holdOnError: true, format: options.format, rojo: options.rojo });
-		} catch (err) {
-			console.error((err as Error).message);
-		} finally {
-			running = false;
-			if (queued) {
-				queued = false;
-				run();
-			}
-		}
+		void buildAsync(root, { exitOnError: false, syncVendor: false, holdOnError: true, format: options.format, rojo: options.rojo })
+			.catch((err) => {
+				console.error((err as Error).message);
+			})
+			.finally(() => {
+				running = false;
+				if (queued) {
+					queued = false;
+					run();
+				}
+			});
 	};
 
 	console.log("cluaupp", pkg.version, "watching", dir, "(libs untouched)");
 	if (!fs.existsSync(dir)) {
 		fs.mkdirSync(dir, { recursive: true });
 	}
+	run();
 	fs.watch(dir, { recursive: true }, () => {
 		if (timer) {
 			clearTimeout(timer);

package/src/utils/rojo-mapper.ts

@@ -115,14 +115,20 @@ export class RojoMapper {
 			segments.shift();
 		}
 		const alias = this.safeAlias(baseName);
-		if (segments[0] === "shared") {
-			return { alias, path: `ReplicatedStorage.Cluaupp.${segments.slice(1).join(".")}` };
+		if (segments[0] === "ReplicatedFirst") {
+			return { alias, path: `ReplicatedFirst.${segments.slice(1).join(".")}` };
 		}
-		if (segments[0] === "server") {
-			return { alias, path: `ServerScriptService.Cluaupp.${segments.slice(1).join(".")}` };
+		if (segments[0] === "ReplicatedStorage") {
+			return { alias, path: `ReplicatedStorage.${segments.slice(1).join(".")}` };
 		}
-		if (segments[0] === "client") {
-			return { alias, path: `StarterPlayer.StarterPlayerScripts.Cluaupp.${segments.slice(1).join(".")}` };
+		if (segments[0] === "ServerScriptService") {
+			return { alias, path: `ServerScriptService.${segments.slice(1).join(".")}` };
+		}
+		if (segments[0] === "StarterPlayer") {
+			return { alias, path: `StarterPlayer.${segments.slice(1).join(".")}` };
+		}
+		if (segments[0] === "ServerStorage") {
+			return { alias, path: `ServerStorage.${segments.slice(1).join(".")}` };
 		}
 		return { alias, path: `ReplicatedStorage.${segments.join(".")}` };
 	}

package/templates/game/.vscode/extensions.json

@@ -1,5 +1,6 @@
 {
 	"unwantedRecommendations": [
 		"ms-vscode.cpptools"
-	]
+	],
+	"recommendations": []
 }

package/templates/game/default.project.json

@@ -2,33 +2,38 @@
 	"name": "cluaupp-game",
 	"tree": {
 		"$className": "DataModel",
+		"ReplicatedFirst": {
+			"$className": "ReplicatedFirst",
+			"$path": "out/ReplicatedFirst"
+		},
 		"ServerScriptService": {
 			"$className": "ServerScriptService",
-			"Cluaupp": {
-				"$path": "out/server"
-			}
+			"$path": "out/ServerScriptService"
 		},
 		"ReplicatedStorage": {
 			"$className": "ReplicatedStorage",
-			"Cluaupp": {
-				"$path": "out/shared"
+			"Shared": {
+				"$path": "out/ReplicatedStorage/Shared"
 			},
 			"CluauppLibs": {
 				"$path": "libs"
-			},
-			"Packages": {
-				"$path": "Packages"
 			}
 		},
 		"StarterPlayer": {
 			"$className": "StarterPlayer",
 			"StarterPlayerScripts": {
 				"$className": "StarterPlayerScripts",
-				"Cluaupp": {
-					"$path": "out/client"
-				}
+				"$path": "out/StarterPlayer/StarterPlayerScripts"
+			},
+			"StarterCharacterScripts": {
+				"$className": "StarterCharacterScripts",
+				"$path": "out/StarterPlayer/StarterCharacterScripts"
 			}
 		},
+		"ServerStorage": {
+			"$className": "ServerStorage",
+			"$path": "out/ServerStorage"
+		},
 		"HttpService": {
 			"$className": "HttpService",
 			"$properties": {