Merge pull request 'feat(setup-repo): Use URI to generate target directory if not provided' (#2) from optional-target-dir into main

Reviewed-on: #2

.gitea/workflows/linting.yaml

@@ -7,18 +7,36 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
+  cargo-fmt:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code 
+        uses: actions/checkout@v4
+
+      # Cache cargo registry
+      - name: Hash the lock file
+        uses: https://gitea.com/seepine/hash-files@v1
+        id: get-hash
+        with:
+          patterns: |
+            **/Cargo.lock
+
+      - name: Setup rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          components: rustfmt,clippy
+          cache-shared-key: cargo-${{ steps.get-hash.outputs.hash }}
+
+      - name: Rustfmt Check
+        uses: actions-rust-lang/rustfmt@v1
+
   cargo-check:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source code 
         uses: actions/checkout@v4
 
-      - name: Setup rust
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          components: rustfmt,clippy
-
       # Cache cargo registry
       - name: Hash the lock file
         uses: https://gitea.com/seepine/hash-files@v1
@@ -26,37 +44,23 @@ jobs:
         with:
           patterns: |
             **/Cargo.lock
-      - name: Cache cargo registry
-        uses: actions/cache@v3
+
+      - name: Setup rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          path: |
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: cargo-${{ steps.get-hash.outputs.hash }}
-          restore-keys: |
-            cargo-
-      # Cache cargo registry - end
+          toolchain: stable
+          components: rustfmt,clippy
+          cache-shared-key: cargo-${{ steps.get-hash.outputs.hash }}
 
       - name: Cargo check
-        uses: actions-rs/cargo@v1
-        with:
-          command: check
+        run: cargo check --workspace
 
   clippy:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout source code
+      - name: Checkout source code 
         uses: actions/checkout@v4
 
-      - name: Setup rust
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          components: rustfmt,clippy
-
       # Cache cargo registry
       - name: Hash the lock file
         uses: https://gitea.com/seepine/hash-files@v1
@@ -64,22 +68,13 @@ jobs:
         with:
           patterns: |
             **/Cargo.lock
-      - name: Cache cargo registry
-        uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: cargo-${{ steps.get-hash.outputs.hash }}
-          restore-keys: |
-            cargo-
-      # Cache cargo registry - end
 
-      - name: Run clippy
-        uses: actions-rs/clippy-check@v1
+      - name: Setup rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-targets --all-features -- -Dwarnings
+          toolchain: stable
+          components: rustfmt,clippy
+          cache-shared-key: cargo-${{ steps.get-hash.outputs.hash }}
+
+      - name: Cargo check
+        run: cargo clippy --all-targets --all-features -- -Dwarnings

.gitea/workflows/release-package.yaml

@@ -15,53 +15,32 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Setup rust
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-
-      # Cache cargo registry
+        # Cache cargo registry
       - name: Hash the lock file
         uses: https://gitea.com/seepine/hash-files@v1
         id: get-hash
         with:
           patterns: |
             **/Cargo.lock
-      - name: Cache cargo registry
-        uses: actions/cache@v4
+
+      - name: Setup rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          path: |
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: cargo-${{ steps.get-hash.outputs.hash }}
-          restore-keys: |
-            cargo-
-      # Cache cargo registry - end
+          toolchain: stable
+          cache-shared-key: cargo-${{ steps.get-hash.outputs.hash }}
+          matcher: false
 
       - name: Build application
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --release --all-features --workspace --all-targets
+        run: cargo build --release --all-features --workspace --all-targets
 
       - name: Package application
-        uses: actions-rs/cargo@v1
-        with:
-          command: package
-          args: --all-features --workspace --allow-dirty
+        ru8n: cargo package --all-features --workspace --allow-dirty
 
       - name: Add registry to cargo config
         run: echo -e '[registries.gitea]\nindex = "sparse+https://git.noahknegt.com/api/packages/${{ github.repository_owner }}/cargo/"\n' > ~/.cargo/config.toml
 
       - name: Publish to cargo registry
-        uses: actions-rs/cargo@v1
-        with:
-          command: publish
-          args: --no-verify --registry gitea --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        run: cargo publish --no-verify --registry gitea --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
         env:
           CARGO_NET_GIT_FETCH_WITH_CLI: true
           CARGO_NET_RETRY: 2

Cargo.lock

@@ -207,7 +207,7 @@ dependencies = [
 
 [[package]]
 name = "git"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "anyhow",
  "command-with-spinner",
@@ -330,7 +330,7 @@ dependencies = [
 
 [[package]]
 name = "setup-repo"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "anyhow",
  "clap",

Cargo.toml

@@ -2,7 +2,8 @@
 resolver = "3"
 members = [ 
     "command-with-spinner",
-    "create-worktree", "git", 
+    "create-worktree", 
+    "git", 
     "git-ssh-bitwarden",
     "setup-repo",
 ]

create-worktree/Cargo.toml

@@ -13,6 +13,6 @@ anyhow = "1.0"
 clap = { version = "4.5", features = ["derive"] }
 colored = "3.0"
 dirs = "6.0"
-git = { version = "0.1.0", path = "../git" }
+git = { version = "0.2.0", path = "../git" }
 indicatif = "0.17"
 thiserror = { version = "2.0" }

create-worktree/src/main.rs

@@ -51,11 +51,17 @@ fn update_remote(branch: &str, create_upstream: bool) -> Result<()> {
 
     if !has_remote {
         // Create remote branch
-        println!("{}", format!("Branch '{branch}' does not exist on remote. Creating.").dimmed());
+        println!(
+            "{}",
+            format!("Branch '{branch}' does not exist on remote. Creating.").dimmed()
+        );
         Git::set_upstream_branch(branch)?;
         // Git::create_remote_branch(branch)?;
     } else {
-        println!("{}", format!("Branch '{branch}' exists. Setting upstream.").dimmed());
+        println!(
+            "{}",
+            format!("Branch '{branch}' exists. Setting upstream.").dimmed()
+        );
         Git::set_upstream_branch(branch)?;
     }
 
@@ -73,11 +79,16 @@ fn main() -> Result<()> {
     if args.verbose {
         println!("{}", "Verbose mode enabled".dimmed());
         println!("{}", format!("Base branch: {}", args.base).dimmed());
-        println!("{}", format!("Create upstream: {}", args.no_create_upstream).dimmed());
+        println!(
+            "{}",
+            format!("Create upstream: {}", args.no_create_upstream).dimmed()
+        );
     }
 
     // Determine branch name if not specified
-    let branch = args.branch.unwrap_or_else(|| format!("{}{}", args.prefix, args.worktree));
+    let branch = args
+        .branch
+        .unwrap_or_else(|| format!("{}{}", args.prefix, args.worktree));
 
     // Normalize paths
     let worktree_path = Path::new(&args.worktree).to_string_lossy();
@@ -93,7 +104,10 @@ fn main() -> Result<()> {
     }
 
     // Change to worktree directory
-    println!("{}", format!("Moving into worktree: {worktree_path}").dimmed());
+    println!(
+        "{}",
+        format!("Moving into worktree: {worktree_path}").dimmed()
+    );
     env::set_current_dir(&args.worktree).context("Failed to change directory")?;
 
     // Update remote

git/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "git"
-version = "0.1.0"
+version = "0.2.0"
 
 edition.workspace = true
 authors.workspace = true

git/src/error.rs

@@ -1,9 +1,6 @@
 /// Git operations error type
 #[derive(Debug, thiserror::Error)]
 pub enum GitError {
-    #[error("Command failed with exit code: {0}")]
-    Failed(i32),
-
     #[error("Command failed without exit code")]
     FailedNoCode,
 

git/src/lib.rs

@@ -21,16 +21,14 @@ impl Git {
 
         // Clone the repository as a bare clone into .bare directory
         let mut cmd = Command::new("git");
-        cmd.args([
-            "clone",
-            "--bare",
-            repo_url,
-            &bare_dir_str
-        ]);
+        cmd.args(["clone", "--bare", repo_url, &bare_dir_str]);
 
-        match run_command(&mut cmd, &format!("Cloning repository as bare clone into {bare_dir_str}")) {
+        match run_command(
+            &mut cmd,
+            &format!("Cloning repository as bare clone into {bare_dir_str}"),
+        ) {
             Ok(_) => Ok(()),
-            Err(_) => Err(GitError::FailedNoCode.into())
+            Err(_) => Err(GitError::FailedNoCode.into()),
         }
     }
 
@@ -48,14 +46,16 @@ impl Git {
 
         let mut cmd = Command::new("git");
         cmd.args([
-            "--git-dir", &bare_dir_str,
+            "--git-dir",
+            &bare_dir_str,
             "config",
-            "remote.origin.fetch", "+refs/heads/*:refs/remotes/origin/*"
+            "remote.origin.fetch",
+            "+refs/heads/*:refs/remotes/origin/*",
         ]);
 
         match run_command(&mut cmd, "Configuring remote.origin.fetch") {
             Ok(_) => Ok(()),
-            Err(_) => Err(GitError::FailedNoCode.into())
+            Err(_) => Err(GitError::FailedNoCode.into()),
         }
     }
 
@@ -65,26 +65,18 @@ impl Git {
         let bare_dir_str = bare_dir.to_string_lossy();
 
         let mut cmd = Command::new("git");
-        cmd.args([
-            "--git-dir", &bare_dir_str,
-            "fetch",
-            "--all"
-        ]);
+        cmd.args(["--git-dir", &bare_dir_str, "fetch", "--all"]);
 
         match run_command(&mut cmd, "Fetching all remotes") {
             Ok(_) => Ok(()),
-            Err(_) => Err(GitError::FailedNoCode.into())
+            Err(_) => Err(GitError::FailedNoCode.into()),
         }
     }
 
     /// Check if a branch exists locally
     pub fn branch_exists_locally(branch: &str) -> Result<bool> {
         let output = Command::new("git")
-            .args([
-                "branch",
-                "--list",
-                branch
-            ])
+            .args(["branch", "--list", branch])
             .output()
             .context("Failed to check branch existence")?;
 
@@ -94,12 +86,7 @@ impl Git {
     /// Check if a branch exists on the remote
     pub fn branch_exists_on_remote(branch: &str) -> Result<bool> {
         let output = Command::new("git")
-            .args([
-                "ls-remote",
-                "--heads",
-                "origin",
-                branch
-            ])
+            .args(["ls-remote", "--heads", "origin", branch])
             .output()
             .context("Failed to check remote branch existence")?;
 
@@ -109,62 +96,53 @@ impl Git {
     /// Create a new worktree with an existing branch
     pub fn create_worktree_existing_branch(worktree_path: &str, branch: &str) -> Result<()> {
         let mut cmd = Command::new("git");
-        cmd.args([
-            "worktree",
-            "add",
-            worktree_path,
-            branch
-        ]);
+        cmd.args(["worktree", "add", worktree_path, branch]);
 
-        match run_command(&mut cmd, &format!("Generating new worktree from existing branch: {branch}")) {
+        match run_command(
+            &mut cmd,
+            &format!("Generating new worktree from existing branch: {branch}"),
+        ) {
             Ok(_) => Ok(()),
-            Err(_) => Err(GitError::FailedNoCode.into())
+            Err(_) => Err(GitError::FailedNoCode.into()),
         }
     }
 
     /// Create a new worktree with a new branch
     pub fn create_worktree_new_branch(worktree_path: &str, branch: &str, base: &str) -> Result<()> {
         let mut cmd = Command::new("git");
-        cmd.args([
-            "worktree",
-            "add",
-            "-b", branch,
-            worktree_path,
-            base
-        ]);
+        cmd.args(["worktree", "add", "-b", branch, worktree_path, base]);
 
-        match run_command(&mut cmd, &format!("Generating new worktree: {worktree_path}")) {
+        match run_command(
+            &mut cmd,
+            &format!("Generating new worktree: {worktree_path}"),
+        ) {
             Ok(_) => Ok(()),
-            Err(_) => Err(GitError::FailedNoCode.into())
+            Err(_) => Err(GitError::FailedNoCode.into()),
         }
     }
 
     /// Create and push a new remote branch
     pub fn create_remote_branch(branch: &str) -> Result<()> {
         let mut cmd = Command::new("git");
-        cmd.args([
-            "push",
-            "-u", "origin",
-            branch
-        ]);
+        cmd.args(["push", "-u", "origin", branch]);
 
         match run_command(&mut cmd, &format!("Creating remote branch {branch}...")) {
             Ok(_) => Ok(()),
-            Err(_) => Err(GitError::FailedNoCode.into())
+            Err(_) => Err(GitError::FailedNoCode.into()),
         }
     }
 
     /// Set the upstream branch
     pub fn set_upstream_branch(branch: &str) -> Result<()> {
         let mut cmd = Command::new("git");
-        cmd.args([
-            "branch",
-            "--set-upstream-to", &format!("origin/{branch}")
-        ]);
+        cmd.args(["branch", "--set-upstream-to", &format!("origin/{branch}")]);
 
-        match run_command(&mut cmd, &format!("Setting upstream branch to 'origin/{branch}'")) {
+        match run_command(
+            &mut cmd,
+            &format!("Setting upstream branch to 'origin/{branch}'"),
+        ) {
             Ok(_) => Ok(()),
-            Err(_) => Err(GitError::FailedNoCode.into())
+            Err(_) => Err(GitError::FailedNoCode.into()),
         }
     }
 }

setup-repo/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "setup-repo"
-version = "0.1.0"
+version = "0.2.0"
 description = "Tool to set up Git repositories for worktree development"
 
 edition.workspace = true
@@ -12,5 +12,5 @@ repository.workspace = true
 anyhow = "1.0"
 clap = { version = "4.5", features = ["derive"] }
 colored = "3.0"
-git = { version = "0.1.0", path = "../git" }
+git = { version = "0.2.0", path = "../git" }
 indicatif = "0.17"

setup-repo/src/main.rs

@@ -14,7 +14,7 @@ struct Args {
 
     /// Target directory for the repository setup
     #[arg(short, long)]
-    target_dir: String,
+    target_dir: Option<String>,
 
     /// Enable verbose output
     #[arg(short, long)]
@@ -32,28 +32,50 @@ fn main() -> Result<()> {
     // Enable or disable colored output
     colored::control::set_override(!args.no_color);
 
+    let target_dir = match args.target_dir {
+        Some(dir) => dir,
+
+        // If a directory is not provided construct one from the last part of the URI.
+        // This behavior follows git itself
+        None => {
+            let start = args.repo_url.rfind("/").unwrap() + 1;
+            let end = match args.repo_url.rfind(".git") {
+                Some(index) => index,
+                None => args.repo_url.len(),
+            };
+
+            args.repo_url[start..end].to_owned()
+        }
+    };
+
     // Print verbose information if enabled
     if args.verbose {
         println!("{}", "Verbose mode enabled".dimmed());
         println!("{}", format!("Repository URL: {}", args.repo_url).dimmed());
-        println!("{}", format!("Target directory: {}", args.target_dir).dimmed());
+        println!("{}", format!("Target directory: {target_dir}").dimmed());
     }
 
-    println!("{}", "Setting up repository for worktree development".blue());
+    println!(
+        "{}",
+        "Setting up repository for worktree development".blue()
+    );
 
     // Clone the repository as a bare clone
-    Git::clone_bare_repo(&args.repo_url, &args.target_dir)?;
+    Git::clone_bare_repo(&args.repo_url, &target_dir)?;
 
     // Set up the .git file to point to the .bare directory
-    Git::setup_git_pointer(&args.target_dir)?;
+    Git::setup_git_pointer(&target_dir)?;
 
     // Configure the remote.origin.fetch setting
-    Git::configure_remote_fetch(&args.target_dir)?;
+    Git::configure_remote_fetch(&target_dir)?;
 
     // Fetch all remotes
-    Git::fetch_remotes(&args.target_dir)?;
+    Git::fetch_remotes(&target_dir)?;
 
     println!("{}", "Repository setup complete.".green());
-    println!("{}", format!("You can now create worktrees in '{}'.", args.target_dir).green());
+    println!(
+        "{}",
+        format!("You can now create worktrees in '{target_dir}'.").green()
+    );
     Ok(())
 }