spacetime.json config implementation (#4199)

# Description of Changes

This PR implements support for the `spacetime.json` configuration file
that can be used to set up common `generate` and `publish` targets. An
example of `spacetime.json` could look like this:

```
{
  "dev_run": "pnpm dev",
  "generate": [
    { "out-dir": "./foobar", "module-path": "region-module", "language": "c-sharp" },
    { "out-dir": "./global", "module-path": "global-module", "language": "c-sharp" },
  ],
  "publish": {
    "database": "bitcraft",
    "module-path": "spacetimedb",
    "server": "local",
    "children": [
      { "database": "region-1", "module-path": "region-module", server: "local" },
      { "database": "region-2", "module-path": "region-module", server: "local" }
    ]
  }
}
```

With this config, running `spacetime generate` without any arguments
would generate bindings for two targets: `region-module` and
`global-module`. `spacetime publish` without any arguments would publish
three modules, starting from the parent: `bitcraft`, `region-1`, and
`region-2`. On top of that, the command `pnpm dev` would be executed
when using `spacetime dev`.

It is also possible to pass additional command line arguments when
calling the `publish` and `generate` commands, but there are certain
limitations. There is a special case when passing either a module path
to generate or a module name to publish. Doing that will filter out
entries in the config file that do not match. For example, running:

```
spacetime generate --project-path global-module
```

would only generate bindings for the second entry in the `generate`
list.

In a similar fashion, running:

```
spacetime publish region-1
```

would only publish the child database with the name `region-1`

Passing other existing arguments is also possible, but not all of the
arguments are available for multiple configs. For example, when running
`spacetime publish --server maincloud`, the publish command would be
applied to all of the modules listed in the config file, but the
`server` value from the command line arguments would take precedence.
Running with arguments like `--bin-path` would, however, would throw an
error as `--bin-path` makes sense only in a context of a specific
module, thus this wouldn't work: `spacetime publish --bin-path
spacetimedb/target/debug/bitcraft.wasm`. I will throw an error unless
there is only one entry to process, thus `spacetime publish --bin-path
spacetimedb/target/debug/bitcraft.wasm bitcraft` would work, as it
filters the publish targets to one entry.

# API and ABI breaking changes

None

# Expected complexity level and risk

3

The config file in itself is not overly complex, but when coupled with
the CLI it is somewhat tricky to get right. There are also some changes
that I had to make to how clap arguments are validated - because the
values can now come from both the config file and the clap config, we
can't use some of the built-in validations like `required`, or at least
I haven't found a clean way to do so.

# Testing

I've added some automated tests, but more tests and manual testing is
coming.

---------

Signed-off-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>
Co-authored-by: bradleyshep <148254416+bradleyshep@users.noreply.github.com>
Co-authored-by: clockwork-labs-bot <clockwork-labs-bot@users.noreply.github.com>
Co-authored-by: = <cloutiertyler@gmail.com>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com>

Author: 4 people

Cargo.lock

@@ -220,6 +220,7 @@ insta = { version = "1.21.0", features = ["toml", "filters"] }
 is-terminal = "0.4"
 itertools = "0.12"
 itoa = "1"
+json5 = "0.4"
 jsonwebtoken = { package = "spacetimedb-jsonwebtoken", version = "9.3.0" }
 junction = "1"
 jwks = { package = "spacetimedb-jwks", version = "0.1.3" }

Cargo.toml

@@ -68,7 +68,7 @@ cd crates/bindings-cpp/tests/client-comparison
 ```bash
 # Rust baseline
 cd rust-sdk-test
-spacetime generate --lang rust --out-dir . --project-path ../../../modules/sdk-test
+spacetime generate --lang rust --out-dir . --module-path ../../../modules/sdk-test
 
 # Rust baseline
 ./scripts/regenerate_rust_client.sh

crates/bindings-cpp/tests/client-comparison/README.md

@@ -75,7 +75,7 @@ fi
 # Generate new Rust client
 echo "Generating new Rust client from sdk-test module..."
 cd "$RUST_DIR"
-"$CLI_PATH" generate --lang rust --out-dir . --project-path "$SDK_TEST_DIR" >/dev/null 2>&1
+"$CLI_PATH" generate --lang rust --out-dir . --module-path "$SDK_TEST_DIR" >/dev/null 2>&1
 
 if [ $? -eq 0 ]; then
     echo ""

crates/bindings-cpp/tests/client-comparison/scripts/regenerate_rust_client.sh

@@ -13,10 +13,10 @@
     "lint": "eslint . && prettier . --check --ignore-path ../../../.prettierignore",
     "preview": "vite preview",
     "generate": "cargo run -p gen-bindings -- --replacement ../../../src/index && prettier --write src/module_bindings",
-    "spacetime:generate": "spacetime generate --lang typescript --out-dir src/module_bindings --project-path server",
-    "spacetime:start": "spacetime start server",
-    "spacetime:publish:local": "spacetime publish game --project-path server --server local",
-    "spacetime:publish": "spacetime publish game --project-path server --server maincloud"
+    "spacetime:generate": "spacetime generate --lang typescript --out-dir src/module_bindings --module-path server",
+    "spacetime:start": "spacetime start",
+    "spacetime:publish:local": "spacetime publish game --module-path server --server local",
+    "spacetime:publish": "spacetime publish game --module-path server --server maincloud"
   },
   "dependencies": {
     "react": "^18.3.1",

crates/bindings-typescript/test-react-router-app/package.json

@@ -49,6 +49,7 @@ http.workspace = true
 is-terminal.workspace = true
 itertools.workspace = true
 indicatif.workspace = true
+json5.workspace = true
 jsonwebtoken.workspace = true
 mimalloc.workspace = true
 percent-encoding.workspace = true
@@ -76,6 +77,7 @@ wasmbin.workspace = true
 webbrowser.workspace = true
 clap-markdown.workspace = true
 git2.workspace = true
+glob.workspace = true
 dialoguer = { workspace = true, features = ["fuzzy-select"] }
 rolldown.workspace = true
 rolldown_common.workspace = true

crates/cli/Cargo.toml

@@ -4,6 +4,7 @@ mod config;
 pub(crate) mod detect;
 mod edit_distance;
 mod errors;
+pub mod spacetime_config;
 mod subcommands;
 mod tasks;
 pub mod util;