feat(cargo-shuttle): new template system for init (#1667)

* feat(cargo-shuttle): new template system for init

* update templates schema with one map per category

* bump common

* feat: add --offline flag

* fix: tests

* fix: add version field check to templates definition

* fix: constant

* nit: move fn

Cargo.toml

@@ -47,8 +47,9 @@ bollard = "0.15.0"
 bytes = "1.3.0"
 cargo_metadata = "0.18.1"
 chrono = { version = "0.4.23", default-features = false }
-colored = "2.0.0"
 clap = { version = "4.2.7", features = ["derive"] }
+colored = "2.0.0"
+comfy-table = "6.2.0"
 crossterm = "0.27.0"
 ctor = "0.2.5"
 dirs = "5.0.0"
@@ -59,6 +60,7 @@ futures = "0.3.27"
 headers = "0.3.8"
 home = "0.5.4"
 http = "0.2.8"
+http-body = "0.4.5"
 hyper = "0.14.23"
 # not great, but waiting for WebSocket changes to be merged
 hyper-reverse-proxy = { git = "https://github.com/chesedo/hyper-reverse-proxy", branch = "bug/host_header" }
@@ -86,7 +88,7 @@ serde = { version = "1.0.148", default-features = false }
 serde_json = "1.0.89"
 sqlx = { version = "0.7.1", features = ["runtime-tokio", "tls-rustls"] }
 strfmt = "0.2.2"
-strum = { version = "0.25.0", features = ["derive"] }
+strum = { version = "0.26.1", features = ["derive"] }
 tar = "0.4.38"
 tempfile = "3.4.0"
 test-context = "0.3.0"
@@ -108,5 +110,5 @@ ttl_cache = "0.5.1"
 ulid = "1.0.0"
 url = "2.4.0"
 uuid = "1.2.2"
-wiremock = "0.6.0-rc.3"
+wiremock = "0.6.0"
 zeroize = "1.6.0"

cargo-shuttle/Cargo.toml

@@ -21,7 +21,7 @@ clap = { workspace = true, features = ["env"] }
 clap_complete = "4.3.1"
 clap_mangen = "0.2.15"
 crossterm = { workspace = true }
-dialoguer = { version = "0.11.0", features = ["fuzzy-select"] }
+dialoguer = { version = "0.11", default-features = false, features = ["password"] }
 dirs = { workspace = true }
 dunce = { workspace = true }
 flate2 = { workspace = true }

cargo-shuttle/src/args.rs

@@ -12,7 +12,7 @@ use clap::{
     Parser, ValueEnum,
 };
 use clap_complete::Shell;
-use shuttle_common::constants::DEFAULT_IDLE_MINUTES;
+use shuttle_common::constants::{DEFAULT_IDLE_MINUTES, EXAMPLES_REPO};
 use shuttle_common::resource;
 use uuid::Uuid;
 
@@ -33,6 +33,10 @@ pub struct ShuttleArgs {
     /// (allows targeting a custom deployed instance for this command only, mainly for development)
     #[arg(long, env = "SHUTTLE_API")]
     pub api_url: Option<String>,
+    /// Disable network requests that are not strictly necessary. Limits some features.
+    #[arg(long, env = "SHUTTLE_OFFLINE")]
+    pub offline: bool,
+
     #[command(subcommand)]
     pub cmd: Command,
 }
@@ -320,43 +324,41 @@ pub struct InitArgs {
     /// Don't initialize a new git repository
     #[arg(long)]
     pub no_git: bool,
+
     #[command(flatten)]
     pub login_args: LoginArgs,
 }
 
-#[derive(ValueEnum, Clone, Debug, strum::Display, strum::EnumIter)]
-#[strum(serialize_all = "kebab-case")]
+#[derive(ValueEnum, Clone, Debug, strum::EnumMessage, strum::VariantArray)]
 pub enum InitTemplateArg {
-    /// Actix Web framework
-    ActixWeb,
-    /// Axum web framework
+    /// Axum - Modular web framework from the Tokio ecosystem
     Axum,
-    /// Loco web framework
+    /// Actix Web - Powerful and fast web framework
+    ActixWeb,
+    /// Rocket - Simple and easy-to-use web framework
+    Rocket,
+    /// Loco - Batteries included web framework based on Axum
     Loco,
-    /// Poem web framework
+    /// Salvo - Powerful and simple web framework
+    Salvo,
+    /// Poem - Full-featured and easy-to-use web framework
     Poem,
-    /// Poise Discord framework
+    /// Poise - Discord Bot framework with good slash command support
     Poise,
-    /// Rocket web framework
-    Rocket,
-    /// Salvo web framework
-    Salvo,
-    /// Serenity Discord framework
+    /// Serenity - Discord Bot framework
     Serenity,
-    /// Thruster web framework
+    /// Tower - Modular service library
+    Tower,
+    /// Thruster - Web framework
     Thruster,
-    /// Tide web framework
+    /// Tide - Web framework
     Tide,
-    /// Tower web framework
-    Tower,
-    /// Warp web framework
+    /// Warp - Web framework
     Warp,
-    /// No template - Custom empty service
+    /// No template - Make a custom service
     None,
 }
 
-pub const EXAMPLES_REPO: &str = "https://github.com/shuttle-hq/shuttle-examples";
-
 #[derive(Clone, Debug, PartialEq)]
 pub struct TemplateLocation {
     pub auto_path: String,

cargo-shuttle/src/init.rs

@@ -12,7 +12,7 @@ use gix::create::{self, Kind};
 use gix::remote::fetch::Shallow;
 use gix::{open, progress};
 use regex::Regex;
-use shuttle_common::constants::SHUTTLE_EXAMPLES_README;
+use shuttle_common::constants::EXAMPLES_README;
 use tempfile::{Builder, TempDir};
 use toml_edit::{value, Document};
 use url::Url;
@@ -101,8 +101,8 @@ fn setup_template(auto_path: &str) -> Result<TempDir> {
         // `owner` and `name` are required for the regex to
         // match. Thus, we don't need to check if they exist.
         let url = format!("{vendor}{}/{}.git", &caps["owner"], &caps["name"]);
-        gix_clone(&url, temp_dir.path())
-            .with_context(|| format!("Failed to clone template Git repository at {url}"))?;
+        println!(r#"Cloning from "{}"..."#, url);
+        gix_clone(&url, temp_dir.path()).context("Failed to clone git repository")?;
     } else if Path::new(auto_path).is_absolute() || auto_path.starts_with('.') {
         if Path::new(auto_path).exists() {
             copy_dirs(Path::new(auto_path), temp_dir.path(), GitDir::Copy)?;
@@ -121,7 +121,7 @@ fn setup_template(auto_path: &str) -> Result<TempDir> {
                 or use another method of specifying the template location."
             );
             println!(
-                "HINT: You can find examples of how to select a template here: {SHUTTLE_EXAMPLES_README}"
+                "HINT: You can find examples of how to select a template here: {EXAMPLES_README}"
             );
             anyhow::bail!("invalid URL scheme")
         }