bonchi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f1b9e3fb0df2276375aff9ca6d5f416fc2396602570c41d0a2f925f3528cdc1
-  data.tar.gz: 23b137fbe286b1c8a2845348ae8bb30d1c9200851ed7eee0c99face39e3fb7b8
+  metadata.gz: f726dfa32881aaae2a225b30e26b3a31fe3bfa2714709a33738910c4a42d2daf
+  data.tar.gz: 4ef9df6de06aecfc41d5bf69fe651114123bccb48b0fb9cc67ed8c26f1ab6bcb
 SHA512:
-  metadata.gz: 8f132bd0f26283c4bab9f506553882eee5685e77def350e76c537a180beb44f399fa8540d542ab5be06f85fc8579b1378dde351c887c8291f4cbdeeb9a08f7df
-  data.tar.gz: 71b5b5c3fda5a36dfdce6bb3b16a12401b838663bf57f22e8fdf25193372db458e4598f98c2d09ddbc91882d4567b1fdba6d029cfceae96054ea0b179502cfee
+  metadata.gz: 5388c61deec0daf249af8c2033772bf9c2b22d51a894b6cfb75f887d65d14c1bdf298d7e96d6c7513717b0d0676fcb0f5f5a7bf518227be3b380487afd8774f3
+  data.tar.gz: 919fe02691d9f5b4c7ca3c2ac31c8cb365b6bb9533ac56470d2803d972881f3375ee3b72a64ecbb4e983e29898629d331f451808ee20b56e418df7d4ab91a671

data/lib/bonchi/cli.rb

@@ -14,6 +14,13 @@ module Bonchi
     map "-v" => :version
 
     desc "create BRANCH [BASE]", "Create new branch + worktree"
+    long_desc <<~DESC
+      Create a new branch and worktree. BASE defaults to the repository's default branch
+      (e.g. main). If a worktree for BRANCH already exists, switches to it instead.
+
+      When a .worktree.yml exists in the main worktree, setup runs automatically
+      (copy files, allocate ports, run pre_setup and setup commands). Skip with --no-setup.
+    DESC
     option :setup, type: :boolean, default: true, desc: "Run setup after creating worktree"
     def create(branch, base = nil)
       base ||= Git.default_base_branch
@@ -22,27 +29,34 @@ module Bonchi
       existing = Git.worktree_path_for(branch)
       if existing
         puts "Worktree already exists: #{existing}"
-        puts "BONCHI_CD:#{existing}"
+        signal_cd(existing)
         return
       end
 
       Git.worktree_add_new_branch(path, branch, base)
       puts "Worktree created at: #{path}"
 
+      signal_cd(path)
+
       if options[:setup] && Config.from_main_worktree
         puts ""
         Setup.new(worktree: path).run
-      else
-        puts "BONCHI_CD:#{path}"
       end
     end
 
     desc "switch BRANCH", "Switch to existing branch in worktree"
+    long_desc <<~DESC
+      Create a worktree for an existing branch and cd into it.
+      If a worktree for BRANCH already exists, switches to it instead.
+
+      The branch must already exist locally or on the remote.
+      To create a new branch, use `bonchi create` instead.
+    DESC
     def switch(branch)
       existing = Git.worktree_path_for(branch)
       if existing
         puts "Worktree already exists: #{existing}"
-        puts "BONCHI_CD:#{existing}"
+        signal_cd(existing)
         return
       end
 
@@ -54,10 +68,17 @@ module Bonchi
       Git.worktree_add(path, branch)
       puts "Worktree created at: #{path}"
 
-      puts "BONCHI_CD:#{path}"
+      signal_cd(path)
     end
 
     desc "pr NUMBER_OR_URL", "Checkout GitHub PR in worktree"
+    long_desc <<~DESC
+      Fetch a GitHub pull request and check it out in a new worktree.
+      Accepts a PR number (e.g. 123) or a full GitHub PR URL.
+
+      The worktree branch will be named pr-<number>.
+      If the worktree already exists, switches to it instead.
+    DESC
     def pr(input)
       pr_number = extract_pr_number(input)
       branch = "pr-#{pr_number}"
@@ -66,7 +87,7 @@ module Bonchi
       existing = Git.worktree_path_for(branch)
       if existing
         puts "Worktree already exists: #{existing}"
-        puts "BONCHI_CD:#{existing}"
+        signal_cd(existing)
         return
       end
 
@@ -74,12 +95,28 @@ module Bonchi
       Git.worktree_add(path, branch)
       puts "PR ##{pr_number} checked out at: #{path}"
 
-      puts "BONCHI_CD:#{path}"
+      signal_cd(path)
     end
 
-    desc "setup", "Run setup in current worktree (ports, copy, pre_setup, setup cmd)"
-    def setup
-      Setup.new.run
+    desc "init", "Generate a .worktree.yml in the current project"
+    long_desc <<~DESC
+      Generate a .worktree.yml config file in the current directory with
+      sensible defaults. Edit the file to customize which files to copy,
+      which ports to allocate, and what setup command to run.
+    DESC
+    def init
+      path = File.join(Dir.pwd, ".worktree.yml")
+      if File.exist?(path)
+        abort "Error: .worktree.yml already exists"
+      end
+
+      File.write(path, WORKTREE_YML_TEMPLATE)
+      puts "Created #{path}"
+    end
+
+    desc "setup [-- ARGS...]", "Run setup in current worktree (ports, copy, pre_setup, setup cmd)"
+    def setup(*args)
+      Setup.new.run(args)
     end
 
     desc "list", "List all worktrees"
@@ -88,6 +125,12 @@ module Bonchi
     end
 
     desc "remove BRANCH", "Remove a worktree"
+    long_desc <<~DESC
+      Remove a worktree and its directory. Refuses to remove worktrees
+      with uncommitted changes or untracked files (use `git worktree remove --force` to override).
+
+      Aliases: rm
+    DESC
     def remove(branch)
       path = Git.worktree_path_for(branch)
       abort "Error: No worktree found for branch: #{branch}" unless path
@@ -97,6 +140,13 @@ module Bonchi
     end
 
     desc "prune", "Prune stale worktree admin files"
+    long_desc <<~DESC
+      Clean up stale worktree tracking data. Git internally tracks worktrees in
+      .git/worktrees/. When a worktree directory is deleted manually (e.g. rm -rf)
+      instead of via `bonchi remove`, the tracking data becomes stale.
+
+      This runs `git worktree prune` to remove those orphaned entries.
+    DESC
     def prune
       Git.worktree_prune
       puts "Pruned stale worktree administrative files"
@@ -113,6 +163,15 @@ module Bonchi
 
     private
 
+    def signal_cd(path)
+      cd_file = ENV["BONCHI_CD_FILE"]
+      if cd_file
+        File.write(cd_file, path)
+      else
+        puts "cd #{path}"
+      end
+    end
+
     def extract_pr_number(input)
       case input
       when %r{^https://github.com/.*/pull/(\d+)}
@@ -124,15 +183,31 @@ module Bonchi
       end
     end
 
+    WORKTREE_YML_TEMPLATE = <<~'YAML'
+      # Files to copy from the main worktree before setup.
+      # copy:
+      #   - .env.local
+
+      # Env var names to allocate unique ports for (from global pool).
+      # ports:
+      #   - PORT
+
+      # Commands to run before the setup command (port env vars are available).
+      # pre_setup:
+      #   - sed -i '' "s|^PORT=.*|PORT=$PORT|" .env.local
+
+      # The setup command to run (default: bin/setup).
+      setup: bin/setup
+    YAML
+
     SHELL_ENV = <<~'SHELL'
       bonchi() {
-          local output
-          output=$(command bonchi "$@")
+          local bonchi_cd_file="${TMPDIR:-/tmp}/bonchi_cd.$$"
+          BONCHI_CD_FILE="$bonchi_cd_file" command bonchi "$@"
           local exit_code=$?
-          echo "$output"
-          if [ $exit_code -eq 0 ]; then
-              local cd_path=$(echo "$output" | grep "^BONCHI_CD:" | cut -d: -f2-)
-              [ -n "$cd_path" ] && cd "$cd_path"
+          if [ $exit_code -eq 0 ] && [ -f "$bonchi_cd_file" ]; then
+              cd "$(cat "$bonchi_cd_file")"
+              rm -f "$bonchi_cd_file"
           fi
           return $exit_code
       }

data/lib/bonchi/version.rb

@@ -1,3 +1,3 @@
 module Bonchi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bonchi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gert Goet
@@ -51,7 +51,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.3'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="