rbxts-transformer-commit-migrations 1.2.5 → 1.3.0

package/index.d.ts

@@ -1,3 +1,5 @@
-export declare function $migrate(order: number): never;
-export declare function $migrate(order: "__resolved"): number;
-export declare function $migrate(order: number | "__resolved"): number | undefined;
+export type MigrateOrder = number & { readonly __migrationKind: "migrate" };
+export type TransformOrder = number & { readonly __migrationKind: "transform" };
+
+export declare function $migrate(order: number | "__resolved"): MigrateOrder;
+export declare function $transform(order: number | "__resolved"): TransformOrder;

package/out/cli/resolveMacros.js

@@ -3,7 +3,7 @@ import ts from "typescript";
 import { readFileSync, writeFileSync, existsSync } from "fs";
 import { glob } from "glob";
 import loadMigrationEntries from "../util/loadMigrationEntries.js";
-import { CONFIG, MACRO, MACRO_CALL_REGEX, MACRO_REGEX } from "../config.js";
+import { CONFIG, MACRO_CALL_REGEX, MACRO_REGEX, TRANSFORM_MACRO } from "../config.js";
 function getConfigPathFromTransformerConfig(tsconfigPath = "tsconfig.json") {
     const raw = readFileSync(tsconfigPath, "utf-8");
     if (!raw)
@@ -56,22 +56,23 @@ function walk(node, ctx) {
         const entry = path.join("/");
         const orderArg = node.arguments[0];
         const order = orderArg ? ts.isNumericLiteral(orderArg) ? parseInt(orderArg.getText()) : null : 0;
+        const isTransform = node.expression.text === TRANSFORM_MACRO;
         if (order !== null && usedOrders.has(order)) {
             console.error("Multiple of the same migration orders found. Every migration has to have a unique order.");
             process.exit(1);
         }
         if (!entry) {
-            console.error("Invalid migration entry, maybe you called a $migrate outside a table?");
+            console.error(`Invalid migration entry, maybe you called a ${node.expression.text} outside a table?`);
             process.exit(1);
         }
         if (!orderArg?.getText().includes("__resolved")) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             usedOrders.add(order);
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            migrationData[entry] = { timestamp: Date.now(), order: order, path };
+            migrationData[entry] = { timestamp: Date.now(), order: order, path, isTransform };
             ctx.changed = true;
-            migrations.push(entry);
         }
+        migrations.push(entry);
     }
     ts.forEachChild(node, (node) => {
         walk(node, ctx);
@@ -84,7 +85,7 @@ for (const file of files) {
     walk(sourceFile, ctx);
     if (ctx.changed) {
         changed.push(file);
-        writeFileSync(file, src.replaceAll(MACRO_CALL_REGEX, `${MACRO}("__resolved")`));
+        writeFileSync(file, src.replaceAll(MACRO_CALL_REGEX, `$1("__resolved")`));
     }
 }
 const [previousMigrations] = loadMigrationEntries(config);
@@ -99,11 +100,13 @@ if (newMigrations.length === 0) {
     process.exit(0);
 }
 const newLines = newMigrations
-    .map((e) => `\t"${e}": { timestamp: ${migrationData[e].timestamp}, order: ${migrationData[e].order}, path: ${JSON.stringify(migrationData[e].path)} },`)
+    .map((e) => `\t"${e}": { timestamp: ${migrationData[e].timestamp}, order: ${migrationData[e].order}, path: ${JSON.stringify(migrationData[e].path)}, isTransform: ${migrationData[e].isTransform} },`)
     .join("\n");
 const migratedEntries = migrations.map((e) => `"${e}"`).join(" | ");
+// isTransform is optional so entries written before it existed still type check
+const migrationDataInterface = `interface MigrationData {\n\tpath: string[];\n\ttimestamp: number;\n\torder: number;\n\tisTransform?: boolean;\n}`;
 if (!existsSync(config)) {
-    writeFileSync(config, `type MigratedEntries = ${migratedEntries}\n\ninterface MigrationData {\n\tpath: string[]\n\ttimestamp: number\n\torder: number\n}\n\n// AUTO-GENERATED MIGRATION CONFIG - DO NOT EDIT\nexport const MIGRATED_ENTRIES: Record<MigratedEntries, MigrationData> = {\n${newLines}\n};\n`);
+    writeFileSync(config, `type MigratedEntries = ${migratedEntries}\n\n${migrationDataInterface}\n\n// AUTO-GENERATED MIGRATION CONFIG - DO NOT EDIT\nexport const MIGRATED_ENTRIES: Record<MigratedEntries, MigrationData> = {\n${newLines}\n};\n`);
 }
 else {
     const lines = readFileSync(config, "utf-8").split("\n");
@@ -111,7 +114,10 @@ else {
     if (typeIndex !== -1) {
         lines[typeIndex] = `type MigratedEntries = ${migratedEntries}`;
     }
-    const updated = lines.join("\n").replace(/\};\s*$/, `${newLines}\n};`);
+    const updated = lines
+        .join("\n")
+        .replace(/interface MigrationData \{[^}]*\}/, migrationDataInterface)
+        .replace(/\};\s*$/, `${newLines}\n};`);
     writeFileSync(config, updated);
 }
 changed.push(config);

package/out/config.js

@@ -2,6 +2,9 @@ function escapeRegExp(str) {
     return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
 export const CONFIG = "migrations.config.ts";
-export const MACRO = "$migrate";
-export const MACRO_REGEX = new RegExp(escapeRegExp(MACRO));
-export const MACRO_CALL_REGEX = new RegExp(escapeRegExp(MACRO) + "\\([^)]*\\)", "g");
+export const MIGRATE_MACRO = "$migrate";
+export const TRANSFORM_MACRO = "$transform";
+const MACROS = [MIGRATE_MACRO, TRANSFORM_MACRO].map(escapeRegExp).join("|");
+export const MACRO_REGEX = new RegExp(`^(?:${MACROS})$`);
+// group 1 holds the macro name, so a replace can keep it
+export const MACRO_CALL_REGEX = new RegExp(`(?<![\\w$])(${MACROS})\\([^)]*\\)`, "g");

package/out/test.js

@@ -0,0 +1,20 @@
+import { $migrate, $transform } from "../index.js";
+function abc(test) {
+    // hello
+}
+function addMigration() {
+    return {
+        test: (order, fn) => undefined
+    };
+}
+abc({
+    hello: addMigration().test($migrate(0), () => {
+        // abvcdsc
+    }),
+    test: addMigration().test($migrate(1), () => {
+        // abvcdsc
+    }),
+    transform: addMigration().test($transform(2), () => {
+        // abvcdsc
+    }),
+});

package/out/util/loadMigrationEntries.js

@@ -5,10 +5,16 @@ const VAR_NAME = "MIGRATED_ENTRIES";
 function reconstructProperties(properties) {
     const obj = {};
     for (const prop of properties) {
-        if (!ts.isPropertyAssignment(prop) || !ts.isNumericLiteral(prop.initializer))
+        if (!ts.isPropertyAssignment(prop))
             continue;
         const name = ts.isIdentifier(prop.name) ? prop.name.text : prop.name.getText();
-        obj[name] = Number(prop.initializer.text);
+        const init = prop.initializer;
+        if (ts.isNumericLiteral(init))
+            obj[name] = Number(init.text);
+        else if (init.kind === ts.SyntaxKind.TrueKeyword)
+            obj[name] = true;
+        else if (init.kind === ts.SyntaxKind.FalseKeyword)
+            obj[name] = false;
     }
     return obj;
 }

package/out/util/macro.js

@@ -14,7 +14,7 @@ export function findMacroCall(node) {
     return undefined;
 }
 export function replaceMacroCall(node, order, path) {
-    if (ts.isCallExpression(node) && ts.isIdentifier(node.expression)) {
+    if (ts.isCallExpression(node)) {
         const newArgs = [];
         let changed = false;
         for (const arg of node.arguments) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rbxts-transformer-commit-migrations",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "description": "rbxts transformer used in user data migration builder chains",
   "main": "out/index.js",
   "type": "module",