@latticexyz/cli 2.0.0-alpha.37 → 2.0.0-alpha.39

package/dist/mud.js

@@ -11264,9 +11264,9 @@ var commandModule11 = {
       compare: { type: "string", desc: "Compare to an existing gas report" }
     });
   },
-  async handler({ path: path8, save, compare: compare2 }) {
+  async handler({ path: path9, save, compare: compare2 }) {
     let gasReport = [];
-    for (const file of path8) {
+    for (const file of path9) {
       gasReport = gasReport.concat(await runGasReport(file));
     }
     const compareGasReport = [];
@@ -11298,14 +11298,14 @@ var commandModule11 = {
   }
 };
 var gas_report_default = commandModule11;
-async function runGasReport(path8) {
-  if (!path8.endsWith(".t.sol")) {
-    console.log("Skipping gas report for", chalk3.bold(path8), "(not a test file)");
+async function runGasReport(path9) {
+  if (!path9.endsWith(".t.sol")) {
+    console.log("Skipping gas report for", chalk3.bold(path9), "(not a test file)");
     return [];
   }
-  console.log("Running gas report for", chalk3.bold(path8));
+  console.log("Running gas report for", chalk3.bold(path9));
   const gasReport = [];
-  const fileContents = readFileSync2(path8, "utf8");
+  const fileContents = readFileSync2(path9, "utf8");
   let newFile = fileContents;
   const functionRegex = new RegExp(/function (.*){/g);
   let functionMatch;
@@ -11329,7 +11329,7 @@ console.log("GAS REPORT: ${name} [${functionCall.replaceAll('"', '\\"')}]:", _ga
     );
   }
   newFile = newFile.replace(/pure/g, "view");
-  const tempFileName = path8.replace(/\.t\.sol$/, "MudGasReport.t.sol");
+  const tempFileName = path9.replace(/\.t\.sol$/, "MudGasReport.t.sol");
   writeFileSync(tempFileName, newFile);
   const child = execa2("forge", ["test", "--match-path", tempFileName, "-vvv"], {
     stdio: ["inherit", "pipe", "inherit"]
@@ -11350,7 +11350,7 @@ console.log("GAS REPORT: ${name} [${functionCall.replaceAll('"', '\\"')}]:", _ga
     const name = gasReportMatch[1];
     const functionCall = gasReportMatch[2].replace(";", "");
     const gasUsed = gasReportMatch[3];
-    gasReport.push({ source: path8, name, functionCall, gasUsed: parseInt(gasUsed) });
+    gasReport.push({ source: path9, name, functionCall, gasUsed: parseInt(gasUsed) });
   }
   return gasReport;
 }
@@ -11374,10 +11374,10 @@ function printGasReport(gasReport, compare2) {
   const rows = [headers, ...values];
   console.log(table(rows, { border: getBorderCharacters("norc") }));
 }
-function saveGasReport(gasReport, path8) {
-  console.log(chalk3.bold(`Saving gas report to ${path8}`));
+function saveGasReport(gasReport, path9) {
+  console.log(chalk3.bold(`Saving gas report to ${path9}`));
   const serializedGasReport = gasReport.map((entry) => `(${entry.source}) | ${entry.name} [${entry.functionCall}]: ${entry.gasUsed}`).join("\n");
-  writeFileSync(path8, serializedGasReport);
+  writeFileSync(path9, serializedGasReport);
 }
 
 // src/commands/hello.ts
@@ -11483,7 +11483,7 @@ var commandModule15 = {
       await forge(["clean"], { profile });
     await forge(["build"], { profile });
     const srcDir = await getSrcDirectory();
-    const existingContracts = glob.sync(`${srcDir}/**/*.sol`).map((path8) => basename(path8, ".sol"));
+    const existingContracts = glob.sync(`${srcDir}/**/*.sol`).map((path9) => basename(path9, ".sol"));
     const worldConfig = await loadWorldConfig(configPath, existingContracts);
     const storeConfig = await loadStoreConfig(configPath);
     const mudConfig = { ...worldConfig, ...storeConfig };
@@ -11724,9 +11724,9 @@ var commandModule16 = {
   async handler(args) {
     const { configPath, clean } = args;
     const srcDir = await getSrcDirectory();
-    const existingContracts = glob2.sync(`${srcDir}/**/*.sol`).map((path8) => ({
-      path: path8,
-      basename: basename2(path8, ".sol")
+    const existingContracts = glob2.sync(`${srcDir}/**/*.sol`).map((path9) => ({
+      path: path9,
+      basename: basename2(path9, ".sol")
     }));
     const worldConfig = await loadWorldConfig(
       configPath,
@@ -11742,6 +11742,203 @@ var commandModule16 = {
 };
 var worldgen_default = commandModule16;
 
+// src/commands/set-version.ts
+import chalk5 from "chalk";
+import { existsSync, readFileSync as readFileSync4, rmSync as rmSync4, writeFileSync as writeFileSync3 } from "fs";
+import path8 from "path";
+
+// package.json
+var package_default = {
+  name: "@latticexyz/cli",
+  version: "2.0.0-alpha.39+9af097de",
+  description: "Command line interface for mud",
+  main: "dist/index.js",
+  types: "dist/index.d.ts",
+  type: "module",
+  license: "MIT",
+  bin: {
+    mud: "./dist/mud.js"
+  },
+  repository: {
+    type: "git",
+    url: "https://github.com/latticexyz/mud.git",
+    directory: "packages/cli"
+  },
+  scripts: {
+    prepare: "yarn build && chmod u+x git-install.sh",
+    codegen: "ts-node --esm --files ./scripts/codegen.ts",
+    lint: "eslint . --ext .ts",
+    dev: "tsup --watch",
+    build: "tsup",
+    link: "yarn link",
+    test: "vitest typecheck --run && yarn test:contracts",
+    "test:contracts": "yarn codegen && forge test",
+    "git:install": "bash git-install.sh",
+    release: "npm publish --access=public"
+  },
+  devDependencies: {
+    "@latticexyz/store": "^2.0.0-alpha.39+9af097de",
+    "@types/ejs": "^3.1.1",
+    "@types/glob": "^7.2.0",
+    "@types/node": "^17.0.34",
+    "@types/openurl": "^1.0.0",
+    "@types/yargs": "^17.0.10",
+    esbuild: "^0.15.16",
+    tsup: "^6.6.3",
+    vitest: "^0.29.8"
+  },
+  dependencies: {
+    "@improbable-eng/grpc-web": "^0.15.0",
+    "@improbable-eng/grpc-web-node-http-transport": "^0.15.0",
+    "@latticexyz/schema-type": "^2.0.0-alpha.39+9af097de",
+    "@latticexyz/services": "^2.0.0-alpha.39+9af097de",
+    "@latticexyz/solecs": "^2.0.0-alpha.39+9af097de",
+    "@latticexyz/std-contracts": "^2.0.0-alpha.39+9af097de",
+    "@solidity-parser/parser": "^0.16.0",
+    "@typechain/ethers-v5": "^10.1.1",
+    chalk: "^5.0.1",
+    chokidar: "^3.5.3",
+    dotenv: "^16.0.3",
+    "ds-test": "https://github.com/dapphub/ds-test.git#c9ce3f25bde29fc5eb9901842bf02850dfd2d084",
+    ejs: "^3.1.8",
+    ethers: "^5.7.2",
+    execa: "^7.0.0",
+    "find-up": "^6.3.0",
+    "forge-std": "https://github.com/foundry-rs/forge-std.git#b4f121555729b3afb3c5ffccb62ff4b6e2818fd3",
+    glob: "^8.0.3",
+    "nice-grpc-web": "^2.0.1",
+    openurl: "^1.1.1",
+    path: "^0.12.7",
+    prettier: "^2.8.4",
+    "prettier-plugin-solidity": "^1.1.2",
+    solmate: "https://github.com/Rari-Capital/solmate.git#9cf1428245074e39090dceacb0c28b1f684f584c",
+    table: "^6.8.1",
+    "ts-node": "^10.9.1",
+    typechain: "^8.1.1",
+    typescript: "^4.9.5",
+    yargs: "^17.7.1",
+    zod: "^3.21.4",
+    "zod-validation-error": "^1.0.1"
+  },
+  gitHead: "9af097de7914d0c43b7d65ca6271260439bc6bc4"
+};
+
+// src/commands/set-version.ts
+var BACKUP_FILE = ".mudbackup";
+var MUD_PREFIX = "@latticexyz";
+var commandModule17 = {
+  command: "set-version",
+  describe: "Install a custom MUD version and optionally backup the previously installed version",
+  builder(yargs2) {
+    return yargs2.options({
+      backup: { type: "boolean", description: `Back up the current MUD versions to "${BACKUP_FILE}"` },
+      force: {
+        type: "boolean",
+        description: `Backup fails if a "${BACKUP_FILE}" file is found, unless --force is provided`
+      },
+      restore: { type: "boolean", description: `Restore the previous MUD versions from "${BACKUP_FILE}"` },
+      mudVersion: { alias: "v", type: "string", description: "The MUD version to install" }
+    });
+  },
+  async handler(options) {
+    try {
+      if (!options.mudVersion && !options.restore) {
+        throw new MUDError(`Version parameter is required unless --restore is provided.`);
+      }
+      options.mudVersion = options.mudVersion === "canary" ? await getCanaryVersion(package_default.name) : options.mudVersion;
+      const rootPath = "./package.json";
+      const { workspaces } = updatePackageJson(rootPath, options);
+      if (workspaces) {
+        for (const workspace of workspaces) {
+          const filePath = path8.join(workspace, "/package.json");
+          updatePackageJson(filePath, options);
+        }
+      }
+    } catch (e) {
+      logError(e);
+    } finally {
+      process.exit(0);
+    }
+  }
+};
+function updatePackageJson(filePath, options) {
+  const { backup, restore, force, mudVersion } = options;
+  const backupFilePath = path8.join(path8.dirname(filePath), BACKUP_FILE);
+  if (backup && !force && existsSync(backupFilePath)) {
+    throw new MUDError(
+      `A backup file already exists at ${backupFilePath}.
+Use --force to overwrite it or --restore to restore it.`
+    );
+  }
+  const packageJson = readPackageJson(filePath);
+  const backupJson = restore ? readPackageJson(backupFilePath) : void 0;
+  const mudDependencies = {};
+  for (const key in packageJson.dependencies) {
+    if (key.startsWith(MUD_PREFIX)) {
+      mudDependencies[key] = packageJson.dependencies[key];
+    }
+  }
+  const mudDevDependencies = {};
+  for (const key in packageJson.devDependencies) {
+    if (key.startsWith(MUD_PREFIX)) {
+      mudDevDependencies[key] = packageJson.devDependencies[key];
+    }
+  }
+  if (backup) {
+    writeFileSync3(
+      backupFilePath,
+      JSON.stringify({ dependencies: mudDependencies, devDependencies: mudDevDependencies }, null, 2)
+    );
+    console.log(chalk5.green(`Backed up MUD dependencies from ${filePath} to ${backupFilePath}`));
+  }
+  for (const key in packageJson.dependencies) {
+    if (key.startsWith(MUD_PREFIX)) {
+      packageJson.dependencies[key] = restore && backupJson ? backupJson.dependencies[key] : mudVersion || packageJson.dependencies[key];
+    }
+  }
+  for (const key in packageJson.devDependencies) {
+    if (key.startsWith(MUD_PREFIX)) {
+      packageJson.devDependencies[key] = restore && backupJson ? backupJson.devDependencies[key] : mudVersion || packageJson.devDependencies[key];
+    }
+  }
+  writeFileSync3(filePath, JSON.stringify(packageJson, null, 2) + "\n");
+  console.log(`Updating ${filePath}`);
+  logComparison(mudDependencies, packageJson.dependencies);
+  logComparison(mudDevDependencies, packageJson.devDependencies);
+  if (restore && !backup) {
+    rmSync4(backupFilePath);
+    console.log(chalk5.green(`Cleaned up ${backupFilePath}`));
+  }
+  return packageJson;
+}
+function readPackageJson(path9) {
+  try {
+    const jsonString = readFileSync4(path9, "utf8");
+    return JSON.parse(jsonString);
+  } catch {
+    throw new MUDError("Could not read JSON at " + path9);
+  }
+}
+async function getCanaryVersion(pkg) {
+  try {
+    console.log(chalk5.blue("fetching MUD canary version..."));
+    const result = await (await fetch(`https://registry.npmjs.org/${pkg}`)).json();
+    const canary = result["dist-tags"].canary;
+    console.log(chalk5.green("MUD canary version:", canary));
+    return canary;
+  } catch (e) {
+    throw new MUDError(`Could not fetch canary version of ${pkg}`);
+  }
+}
+function logComparison(prev, curr) {
+  for (const key in prev) {
+    if (prev[key] !== curr[key]) {
+      console.log(`${key}: ${chalk5.red(prev[key])} -> ${chalk5.green(curr[key])}`);
+    }
+  }
+}
+var set_version_default = commandModule17;
+
 // src/commands/index.ts
 var commands = [
   bulkupload_default,
@@ -11759,7 +11956,8 @@ var commands = [
   test_default,
   trace_default,
   types_default,
-  worldgen_default
+  worldgen_default,
+  set_version_default
 ];
 
 // src/mud.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/cli",
-  "version": "2.0.0-alpha.37+dd1efa6a",
+  "version": "2.0.0-alpha.39+9af097de",
   "description": "Command line interface for mud",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,7 +27,7 @@
     "release": "npm publish --access=public"
   },
   "devDependencies": {
-    "@latticexyz/store": "^2.0.0-alpha.37+dd1efa6a",
+    "@latticexyz/store": "^2.0.0-alpha.39+9af097de",
     "@types/ejs": "^3.1.1",
     "@types/glob": "^7.2.0",
     "@types/node": "^17.0.34",
@@ -40,10 +40,10 @@
   "dependencies": {
     "@improbable-eng/grpc-web": "^0.15.0",
     "@improbable-eng/grpc-web-node-http-transport": "^0.15.0",
-    "@latticexyz/schema-type": "^2.0.0-alpha.37+dd1efa6a",
-    "@latticexyz/services": "^2.0.0-alpha.37+dd1efa6a",
-    "@latticexyz/solecs": "^2.0.0-alpha.37+dd1efa6a",
-    "@latticexyz/std-contracts": "^2.0.0-alpha.37+dd1efa6a",
+    "@latticexyz/schema-type": "^2.0.0-alpha.39+9af097de",
+    "@latticexyz/services": "^2.0.0-alpha.39+9af097de",
+    "@latticexyz/solecs": "^2.0.0-alpha.39+9af097de",
+    "@latticexyz/std-contracts": "^2.0.0-alpha.39+9af097de",
     "@solidity-parser/parser": "^0.16.0",
     "@typechain/ethers-v5": "^10.1.1",
     "chalk": "^5.0.1",
@@ -70,5 +70,5 @@
     "zod": "^3.21.4",
     "zod-validation-error": "^1.0.1"
   },
-  "gitHead": "dd1efa6a1ebd2b3c62080d1b191633d7b0072916"
+  "gitHead": "9af097de7914d0c43b7d65ca6271260439bc6bc4"
 }

package/src/commands/index.ts

@@ -17,6 +17,7 @@ import tablegen from "./tablegen.js";
 import tsgen from "./tsgen.js";
 import deployV2 from "./deploy-v2.js";
 import worldgen from "./worldgen.js";
+import setVersion from "./set-version.js";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Each command has different options
 export const commands: CommandModule<any, any>[] = [
@@ -36,4 +37,5 @@ export const commands: CommandModule<any, any>[] = [
   trace,
   types,
   worldgen,
+  setVersion,
 ];

package/src/commands/set-version.ts

@@ -0,0 +1,171 @@
+import chalk from "chalk";
+import { existsSync, readFileSync, rmSync, writeFileSync } from "fs";
+import path from "path";
+import type { CommandModule } from "yargs";
+import { logError, MUDError } from "../utils/errors.js";
+import localPackageJson from "../../package.json";
+
+type Options = {
+  backup?: boolean;
+  force?: boolean;
+  restore?: boolean;
+  mudVersion?: string;
+};
+
+const BACKUP_FILE = ".mudbackup";
+const MUD_PREFIX = "@latticexyz";
+
+const commandModule: CommandModule<Options, Options> = {
+  command: "set-version",
+
+  describe: "Install a custom MUD version and optionally backup the previously installed version",
+
+  builder(yargs) {
+    return yargs.options({
+      backup: { type: "boolean", description: `Back up the current MUD versions to "${BACKUP_FILE}"` },
+      force: {
+        type: "boolean",
+        description: `Backup fails if a "${BACKUP_FILE}" file is found, unless --force is provided`,
+      },
+      restore: { type: "boolean", description: `Restore the previous MUD versions from "${BACKUP_FILE}"` },
+      mudVersion: { alias: "v", type: "string", description: "The MUD version to install" },
+    });
+  },
+
+  async handler(options) {
+    try {
+      if (!options.mudVersion && !options.restore) {
+        throw new MUDError(`Version parameter is required unless --restore is provided.`);
+      }
+
+      // Resolve the `canary` version number if needed
+      options.mudVersion =
+        options.mudVersion === "canary" ? await getCanaryVersion(localPackageJson.name) : options.mudVersion;
+
+      // Read the current package.json
+      const rootPath = "./package.json";
+      const { workspaces } = updatePackageJson(rootPath, options);
+
+      // Load the package.json of each workspace
+      if (workspaces) {
+        for (const workspace of workspaces) {
+          const filePath = path.join(workspace, "/package.json");
+          updatePackageJson(filePath, options);
+        }
+      }
+    } catch (e) {
+      logError(e);
+    } finally {
+      process.exit(0);
+    }
+  },
+};
+
+function updatePackageJson(filePath: string, options: Options): { workspaces?: string[] } {
+  const { backup, restore, force, mudVersion } = options;
+  const backupFilePath = path.join(path.dirname(filePath), BACKUP_FILE);
+
+  // If `backup` is true and force not set, check if a backup file already exists and throw an error if it does
+  if (backup && !force && existsSync(backupFilePath)) {
+    throw new MUDError(
+      `A backup file already exists at ${backupFilePath}.\nUse --force to overwrite it or --restore to restore it.`
+    );
+  }
+
+  const packageJson = readPackageJson(filePath);
+
+  // Load .mudbackup if `restore` is true
+  const backupJson = restore ? readPackageJson(backupFilePath) : undefined;
+
+  // Find all MUD dependencies
+  const mudDependencies: Record<string, string> = {};
+  for (const key in packageJson.dependencies) {
+    if (key.startsWith(MUD_PREFIX)) {
+      mudDependencies[key] = packageJson.dependencies[key];
+    }
+  }
+
+  // Find all MUD devDependencies
+  const mudDevDependencies: Record<string, string> = {};
+  for (const key in packageJson.devDependencies) {
+    if (key.startsWith(MUD_PREFIX)) {
+      mudDevDependencies[key] = packageJson.devDependencies[key];
+    }
+  }
+
+  // Back up the current dependencies if `backup` is true
+  if (backup) {
+    writeFileSync(
+      backupFilePath,
+      JSON.stringify({ dependencies: mudDependencies, devDependencies: mudDevDependencies }, null, 2)
+    );
+    console.log(chalk.green(`Backed up MUD dependencies from ${filePath} to ${backupFilePath}`));
+  }
+
+  // Update the dependencies
+  for (const key in packageJson.dependencies) {
+    if (key.startsWith(MUD_PREFIX)) {
+      packageJson.dependencies[key] =
+        restore && backupJson ? backupJson.dependencies[key] : mudVersion || packageJson.dependencies[key];
+    }
+  }
+
+  // Update the devDependencies
+  for (const key in packageJson.devDependencies) {
+    if (key.startsWith(MUD_PREFIX)) {
+      packageJson.devDependencies[key] =
+        restore && backupJson ? backupJson.devDependencies[key] : mudVersion || packageJson.devDependencies[key];
+    }
+  }
+
+  // Write the updated package.json
+  writeFileSync(filePath, JSON.stringify(packageJson, null, 2) + "\n");
+
+  console.log(`Updating ${filePath}`);
+  logComparison(mudDependencies, packageJson.dependencies);
+  logComparison(mudDevDependencies, packageJson.devDependencies);
+
+  // Remove the backup file if `restore` is true and `backup` is false
+  // because the old backup file is no longer needed
+  if (restore && !backup) {
+    rmSync(backupFilePath);
+    console.log(chalk.green(`Cleaned up ${backupFilePath}`));
+  }
+
+  return packageJson;
+}
+
+function readPackageJson(path: string): {
+  workspaces?: string[];
+  dependencies: Record<string, string>;
+  devDependencies: Record<string, string>;
+} {
+  try {
+    const jsonString = readFileSync(path, "utf8");
+    return JSON.parse(jsonString);
+  } catch {
+    throw new MUDError("Could not read JSON at " + path);
+  }
+}
+
+async function getCanaryVersion(pkg: string) {
+  try {
+    console.log(chalk.blue("fetching MUD canary version..."));
+    const result = await (await fetch(`https://registry.npmjs.org/${pkg}`)).json();
+    const canary = result["dist-tags"].canary;
+    console.log(chalk.green("MUD canary version:", canary));
+    return canary;
+  } catch (e) {
+    throw new MUDError(`Could not fetch canary version of ${pkg}`);
+  }
+}
+
+function logComparison(prev: Record<string, string>, curr: Record<string, string>) {
+  for (const key in prev) {
+    if (prev[key] !== curr[key]) {
+      console.log(`${key}: ${chalk.red(prev[key])} -> ${chalk.green(curr[key])}`);
+    }
+  }
+}
+
+export default commandModule;