spacetime init WIP

drogus · drogus · commit ffd2ce3adddd · 2025-10-10T14:50:07.000+02:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -184,6 +184,7 @@ futures = "0.3"
 futures-channel = "0.3"
 futures-util = "0.3"
 getrandom02 = { package = "getrandom", version = "0.2" }
+git2 = "0.19"
 glob = "0.3.1"
 hashbrown = { version = "0.15", default-features = false, features = ["equivalent", "inline-more"] }
 headers = "0.4"
diff --git a/crates/bindings-typescript/examples/empty/.gitignore b/crates/bindings-typescript/examples/empty/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/crates/bindings-typescript/examples/empty/index.html b/crates/bindings-typescript/examples/empty/index.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>SpacetimeDB App</title>
+  </head>
+  <body>
+    <h1>SpacetimeDB App</h1>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/crates/bindings-typescript/examples/empty/package.json b/crates/bindings-typescript/examples/empty/package.json
@@ -0,0 +1,18 @@
+{
+  "name": "@clockworklabs/empty-client",
+  "private": true,
+  "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "spacetimedb": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "~5.6.2",
+    "vite": "^7.1.5"
+  }
+}
diff --git a/crates/bindings-typescript/examples/empty/src/main.ts b/crates/bindings-typescript/examples/empty/src/main.ts
@@ -0,0 +1 @@
+console.log('SpacetimeDB client ready');
diff --git a/crates/bindings-typescript/examples/empty/tsconfig.json b/crates/bindings-typescript/examples/empty/tsconfig.json
@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"]
+}
diff --git a/crates/bindings-typescript/examples/empty/vite.config.ts b/crates/bindings-typescript/examples/empty/vite.config.ts
@@ -0,0 +1,3 @@
+import { defineConfig } from 'vite';
+
+export default defineConfig({});
diff --git a/crates/cli/.init-templates.json b/crates/cli/.init-templates.json
@@ -0,0 +1,11 @@
+{
+  "templates": [
+    {
+      "name": "Quickstart (Rust)",
+      "server_lang": "rust",
+      "client_lang": "rust",
+      "server_source": "clockworklabs/SpacetimeDB/modules/quickstart-chat",
+      "client_source": "clockworklabs/SpacetimeDB/./sdks/rust/examples/quickstart-chat"
+    },
+  ]
+}
diff --git a/crates/cli/Cargo.toml b/crates/cli/Cargo.toml
@@ -74,6 +74,8 @@ walkdir.workspace = true
 wasmbin.workspace = true
 webbrowser.workspace = true
 clap-markdown.workspace = true
+git2.workspace = true
+dialoguer.workspace = true
 
 [target.'cfg(not(target_env = "msvc"))'.dependencies]
 tikv-jemallocator = { workspace = true }
diff --git a/crates/cli/src/subcommands/init.rs b/crates/cli/src/subcommands/init.rs
@@ -1,3 +1,4 @@
+use crate::tasks::init_template;
 use crate::util::ModuleLanguage;
 use crate::Config;
 use crate::{detect::find_executable, util::UNSTABLE_WARNING};
@@ -17,12 +18,31 @@ pub fn cli() -> clap::Command {
         )
         .arg(
             Arg::new("lang")
-                .required(true)
                 .short('l')
                 .long("lang")
                 .help("The spacetime module language.")
                 .value_parser(clap::value_parser!(ModuleLanguage)),
         )
+        .arg(
+            Arg::new("template")
+                .short('t')
+                .long("template")
+                .value_name("TEMPLATE")
+                .help("GitHub repository template (owner/repo or URL)"),
+        )
+        .arg(
+            Arg::new("client-lang")
+                .long("client-lang")
+                .value_name("LANG")
+                .default_value("typescript")
+                .help("Client language: typescript, none"),
+        )
+        .arg(
+            Arg::new("local")
+                .long("local")
+                .action(clap::ArgAction::SetTrue)
+                .help("Use local deployment instead of Maincloud (non-interactive mode only)"),
+        )
 }
 
 fn check_for_cargo() -> bool {
@@ -113,40 +133,22 @@ fn check_for_git() -> bool {
     false
 }
 
-pub async fn exec(_config: Config, args: &ArgMatches) -> Result<(), anyhow::Error> {
+pub async fn exec(mut config: Config, args: &ArgMatches) -> Result<(), anyhow::Error> {
     eprintln!("{UNSTABLE_WARNING}\n");
 
     let project_path = args.get_one::<PathBuf>("project-path").unwrap();
-    let project_lang = *args.get_one::<ModuleLanguage>("lang").unwrap();
-
-    // Create the project path, or make sure the target project path is empty.
-    if project_path.exists() {
-        if !project_path.is_dir() {
-            return Err(anyhow::anyhow!(
-                "Path {} exists but is not a directory. A new SpacetimeDB project must be initialized in an empty directory.",
-                project_path.display()
-            ));
-        }
+    let template = args.get_one::<String>("template");
 
-        if std::fs::read_dir(project_path).unwrap().count() > 0 {
-            return Err(anyhow::anyhow!(
-                "Cannot create new SpacetimeDB project in non-empty directory: {}",
-                project_path.display()
-            ));
-        }
-    } else {
-        create_directory(project_path)?;
+    // if a user passes a template run non interactive
+    // TODO: enhance this, it should check other args, too
+    if let Some(template_str) = template {
+        return init_template::exec_template_init(&mut config, args, project_path, template_str).await;
     }
 
-    match project_lang {
-        ModuleLanguage::Rust => exec_init_rust(args).await,
-        ModuleLanguage::Csharp => exec_init_csharp(args).await,
-    }
+    init_template::exec_interactive_init(&mut config, project_path).await
 }
 
-pub async fn exec_init_rust(args: &ArgMatches) -> Result<(), anyhow::Error> {
-    let project_path = args.get_one::<PathBuf>("project-path").unwrap();
-
+pub fn init_rust_project(project_path: &Path) -> Result<(), anyhow::Error> {
     let export_files = vec![
         (include_str!("project/rust/Cargo._toml"), "Cargo.toml"),
         (include_str!("project/rust/lib._rs"), "src/lib.rs"),
@@ -156,46 +158,52 @@ pub async fn exec_init_rust(args: &ArgMatches) -> Result<(), anyhow::Error> {
 
     for data_file in export_files {
         let path = project_path.join(data_file.1);
-
         create_directory(path.parent().unwrap())?;
-
         std::fs::write(path, data_file.0)?;
     }
 
-    // Check all dependencies
     check_for_cargo();
     check_for_git();
 
-    println!(
-        "{}",
-        format!("Project successfully created at path: {}", project_path.display()).green()
-    );
-
     Ok(())
 }
 
-pub async fn exec_init_csharp(args: &ArgMatches) -> anyhow::Result<()> {
-    let project_path = args.get_one::<PathBuf>("project-path").unwrap();
-
+pub fn init_csharp_project(project_path: &Path) -> Result<(), anyhow::Error> {
     let export_files = vec![
         (include_str!("project/csharp/StdbModule._csproj"), "StdbModule.csproj"),
         (include_str!("project/csharp/Lib._cs"), "Lib.cs"),
         (include_str!("project/csharp/_gitignore"), ".gitignore"),
         (include_str!("project/csharp/global._json"), "global.json"),
     ];
 
-    // Check all dependencies
     check_for_dotnet();
     check_for_git();
 
     for data_file in export_files {
         let path = project_path.join(data_file.1);
-
         create_directory(path.parent().unwrap())?;
-
         std::fs::write(path, data_file.0)?;
     }
 
+    Ok(())
+}
+
+pub async fn exec_init_rust(args: &ArgMatches) -> Result<(), anyhow::Error> {
+    let project_path = args.get_one::<PathBuf>("project-path").unwrap();
+    init_rust_project(project_path)?;
+
+    println!(
+        "{}",
+        format!("Project successfully created at path: {}", project_path.display()).green()
+    );
+
+    Ok(())
+}
+
+pub async fn exec_init_csharp(args: &ArgMatches) -> anyhow::Result<()> {
+    let project_path = args.get_one::<PathBuf>("project-path").unwrap();
+    init_csharp_project(project_path)?;
+
     println!(
         "{}",
         format!("Project successfully created at path: {}", project_path.display()).green()
diff --git a/crates/cli/src/tasks/init_template.rs b/crates/cli/src/tasks/init_template.rs
diff --git a/crates/cli/src/tasks/mod.rs b/crates/cli/src/tasks/mod.rs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+console.log('SpacetimeDB client ready');`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { defineConfig } from 'vite';`
	`2`	`+`
	`3`	`+export default defineConfig({});`