refactor: build step cleanup

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/latticexyz/mud.git"
   },
   "scripts": {
-    "all-codegen": "for dir in packages/store packages/world packages/world-modules packages/cli test/mock-game-contracts e2e/packages/contracts examples/*/packages/contracts templates/*/packages/contracts; do (cd \"$dir\" && pwd && pnpm build); done",
+    "all-build": "for dir in packages/store packages/world packages/world-modules packages/cli test/mock-game-contracts e2e/packages/contracts examples/*/packages/contracts templates/*/packages/contracts; do (cd \"$dir\" && pwd && pnpm build); done",
     "all-install": "for dir in . docs e2e examples/* templates/*; do (cd \"$dir\" && pwd && pnpm install); done",
     "bench": "pnpm run --recursive bench",
     "build": "turbo run build",

packages/cli/scripts/generate-test-tables.ts

@@ -2,6 +2,7 @@ import { tablegen } from "@latticexyz/store/codegen";
 import { defineStore } from "@latticexyz/store";
 import { getRemappings } from "@latticexyz/common/foundry";
 import { fileURLToPath } from "node:url";
+import path from "node:path";
 
 const configPath = fileURLToPath(import.meta.url);
 
@@ -97,4 +98,4 @@ const config = defineStore({
 
 const remappings = await getRemappings();
 
-await tablegen({ configPath, config, remappings });
+await tablegen({ rootDir: path.dirname(configPath), config, remappings });

packages/cli/src/build.ts

@@ -10,16 +10,16 @@ type BuildOptions = {
   foundryProfile?: string;
   srcDir: string;
   /**
-   * Path to `mud.config.ts`. We use this as the "project root" to resolve other relative paths.
+   * MUD project root directory where all other relative paths are resolved from.
    *
-   * Defaults to finding the nearest `mud.config.ts`, looking in `process.cwd()` and moving up the directory tree.
+   * Defaults to the directory of the nearest `mud.config.ts`, looking in `process.cwd()` and moving up the directory tree.
    */
-  configPath: string;
+  rootDir: string;
   config: WorldConfig;
 };
 
 export async function build({
-  configPath,
+  rootDir,
   config,
   srcDir,
   foundryProfile = process.env.FOUNDRY_PROFILE,
@@ -28,7 +28,7 @@ export async function build({
   const remappings = await getRemappings(foundryProfile);
 
   await Promise.all([
-    tablegen({ configPath, config, remappings }),
+    tablegen({ rootDir, config, remappings }),
     worldgen(config, getExistingContracts(srcDir), outPath),
   ]);
 

packages/cli/src/commands/build.ts

@@ -1,9 +1,9 @@
 import type { CommandModule } from "yargs";
 import { loadConfig, resolveConfigPath } from "@latticexyz/config/node";
 import { World as WorldConfig } from "@latticexyz/world";
-
 import { getSrcDirectory } from "@latticexyz/common/foundry";
 import { build } from "../build";
+import path from "node:path";
 
 type Options = {
   configPath?: string;
@@ -27,7 +27,7 @@ const commandModule: CommandModule<Options, Options> = {
     const config = (await loadConfig(configPath)) as WorldConfig;
     const srcDir = await getSrcDirectory();
 
-    await build({ configPath, config, srcDir, foundryProfile: opts.profile });
+    await build({ rootDir: path.dirname(configPath), config, srcDir, foundryProfile: opts.profile });
 
     process.exit(0);
   },

packages/cli/src/commands/tablegen.ts

@@ -3,6 +3,7 @@ import { loadConfig, resolveConfigPath } from "@latticexyz/config/node";
 import { Store as StoreConfig } from "@latticexyz/store";
 import { tablegen } from "@latticexyz/store/codegen";
 import { getRemappings } from "@latticexyz/common/foundry";
+import path from "node:path";
 
 type Options = {
   configPath?: string;
@@ -24,7 +25,7 @@ const commandModule: CommandModule<Options, Options> = {
     const config = (await loadConfig(configPath)) as StoreConfig;
     const remappings = await getRemappings();
 
-    await tablegen({ configPath, config, remappings });
+    await tablegen({ rootDir: path.dirname(configPath), config, remappings });
 
     process.exit(0);
   },

packages/cli/src/runDeploy.ts

@@ -83,7 +83,7 @@ export async function runDeploy(opts: DeployOptions): Promise<WorldDeploy> {
 
   // Run build
   if (!opts.skipBuild) {
-    await build({ configPath, config: configV2, srcDir, foundryProfile: profile });
+    await build({ rootDir: path.dirname(configPath), config: configV2, srcDir, foundryProfile: profile });
   }
 
   const resolvedConfig = resolveConfig({ config, forgeSourceDir: srcDir, forgeOutDir: outDir });

packages/config/src/deprecated/node/loadConfig.ts

@@ -40,7 +40,7 @@ export async function loadConfig(configPath?: string): Promise<unknown> {
 }
 
 /** @deprecated */
-export async function resolveConfigPath(configPath: string | undefined, toFileURL?: boolean) {
+export async function resolveConfigPath(configPath?: string, toFileURL?: boolean) {
   if (configPath === undefined) {
     configPath = await getUserConfigPath();
   } else {

packages/store/package.json

@@ -54,7 +54,7 @@
     "build:abi": "forge build",
     "build:abi-ts": "abi-ts",
     "build:js": "tsup",
-    "build:mud": "tsx ./ts/scripts/tablegen.ts && tsx ./ts/scripts/generate-test-tables.ts",
+    "build:mud": "tsx ./ts/scripts/build.ts && tsx ./ts/scripts/generate-test-tables.ts",
     "build:tightcoder": "tsx ./ts/scripts/generate-tightcoder.ts",
     "clean": "pnpm run clean:abi && pnpm run clean:js && pnpm run clean:mud",
     "clean:abi": "forge clean",

packages/store/ts/codegen/tablegen.ts

@@ -9,13 +9,16 @@ import { Store as StoreConfig } from "../config/v2/output";
 import { storeToV1 } from "../config/v2/compat";
 
 export type TablegenOptions = {
-  configPath: string;
+  /**
+   * MUD project root directory where all other relative paths are resolved from.
+   */
+  rootDir: string;
   config: StoreConfig;
   remappings: [string, string][];
 };
 
-export async function tablegen({ configPath, config, remappings }: TablegenOptions) {
-  const outputDirectory = path.join(path.dirname(configPath), config.sourceDirectory, config.codegen.outputDirectory);
+export async function tablegen({ rootDir, config, remappings }: TablegenOptions) {
+  const outputDirectory = path.join(rootDir, config.sourceDirectory, config.codegen.outputDirectory);
   const configV1 = storeToV1(config);
   const solidityUserTypes = loadAndExtractUserTypes(configV1.userTypes, outputDirectory, remappings);
   const allTableOptions = getTableOptions(config, solidityUserTypes);

packages/store/ts/config/v2/output.ts

@@ -64,7 +64,7 @@ export type Codegen = {
 
 export type Store = {
   /**
-   * Directory of contracts source (i.e. Solidity) relative to the MUD config.
+   * Directory of Solidity source relative to the MUD config.
    * This is used to resolve other paths in the config, like codegen and user types.
    *
    * Defaults to `src` to match `foundry.toml`'s default. If you change this from the default, you may also need to configure foundry with the same source directory.

packages/store/ts/scripts/tablegen.ts → packages/store/ts/scripts/build.ts

@@ -2,13 +2,10 @@ import { loadConfig, resolveConfigPath } from "@latticexyz/config/node";
 import { getRemappings } from "@latticexyz/common/foundry";
 import { tablegen } from "../codegen";
 import { Store as StoreConfig } from "../config/v2/output";
+import path from "node:path";
 
 const configPath = await resolveConfigPath(undefined);
 const config = (await loadConfig(configPath)) as StoreConfig;
 const remappings = await getRemappings();
 
-await tablegen({
-  configPath,
-  config,
-  remappings,
-});
+await tablegen({ rootDir: path.dirname(configPath), config, remappings });

packages/store/ts/scripts/generate-test-tables.ts

@@ -2,6 +2,7 @@ import { getRemappings } from "@latticexyz/common/foundry";
 import { tablegen } from "../codegen";
 import { defineStore } from "../config/v2/store";
 import { fileURLToPath } from "node:url";
+import path from "node:path";
 
 const configPath = fileURLToPath(import.meta.url);
 
@@ -53,4 +54,4 @@ const config = defineStore({
 
 const remappings = await getRemappings();
 
-await tablegen({ configPath, config, remappings });
+await tablegen({ rootDir: path.dirname(configPath), config, remappings });

packages/world-modules/ts/scripts/tablegen.ts

@@ -2,13 +2,10 @@ import { loadConfig, resolveConfigPath } from "@latticexyz/config/node";
 import { getRemappings } from "@latticexyz/common/foundry";
 import { Store as StoreConfig } from "@latticexyz/store";
 import { tablegen } from "@latticexyz/store/codegen";
+import path from "node:path";
 
-const configPath = await resolveConfigPath(undefined);
+const configPath = await resolveConfigPath();
 const config = (await loadConfig(configPath)) as StoreConfig;
 const remappings = await getRemappings();
 
-await tablegen({
-  configPath,
-  config,
-  remappings,
-});
+await tablegen({ rootDir: path.dirname(configPath), config, remappings });

packages/world/package.json

@@ -51,7 +51,7 @@
     "build:abi": "forge build",
     "build:abi-ts": "abi-ts",
     "build:js": "tsup",
-    "build:mud": "tsx ./ts/scripts/tablegen.ts && tsx ./ts/scripts/worldgen.ts && tsx ./ts/scripts/generate-test-tables.ts",
+    "build:mud": "tsx ./ts/scripts/build.ts && tsx ./ts/scripts/generate-test-tables.ts",
     "clean": "pnpm run clean:abi && pnpm run clean:js && pnpm run clean:mud",
     "clean:abi": "forge clean",
     "clean:js": "rimraf dist",

packages/world/ts/node/findSolidityFiles.ts

@@ -0,0 +1,14 @@
+import path from "node:path";
+import { glob } from "glob";
+import { World } from "../config/v2/output";
+
+export async function findSolidityFiles({ rootDir, config }: { rootDir: string; config: World }) {
+  const files = await glob(path.join(config.sourceDirectory, "**", "*.sol"), {
+    cwd: rootDir,
+  });
+
+  return files.sort().map((filename) => ({
+    filename,
+    basename: path.basename(filename, ".sol"),
+  }));
+}

packages/world/ts/scripts/build.ts

@@ -0,0 +1,41 @@
+import path from "node:path";
+import { loadConfig, resolveConfigPath } from "@latticexyz/config/node";
+import { getRemappings } from "@latticexyz/common/foundry";
+import { tablegen } from "@latticexyz/store/codegen";
+import { findSolidityFiles } from "../node/findSolidityFiles";
+import { World } from "../config/v2";
+import { worldgen } from "../node";
+
+/**
+ * To avoid circular dependencies, we run a very similar `build` step as `cli` package here.
+ */
+
+// TODO: turn this into something we can run from CLI, then we can import/use it via CLI and here rather than duplicating.
+// TODO: do the same for store build too
+
+const configPath = await resolveConfigPath();
+const rootDir = path.dirname(configPath);
+const config = (await loadConfig(configPath)) as World;
+const remappings = await getRemappings();
+
+// TODO: move this into worldgen
+const existingContracts = (await findSolidityFiles({ rootDir, config })).map((file) => ({
+  path: file.filename,
+  basename: file.basename,
+}));
+const codegenDirectory = path.join(config.sourceDirectory, config.codegen.outputDirectory);
+
+// TODO: clean
+
+await Promise.all([
+  tablegen({ rootDir, config, remappings }),
+  worldgen(
+    {
+      ...config,
+      // override the namespace to be the root namespace for generating the core system interface
+      namespace: "",
+    },
+    existingContracts,
+    codegenDirectory,
+  ),
+]);

packages/world/ts/scripts/generate-test-tables.ts

@@ -2,6 +2,7 @@ import { getRemappings } from "@latticexyz/common/foundry";
 import { tablegen } from "@latticexyz/store/codegen";
 import { defineWorld } from "../config/v2/world";
 import { fileURLToPath } from "node:url";
+import path from "node:path";
 
 const configPath = fileURLToPath(import.meta.url);
 
@@ -42,4 +43,4 @@ const config = defineWorld({
 
 const remappings = await getRemappings();
 
-await tablegen({ configPath, config, remappings });
+await tablegen({ rootDir: path.dirname(configPath), config, remappings });