feat(cargo-shuttle): separate --id and --name. support 'init --id' with immediate linking (#2069)

* feat: separate --id and --name. support init --id with immediate linking

* .

* refa

* fix test

Author: jonaro00

cargo-shuttle/src/args.rs

@@ -73,9 +73,12 @@ pub struct ProjectArgs {
     /// Specify the working directory
     #[arg(global = true, long, visible_alias = "wd", default_value = ".", value_parser = OsStringValueParser::new().try_map(parse_path))]
     pub working_directory: PathBuf,
-    /// Specify the name or id of the project
-    #[arg(global = true, long = "name", visible_alias = "id")]
-    pub name_or_id: Option<String>,
+    /// Specify the name of the project to target or create
+    #[arg(global = true, long)]
+    pub name: Option<String>,
+    /// Specify the id of the project to target
+    #[arg(global = true, long)]
+    pub id: Option<String>,
 }
 
 impl ProjectArgs {
@@ -411,9 +414,9 @@ pub struct InitArgs {
     /// Don't check the project name's validity or availability and use it anyways
     #[arg(long)]
     pub force_name: bool,
-    /// Whether to start the container for this project on Shuttle, and claim the project name
-    #[arg(long)]
-    pub create_env: bool,
+    /// Whether to create a project on Shuttle
+    #[arg(long, visible_alias = "create_env")]
+    pub create_project: bool,
     /// Don't initialize a new git repository
     #[arg(long)]
     pub no_git: bool,
@@ -640,7 +643,8 @@ mod tests {
     fn workspace_path() {
         let project_args = ProjectArgs {
             working_directory: path_from_workspace_root("examples/axum/hello-world/src"),
-            name_or_id: None,
+            name: None,
+            id: None,
         };
 
         assert_eq!(
@@ -653,7 +657,8 @@ mod tests {
     fn project_name() {
         let project_args = ProjectArgs {
             working_directory: path_from_workspace_root("examples/axum/hello-world/src"),
-            name_or_id: None,
+            name: None,
+            id: None,
         };
 
         assert_eq!(
@@ -668,7 +673,8 @@ mod tests {
             working_directory: path_from_workspace_root(
                 "examples/rocket/workspace/hello-world/src",
             ),
-            name_or_id: None,
+            name: None,
+            id: None,
         };
 
         assert_eq!(

cargo-shuttle/src/config.rs

@@ -96,7 +96,7 @@ impl RequestContext {
         })
     }
 
-    pub fn load_local_internal(&mut self, project_args: &ProjectArgs) -> Result<()> {
+    pub fn load_local_internal_config(&mut self, project_args: &ProjectArgs) -> Result<()> {
         let workspace_path = project_args
             .workspace_path()
             .unwrap_or(project_args.working_directory.clone());
@@ -119,10 +119,10 @@ impl RequestContext {
         let config = project_internal.as_mut().unwrap();
 
         // Project id is preferred in this order:
-        // 1. Name given on command line
-        // 2. Name from .shuttle/config.toml file
-        match (&project_args.name_or_id, &config.id) {
-            // Command-line name parameter trumps everything
+        // 1. Id given on command line
+        // 2. Id from .shuttle/config.toml file
+        match (&project_args.id, &config.id) {
+            // Command-line id parameter trumps everything
             (Some(id_from_args), _) => {
                 trace!("using command-line project id");
                 config.id = Some(id_from_args.clone());
@@ -167,21 +167,16 @@ impl RequestContext {
         Ok(())
     }
 
-    /// Load the project configuration at the given `working_directory`
-    ///
-    /// Ensures that if `--name` is not specified on the command-line, and either the project
-    /// file does not exist, or it has not set the `name` key then the `ProjectConfig` instance
-    /// has `ProjectConfig.name = Some("crate-name")`.
-    pub fn load_local(&mut self, project_args: &ProjectArgs) -> Result<()> {
-        // Shuttle.toml
+    /// Load the Shuttle.toml project configuration at the given `working_directory`
+    pub fn load_local_config(&mut self, project_args: &ProjectArgs) -> Result<()> {
         let project = Self::get_local_config(project_args)?;
 
         self.project = Some(project);
 
         Ok(())
     }
 
-    pub fn get_local_config(
+    fn get_local_config(
         project_args: &ProjectArgs,
     ) -> Result<Config<LocalConfigManager, ProjectConfig>> {
         let workspace_path = project_args
@@ -209,7 +204,7 @@ impl RequestContext {
         // 2. Name from Shuttle.toml file
         // 3. Name from Cargo.toml package if it's a crate
         // 4. Name from the workspace directory if it's a workspace
-        match (&project_args.name_or_id, &config.name) {
+        match (&project_args.name, &config.name) {
             // Command-line name parameter trumps everything
             (Some(name_from_args), _) => {
                 trace!("using command-line project name");
@@ -379,7 +374,8 @@ mod tests {
     fn get_local_config_finds_name_in_cargo_toml() {
         let project_args = ProjectArgs {
             working_directory: path_from_workspace_root("examples/axum/hello-world/"),
-            name_or_id: None,
+            name: None,
+            id: None,
         };
 
         let local_config = RequestContext::get_local_config(&project_args).unwrap();
@@ -391,7 +387,8 @@ mod tests {
     fn get_local_config_finds_name_from_workspace_dir() {
         let project_args = ProjectArgs {
             working_directory: path_from_workspace_root("examples/rocket/workspace/hello-world/"),
-            name_or_id: None,
+            name: None,
+            id: None,
         };
 
         let local_config = RequestContext::get_local_config(&project_args).unwrap();
@@ -403,7 +400,8 @@ mod tests {
     fn setting_name_overrides_name_in_config() {
         let project_args = ProjectArgs {
             working_directory: path_from_workspace_root("examples/axum/hello-world/"),
-            name_or_id: Some("my-fancy-project-name".to_owned()),
+            name: Some("my-fancy-project-name".to_owned()),
+            id: None,
         };
 
         let local_config = RequestContext::get_local_config(&project_args).unwrap();