bonchi 0.2.0.rc1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8bcf10affa988d4bff6b9d78fd53ea1be600a9c03e93bf95f083fadd210e3e6
-  data.tar.gz: 40a744831b24891e328d4dbc400a4da030a98680279e06cd55ab77b0306d5375
+  metadata.gz: 137e1eebb563dfaf05a9e6928abeb3832ff8e6231f7e1b4ea176037b605b2489
+  data.tar.gz: 8f22938f47fbc5068cb0a40a02fd31c875b5cdc5b7e699b6049752060ec3accb
 SHA512:
-  metadata.gz: 511dfe169d347f644e9f5c24db3a03ba3faba965ceda23848d06295b58bca16c7de3020164febd7cc2611f26878d421663a709d599edede7a71dc164e8ae891a
-  data.tar.gz: 26f08d5c1e6725088ba9d2268a7ef0fe0daa604351c63afd4a44dd45208f21c68fce9270b8dbbabd104313b950f776de700e8b1a07eececa14d0007676260704
+  metadata.gz: 47d60879e7c32a8e518c3719d78c6c952dcc850c9897f49e4da0b4370d3a3e07e2d1233cf4b15a8eaf257671eae02aad4fd7d89d40d5a86525b8bf6a3ab6157b
+  data.tar.gz: f6a8c72b294fd4c6e29dff35d20c085463e0411bab413971c934ca43b80b331caa095b726d1cace6305a9db20865a6ec3877de1cdaf89d9d98f3aa9bbef2b284

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
@@ -38,6 +45,13 @@ module Bonchi
     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
@@ -58,6 +72,13 @@ module Bonchi
     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}"
@@ -77,6 +98,22 @@ module Bonchi
       signal_cd(path)
     end
 
+    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)
@@ -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"
@@ -133,6 +183,38 @@ module Bonchi
       end
     end
 
+    WORKTREE_YML_TEMPLATE = <<~YAML
+      # Worktree configuration for bonchi.
+      # See https://github.com/eval/bonchi
+
+      # 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
+
+      # Regex replacements in copied files. Env vars ($VAR) are expanded.
+      # Short form:
+      # replace:
+      #   .env.local:
+      #     - "^PORT=.*": "PORT=$PORT"
+      # Full form (with optional missing: warn, default: halt):
+      # replace:
+      #   .env.local:
+      #     - match: "^PORT=.*"
+      #       with: "PORT=$PORT"
+      #       missing: warn
+
+      # Commands to run before the setup command (port env vars are available).
+      # pre_setup:
+      #   - echo "preparing..."
+
+      # The setup command to run (default: bin/setup).
+      setup: bin/setup
+    YAML
+
     SHELL_ENV = <<~'SHELL'
       bonchi() {
           local bonchi_cd_file="${TMPDIR:-/tmp}/bonchi_cd.$$"

data/lib/bonchi/colors.rb

@@ -0,0 +1,20 @@
+module Bonchi
+  module Colors
+    private
+
+    def color(name)
+      return "" if ENV.key?("NO_COLOR")
+
+      case name
+      when :red then "\e[31m"
+      when :yellow then "\e[33m"
+      end
+    end
+
+    def reset
+      return "" if ENV.key?("NO_COLOR")
+
+      "\e[0m"
+    end
+  end
+end

data/lib/bonchi/config.rb

@@ -2,14 +2,25 @@ require "yaml"
 
 module Bonchi
   class Config
-    attr_reader :copy, :ports, :pre_setup, :setup
+    include Colors
+
+    KNOWN_KEYS = %w[copy ports replace pre_setup setup].freeze
+
+    attr_reader :copy, :ports, :replace, :pre_setup, :setup
 
     def initialize(path)
       data = YAML.load_file(path)
+
+      unknown = data.keys - KNOWN_KEYS
+      unknown.each { |k| warn "#{color(:yellow)}Warning:#{reset} unknown key '#{k}' in .worktree.yml, ignoring" }
+
       @copy = Array(data["copy"])
       @ports = Array(data["ports"])
+      @replace = data["replace"] || {}
       @pre_setup = Array(data["pre_setup"])
       @setup = data["setup"] || "bin/setup"
+
+      validate!
     end
 
     def self.from_main_worktree
@@ -19,5 +30,29 @@ module Bonchi
 
       new(path)
     end
+
+    private
+
+    def validate!
+      unless @replace.is_a?(Hash)
+        abort "#{color(:red)}Error:#{reset} 'replace' must be a mapping of filename to list of replacements"
+      end
+
+      @replace.each do |file, entries|
+        unless entries.is_a?(Array)
+          abort "#{color(:red)}Error:#{reset} 'replace.#{file}' must be a list of replacements"
+        end
+
+        entries.each do |entry|
+          unless entry.is_a?(Hash)
+            abort "#{color(:red)}Error:#{reset} each replacement in 'replace.#{file}' must be a mapping"
+          end
+        end
+      end
+
+      unless @setup.is_a?(String)
+        abort "#{color(:red)}Error:#{reset} 'setup' must be a string"
+      end
+    end
   end
 end

data/lib/bonchi/git.rb

@@ -4,6 +4,11 @@ module Bonchi
   module Git
     module_function
 
+    def current_branch(worktree = nil)
+      dir = worktree || Dir.pwd
+      `git -C #{dir.shellescape} rev-parse --abbrev-ref HEAD`.strip
+    end
+
     def repo_name
       url = `git remote get-url origin 2>/dev/null`.strip
       base = url.empty? ? `git rev-parse --show-toplevel`.strip : url

data/lib/bonchi/setup.rb

@@ -3,6 +3,8 @@ require "shellwords"
 
 module Bonchi
   class Setup
+    include Colors
+
     def initialize(worktree: nil)
       @worktree = worktree || Dir.pwd
       @main_worktree = Git.main_worktree
@@ -10,19 +12,23 @@ module Bonchi
 
     def run(args = [])
       if @worktree == @main_worktree
-        abort "Error: already in the main worktree"
+        abort "#{color(:red)}Error:#{reset} already in the main worktree"
       end
 
       config = Config.from_main_worktree
-      abort "Error: .worktree.yml not found in main worktree" unless config
+      abort "#{color(:red)}Error:#{reset} .worktree.yml not found in main worktree" unless config
 
-      ENV["MAIN_WORKTREE"] = @main_worktree
-      ENV["WORKTREE"] = @worktree
+      ENV["WORKTREE_MAIN"] = @main_worktree
+      ENV["WORKTREE_LINKED"] = @worktree
+      ENV["WORKTREE_BRANCH"] = Git.current_branch(@worktree)
+      ENV["WORKTREE_BRANCH_SLUG"] = ENV["WORKTREE_BRANCH"].gsub(/[^a-zA-Z0-9_]/, "_")
+      ENV["WORKTREE_ROOT"] ||= GlobalConfig.new.worktree_root
 
       puts "Setting up worktree from: #{@main_worktree}"
 
       allocate_ports(config.ports) if config.ports.any?
       copy_files(config.copy)
+      replace_in_files(config.replace) if config.replace.any?
       run_pre_setup(config.pre_setup)
       exec_setup(config.setup, args)
     end
@@ -42,8 +48,45 @@ module Bonchi
           FileUtils.cp(src, File.join(@worktree, file))
           puts "Copied #{file}"
         else
-          puts "Warning: #{file} not found in main worktree, skipping"
+          puts "#{color(:yellow)}Warning:#{reset} #{file} not found in main worktree, skipping"
+        end
+      end
+    end
+
+    def replace_in_files(replacements)
+      replacements.each do |file, entries|
+        path = File.join(@worktree, file)
+        abort "#{color(:red)}Error:#{reset} #{file} not found" unless File.exist?(path)
+
+        content = File.read(path)
+        entries.each do |entry|
+          if entry.is_a?(Hash) && entry.key?("match")
+            pattern = entry["match"]
+            replacement = entry["with"]
+            missing = entry["missing"] || "halt"
+          elsif entry.is_a?(Hash)
+            pattern, replacement = entry.first
+            missing = "halt"
+          else
+            abort "#{color(:red)}Error:#{reset} invalid replace entry in #{file}: #{entry.inspect}"
+          end
+
+          expanded = replacement.gsub(/\$(\w+)/) { ENV[$1] || abort("#{color(:red)}Error:#{reset} $#{$1} not set") }
+          regex = Regexp.new(pattern)
+
+          unless content.match?(regex)
+            if missing == "warn"
+              puts "#{color(:yellow)}Warning:#{reset} pattern #{pattern} not found in #{file}, skipping"
+              next
+            else
+              abort "#{color(:red)}Error:#{reset} pattern #{pattern} not found in #{file}"
+            end
+          end
+
+          content = content.gsub(regex, expanded)
+          puts "Replaced #{pattern} in #{file}"
         end
+        File.write(path, content)
       end
     end
 

data/lib/bonchi/version.rb

@@ -1,3 +1,3 @@
 module Bonchi
-  VERSION = "0.2.0.rc1"
+  VERSION = "0.3.0"
 end

data/lib/bonchi.rb

@@ -1,4 +1,5 @@
 require_relative "bonchi/version"
+require_relative "bonchi/colors"
 require_relative "bonchi/global_config"
 require_relative "bonchi/git"
 require_relative "bonchi/config"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bonchi
 version: !ruby/object:Gem::Version
-  version: 0.2.0.rc1
+  version: 0.3.0
 platform: ruby
 authors:
 - Gert Goet
@@ -34,6 +34,7 @@ files:
 - exe/bonchi
 - lib/bonchi.rb
 - lib/bonchi/cli.rb
+- lib/bonchi/colors.rb
 - lib/bonchi/config.rb
 - lib/bonchi/git.rb
 - lib/bonchi/global_config.rb