@ldgerrits/rogen 1.4.4 → 2.0.0-beta.1

package/package.json

@@ -1,66 +1,103 @@
-{
-	"name": "@ldgerrits/rogen",
-	"version": "1.4.4",
-	"description": "A CLI tool that enables feature-based architecture for Roblox",
-	"publishConfig": {
-		"access": "public"
-	},
-	"homepage": "https://rogen-playfully.vercel.app/",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/LDGerrits/rogen.git"
-	},
-	"keywords": [
-		"roblox",
-		"organization",
-		"feature-based architecture"
-	],
-	"author": "ldgerrits",
-	"license": "MIT",
-	"type": "module",
-	"workspaces": [
-		"docs"
-	],
-	"files": [
-		"dist",
-		"README.md",
-		"LICENSE.md"
-	],
-	"scripts": {
-		"clean": "node -e \"fs.rmSync('dist', { recursive: true, force: true })\"",
-		"build": "tsc",
-		"bundle": "esbuild bin/rogen.ts --bundle --platform=node --format=cjs --external:*.node --outfile=dist/bundle.cjs",
-		"prepublishOnly": "npm run clean && npm run build && npm run bundle",
-		"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-		"test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
-		"lint": "eslint .",
-		"lint:fix": "eslint . --fix",
-		"release:local": "npm run bundle && npx pkg dist/bundle.cjs --targets node18-win-x64,node18-linux-x64,node18-macos-x64 --out-path releases/"
-	},
-	"main": "dist/index.js",
-	"bin": {
-		"rogen": "dist/bundle.cjs"
-	},
-	"devDependencies": {
-		"@eslint/js": "^10.0.1",
-		"@types/jest": "^30.0.0",
-		"@types/node": "^26.0.1",
-		"@types/picomatch": "^4.0.3",
-		"esbuild": "^0.28.1",
-		"eslint": "^10.6.0",
-		"eslint-plugin-jest": "^29.15.4",
-		"jest": "^30.4.2",
-		"ts-jest": "^29.4.11",
-		"typescript": "^6.0.3",
-		"typescript-eslint": "^8.62.1"
-	},
-	"dependencies": {
-		"chokidar": "^3.6.0",
-		"picomatch": "^4.0.5"
-	},
-	"allowScripts": {
-		"esbuild@0.28.1": true,
-		"sharp@0.34.5": true,
-		"unrs-resolver@1.12.2": true
-	}
-}
+{
+	"name": "@ldgerrits/rogen",
+	"version": "2.0.0-beta.1",
+	"description": "A superset of Rojo that generates Rojo project files",
+	"publishConfig": {
+		"access": "public"
+	},
+	"homepage": "https://rogen-roblox.vercel.app/",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/LDGerrits/rogen.git"
+	},
+	"keywords": [
+		"roblox",
+		"rojo",
+		"luau",
+		"roblox-ts",
+		"roblox-studio",
+		"feature-based-architecture",
+		"vertical-slice-architecture",
+		"folder-structure",
+		"file-based-routing",
+		"sync",
+		"cli"
+	],
+	"author": "ldgerrits",
+	"license": "MIT",
+	"type": "module",
+	"workspaces": [
+		"docs"
+	],
+	"files": [
+		"dist/bundle.cjs",
+		"README.md",
+		"LICENSE.md"
+	],
+	"scripts": {
+		"prepare": "node scripts/prepare.ts",
+		"clean": "node -e \"fs.rmSync('dist', { recursive: true, force: true })\"",
+		"prebuild": "npm run generate",
+		"build": "tsc",
+		"prebundle": "npm run generate",
+		"bundle": "node scripts/bundle.ts",
+		"prebundle:watch": "npm run generate",
+		"bundle:watch": "esbuild bin/rogen.ts --bundle --platform=node --format=cjs --external:*.node --main-fields=module,main --define:import.meta.dirname=__dirname --outfile=dist/bundle.cjs --watch",
+		"prepublishOnly": "npm run clean && npm run build && npm run bundle",
+		"pretest": "npm run generate",
+		"test": "node --experimental-vm-modules --disable-warning=ExperimentalWarning node_modules/jest/bin/jest.js",
+		"pretest:watch": "npm run generate",
+		"test:watch": "node --experimental-vm-modules --disable-warning=ExperimentalWarning node_modules/jest/bin/jest.js --watch",
+		"pretest:unit": "npm run generate",
+		"test:unit": "node --experimental-vm-modules --disable-warning=ExperimentalWarning node_modules/jest/bin/jest.js --config jest.unit.config.js",
+		"pretest:changed": "npm run generate",
+		"test:changed": "node --experimental-vm-modules --disable-warning=ExperimentalWarning node_modules/jest/bin/jest.js --config jest.unit.config.js --onlyChanged --passWithNoTests",
+		"pretest:e2e": "npm run generate",
+		"test:e2e": "node --experimental-vm-modules --disable-warning=ExperimentalWarning node_modules/jest/bin/jest.js --config jest.e2e.config.js",
+		"test:e2e:update": "node scripts/summarize-transcripts.ts --update",
+		"test:e2e:diff": "node scripts/summarize-transcripts.ts",
+		"eval:agents": "node evals/agents/run.mjs",
+		"pretypecheck": "npm run generate",
+		"typecheck": "tsc -p e2e && tsc -p scripts",
+		"check": "npm run lint && npm run build && npm run typecheck && npm test",
+		"prelint": "npm run generate",
+		"lint": "eslint .",
+		"generate": "tsx scripts/generate.ts",
+		"generate:templates": "tsx scripts/generate.ts",
+		"generate:services": "tsx scripts/generate-services.ts",
+		"lint:fix": "eslint . --fix",
+		"release:local": "npm run bundle && node scripts/make-binary.ts releases/rogen",
+		"version": "tsx scripts/sync-version.ts"
+	},
+	"bin": {
+		"rogen": "dist/bundle.cjs"
+	},
+	"devDependencies": {
+		"@eslint/js": "^10.0.1",
+		"@types/jest": "^30.0.0",
+		"@types/node": "^26.0.1",
+		"@types/picomatch": "^4.0.3",
+		"ajv": "^8.20.0",
+		"esbuild": "^0.28.1",
+		"eslint": "^10.6.0",
+		"eslint-plugin-jest": "^29.15.4",
+		"jest": "^30.4.2",
+		"ts-jest": "^29.4.11",
+		"tsx": "^4.23.15",
+		"typescript": "^6.0.3",
+		"typescript-eslint": "^8.62.1"
+	},
+	"dependencies": {
+		"@clack/core": "^1.5.1",
+		"@clack/prompts": "^1.8.1",
+		"@msgpack/msgpack": "^3.1.3",
+		"chokidar": "^3.6.0",
+		"jsonc-parser": "^3.3.1",
+		"picomatch": "^4.0.5"
+	},
+	"allowScripts": {
+		"esbuild@0.28.1": true,
+		"sharp@0.34.5": true,
+		"unrs-resolver@1.12.2": true
+	}
+}

package/dist/build.js

@@ -1,256 +0,0 @@
-import { promises as fsp } from "fs";
-import path from "path";
-import picomatch from "picomatch";
-import { applyCasing, getOrCreateNode, pruneObject, sortObject, findMissingPaths, toPosix, collapseFolders, isInitFile, isValidSource, findExposedDataFiles, } from "./tree.js";
-import { resolveRoute, } from "./route.js";
-import { serviceParents, generateRoutingMaps, defaultConfig, services, } from "./constants.js";
-const SYSTEM_MARKERS = {
-    structure: true,
-    verbatim: true,
-    unwrap: true,
-};
-function buildSubPath(sourceRel) {
-    const segments = sourceRel.split(/[\\/]/).filter(Boolean);
-    let rootIndex = 0;
-    while (rootIndex < segments.length &&
-        (segments[rootIndex] === ".." || segments[rootIndex] === ".")) {
-        rootIndex++;
-    }
-    if (rootIndex + 1 >= segments.length) {
-        return "";
-    }
-    return segments.slice(rootIndex + 1).join("/");
-}
-async function listTree(dir) {
-    const listings = new Map();
-    async function scan(currentDir) {
-        try {
-            const entries = await fsp.readdir(currentDir, {
-                withFileTypes: true,
-            });
-            listings.set(currentDir, entries);
-            const hasInit = entries.some((e) => e.isFile() && isInitFile(e.name));
-            const hasSync = entries.some((e) => e.isFile() && e.name === ".sync");
-            if (hasInit || hasSync)
-                return;
-            const subdirs = entries
-                .filter((e) => e.isDirectory())
-                .map((e) => path.join(currentDir, e.name));
-            await Promise.all(subdirs.map(scan));
-        }
-        catch (error) {
-            if (error instanceof Error &&
-                "code" in error &&
-                error.code === "ENOENT")
-                return;
-            throw error;
-        }
-    }
-    await scan(dir);
-    return listings;
-}
-function compileTagRegexes(activeEnvs) {
-    return Array.from(activeEnvs).map((env) => ({
-        suffix: new RegExp(`[\\.\\-_\\+]${env}$`, "i"),
-        prefix: new RegExp(`^${env}[\\.\\-_\\+]`, "i"),
-        middle: new RegExp(`[\\.\\-_\\+]${env}(?=[\\.\\-_\\+])`, "i"),
-    }));
-}
-function buildDirectoryMarkers(sourcePath, listings, routingMaps, knownFlags) {
-    const directoryMarkers = {};
-    for (const [dir, entries] of listings.entries()) {
-        const markers = [];
-        for (const entry of entries) {
-            if (entry.isFile() && entry.name.startsWith(".")) {
-                const possibleMarker = entry.name.slice(1).toLowerCase();
-                if (possibleMarker in SYSTEM_MARKERS ||
-                    routingMaps.lowerCaseMap[possibleMarker] ||
-                    knownFlags.has(possibleMarker)) {
-                    markers.push(possibleMarker);
-                }
-            }
-        }
-        if (markers.length > 0) {
-            let relDir = path.relative(sourcePath, dir);
-            relDir = relDir.split(path.sep).join("/");
-            directoryMarkers[relDir] = markers;
-        }
-    }
-    return directoryMarkers;
-}
-function walkSource(dir, sourcePath, listings, callback) {
-    const entries = listings.get(dir);
-    if (!entries)
-        return;
-    // Rojo expects a specific structure for folders with an init.luau file that we cannot deviate from.
-    // Because of this, we must return early if an initialization file has been found.
-    const syncFile = entries.find((e) => e.isFile() && e.name === ".sync");
-    if (syncFile) {
-        callback(dir, false, true);
-        return;
-    }
-    const initFile = entries.find((e) => e.isFile() && isInitFile(e.name));
-    if (initFile) {
-        callback(path.join(dir, initFile.name), true, false);
-        return;
-    }
-    for (const entry of entries) {
-        const fullPath = path.join(dir, entry.name);
-        if (entry.isDirectory()) {
-            walkSource(fullPath, sourcePath, listings, callback);
-        }
-        else if (isValidSource(entry.name)) {
-            callback(fullPath, false, false);
-        }
-    }
-}
-export async function build(targetConfig, baseProjectTree, config, env, sourcePaths, cliArgs, anchor) {
-    const modeCopy = { ...targetConfig };
-    if (cliArgs.output) {
-        modeCopy.output = path.resolve(process.cwd(), cliArgs.output);
-    }
-    else {
-        modeCopy.output = path.resolve(anchor, targetConfig.output);
-    }
-    if (cliArgs.build) {
-        modeCopy.build = cliArgs.build;
-    }
-    const rojoTree = structuredClone(baseProjectTree);
-    // Pre-populate all routing containers to prevent desync issues
-    for (const targetService of Object.values(services)) {
-        let current = rojoTree.tree;
-        if (serviceParents[targetService]) {
-            current = getOrCreateNode(current, serviceParents[targetService]);
-        }
-        getOrCreateNode(current, targetService);
-    }
-    if (config.aliases) {
-        for (const aliasPath of Object.values(config.aliases)) {
-            if (typeof aliasPath === "string") {
-                const parts = aliasPath.split(".");
-                let current = rojoTree.tree;
-                // Ensure the parent container is created if needed
-                if (parts.length > 0 && serviceParents[parts[0]]) {
-                    current = getOrCreateNode(current, serviceParents[parts[0]]);
-                }
-                for (const part of parts) {
-                    current = getOrCreateNode(current, part);
-                }
-            }
-        }
-    }
-    const mergedTags = { ...(config.tags || {}), ...(modeCopy.tags || {}) };
-    const knownTags = new Set(Object.keys(config.tags || {}).map((t) => t.toLowerCase()));
-    const activeTags = new Set(Object.keys(mergedTags)
-        .filter((t) => mergedTags[t])
-        .map((t) => t.toLowerCase()));
-    const cliTags = (cliArgs.tag || []).map((t) => t.toLowerCase());
-    for (const tag of cliTags) {
-        activeTags.add(tag);
-    }
-    for (const tag of activeTags) {
-        if (!knownTags.has(tag)) {
-            throw new Error(`active tag "${tag}" is not declared in the root "tags" object.`);
-        }
-    }
-    const tagRegexes = compileTagRegexes(activeTags);
-    const context = {
-        source: config.source || structuredClone(defaultConfig.source),
-        ...modeCopy,
-        isTsProject: env.isTsProject || (cliArgs.mode?.includes("ts") ?? false),
-        emitLegacyScripts: rojoTree.emitLegacyScripts ?? true,
-        name: rojoTree.name,
-        routingMaps: generateRoutingMaps(config.aliases || {}),
-        verbatim: config.verbatim ?? defaultConfig.verbatim,
-        unwrap: config.unwrap ?? defaultConfig.unwrap,
-        directoryMarkers: {},
-        knownTags,
-        activeTags,
-        tagRegexes,
-    };
-    const combinedGlobIgnorePaths = Array.from(new Set([
-        ...(rojoTree.globIgnorePaths || []),
-        ...(config.globIgnorePaths || []),
-        ...(modeCopy.globIgnorePaths || []),
-    ]));
-    const isIgnored = combinedGlobIgnorePaths.length > 0
-        ? picomatch(combinedGlobIgnorePaths)
-        : () => false;
-    const nodeOrigins = new WeakMap();
-    const collisions = [];
-    let fileCount = 0;
-    for (const sourcePath of sourcePaths) {
-        const relativePath = path.relative(anchor, sourcePath);
-        const subPath = buildSubPath(relativePath);
-        const listings = await listTree(sourcePath);
-        const directoryMarkers = buildDirectoryMarkers(sourcePath, listings, context.routingMaps, knownTags);
-        const newContext = {
-            ...context,
-            build: path.join(context.build, subPath),
-            directoryMarkers,
-        };
-        walkSource(sourcePath, sourcePath, listings, (filepath, isInit, isSync) => {
-            const relativePath = path.relative(sourcePath, filepath);
-            const { targetService, wrapperFolder, virtualParts, nodeName, projectPath, dropped, unwrap, } = resolveRoute(relativePath, isInit, newContext, isSync);
-            if (dropped || (projectPath && isIgnored(toPosix(projectPath))))
-                return;
-            fileCount++;
-            let current = rojoTree.tree;
-            if (serviceParents[targetService]) {
-                current = getOrCreateNode(current, serviceParents[targetService]);
-            }
-            current = getOrCreateNode(current, targetService);
-            if (!unwrap) {
-                current = getOrCreateNode(current, applyCasing(wrapperFolder, config.casing), "Folder");
-            }
-            for (const part of virtualParts) {
-                current = getOrCreateNode(current, part, "Folder");
-            }
-            const existingNodeRaw = current[nodeName];
-            if (existingNodeRaw && existingNodeRaw.$path) {
-                const origin = nodeOrigins.get(existingNodeRaw);
-                if (origin && origin.sourcePath === sourcePath) {
-                    collisions.push(`Name collision: "${origin.filepath}" and "${relativePath}" both map to the node "${nodeName}".`);
-                }
-            }
-            const existingNode = existingNodeRaw || {};
-            const newNode = {
-                ...existingNode,
-                $path: { optional: projectPath },
-            };
-            if (newNode.$className === "Folder") {
-                delete newNode.$className;
-                if (newNode.$ignoreUnknownInstances === false) {
-                    delete newNode.$ignoreUnknownInstances;
-                }
-            }
-            current[nodeName] = newNode;
-            nodeOrigins.set(newNode, {
-                sourcePath,
-                filepath: relativePath,
-            });
-        });
-    }
-    const outputDir = path.dirname(modeCopy.output);
-    const removed = [];
-    const prunedTree = pruneObject(rojoTree.tree, context.build, outputDir, removed);
-    collapseFolders(prunedTree, context.build, outputDir, isIgnored);
-    rojoTree.tree = prunedTree;
-    if (combinedGlobIgnorePaths.length > 0) {
-        rojoTree.globIgnorePaths = combinedGlobIgnorePaths;
-    }
-    const sortedTree = sortObject(rojoTree);
-    const missingPaths = findMissingPaths(sortedTree.tree, context.build, outputDir);
-    const exposedDataFiles = findExposedDataFiles(sortedTree.tree);
-    return {
-        output: modeCopy.output,
-        tree: sortedTree,
-        missingPaths,
-        removed,
-        collisions,
-        exposedDataFiles,
-        name: context.name,
-        buildDir: context.build,
-        fileCount,
-    };
-}

package/dist/cli.js

@@ -1,115 +0,0 @@
-import { parseArgs } from "util";
-export function printHelp(logger) {
-    const helpText = `
-Rogen - Feature-based architecture for Roblox
-
-Usage:
-  rogen [command] [options]
-
-Commands:
-  init                 Generate a .rogen.json config file
-  build                Build the project
-  watch                Watch the source and build automatically
-
-Options:
-  -c, --config <path>  Specify custom config file
-  -p, --project <path> Specify path to Rojo project
-  -t, --tag <tag>      Activate environment tags
-  -m, --mode <mode>    Override modes (luau, ts, darklua, or custom)
-  -s, --source <path>  Override the directory containing uncompiled code
-  -b, --build <path>   Override output directory for transpiled code
-  -o, --output <path>  Override path of Rojo project file
-  -h, --help           Print help
-  -v, --version        Print version
-`;
-    if (logger) {
-        logger.info(helpText.trim());
-    }
-    else {
-        console.log(helpText.trim());
-    }
-}
-export function parseCliArgs(args = process.argv.slice(2), logger) {
-    const options = {
-        help: { type: "boolean", short: "h" },
-        version: { type: "boolean", short: "v" },
-        init: { type: "boolean", short: "i" },
-        watch: { type: "boolean", short: "w" },
-        config: { type: "string", short: "c" },
-        mode: { type: "string", short: "m", multiple: true },
-        source: { type: "string", short: "s", multiple: true },
-        tag: { type: "string", short: "t", multiple: true },
-        project: { type: "string", short: "p" },
-        build: { type: "string", short: "b" },
-        output: { type: "string", short: "o" },
-    };
-    try {
-        const { values, positionals } = parseArgs({
-            args,
-            options,
-            allowPositionals: true,
-            strict: true,
-        });
-        const parsedArgs = values;
-        if (positionals.length > 0) {
-            const subcommand = positionals[0].toLowerCase();
-            if (subcommand === "init") {
-                parsedArgs.init = true;
-            }
-            else if (subcommand === "watch") {
-                parsedArgs.watch = true;
-            }
-            else if (subcommand === "help") {
-                parsedArgs.help = true;
-            }
-            else if (subcommand === "version") {
-                parsedArgs.version = true;
-            }
-            else if (subcommand === "build") {
-                // build is the default command, so it falls through cleanly
-            }
-            else {
-                const errorMsg = `unknown subcommand "${positionals[0]}".\nRun 'rogen --help' to see a list of available commands.`;
-                if (logger) {
-                    logger.error(errorMsg);
-                }
-                else {
-                    console.error(errorMsg);
-                }
-                process.exit(1);
-            }
-        }
-        return parsedArgs;
-    }
-    catch (error) {
-        let errCode;
-        let errMsg = String(error);
-        if (typeof error === "object" && error !== null) {
-            const errObj = error;
-            errCode = typeof errObj.code === "string" ? errObj.code : undefined;
-            errMsg =
-                typeof errObj.message === "string"
-                    ? errObj.message
-                    : String(error);
-        }
-        if (errCode === "ERR_PARSE_ARGS_UNKNOWN_OPTION" ||
-            errMsg.includes("Unknown option")) {
-            const cleanMsg = errMsg.replace(/^TypeError \[ERR_PARSE_ARGS_UNKNOWN_OPTION\]:\s*/, "");
-            const errorMsg = `${cleanMsg}\nRun 'rogen --help' to see a list of available commands and options.`;
-            if (logger) {
-                logger.error(errorMsg);
-            }
-            else {
-                console.error(errorMsg);
-            }
-            process.exit(1);
-        }
-        if (logger) {
-            logger.error(errMsg);
-        }
-        else {
-            console.error(errMsg);
-        }
-        process.exit(1);
-    }
-}