carson 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d430ed51ffe8ee87c8aa2a652c63d92ef7e9f0a65713b9104dd4df57dbcba90a
-  data.tar.gz: d5bf899e7acc479cb5f673c0ba0323dce10e83a6c8d843f418d9db53adbbed38
+  metadata.gz: 43f5ee17800cad35a51d2aaaf6ce306197bf2823cc6b0de4858912213d06e01b
+  data.tar.gz: 51b3a3e91d84a98266b2bccee868e583c25609c5466e34c938b2fa2bcd6564fc
 SHA512:
-  metadata.gz: 903da2928ca57d07422e7450670efb7686603934fc2b7aa8122789fcea6ecce2e1b841420c15c2df39dc33b2789c4d3a85a0cb56dc5816aa1b0216fa103f7cb5
-  data.tar.gz: 2c67d3aa87576d0124d3ea2fb31fdaf8457cbfb81199c539e103072636a1fcaef4e1274c3642d1a843117c1cd88a69e437cf369c5f981a06fed50d6e57e0d2f3
+  metadata.gz: c7bca3554a185fc1951292d62e0bfcfd6b63d77488d22013f14b93885e6b8d043d2d30e20e8e9725796d26bc3aaa031bcce8f0b28474ab3198bf77733c56f0c5
+  data.tar.gz: ce3240db72d7fb1c6a5aa9f590628d23e3533778cc492def9c73951a8f5b6772a347cb8d64c79e0063fb79f67f16fb663c9a8ecdc33db7f9af15e0204678adfd

data/RELEASE.md

@@ -5,6 +5,24 @@ Release-note scope rule:
 - `RELEASE.md` records only version deltas, breaking changes, and migration actions.
 - Operational usage guides live in `MANUAL.md` and `API.md`.
 
+## 3.7.0 — Worktree JSON + Recovery
+
+### What changed
+
+- **`carson worktree --json create|done|remove`** — machine-readable JSON output for all three worktree commands. Each returns a structured envelope with `command`, `status`, `name`, `exit_code`, and context-specific fields (`path`, `branch`, `next_step`).
+- **Recovery-aware worktree errors** — every error and block path includes a `recovery` field with the exact command to run next. Dirty worktree, missing name, unregistered worktree, unpushed commits — all include actionable recovery.
+- **Unified `worktree_finish` / `print_worktree_human`** — consistent output pattern matching deliver, sync, and prune.
+
+### UX
+
+- Human output preserved unchanged when `--json` is not passed.
+- `worktree done` includes `next_step` in JSON output pointing to `carson worktree remove`.
+- `worktree remove` includes `branch_deleted` and `remote_deleted` booleans for complete lifecycle visibility.
+
+### Migration
+
+- No breaking changes. All worktree commands without `--json` behave identically to 3.6.0.
+
 ## 3.6.0 — Prune JSON + Recovery
 
 ### What changed

data/VERSION

@@ -1 +1 @@
-3.6.0
+3.7.0

data/lib/carson/cli.rb

@@ -53,7 +53,7 @@ module Carson
 
 		def self.build_parser
 			OptionParser.new do |opts|
-				opts.banner = "Usage: carson [status [--json]|setup|audit [--json]|sync [--json]|deliver [--merge] [--json] [--title T] [--body-file F]|prune [--all] [--json]|worktree create|done|remove <name>|onboard|refresh [--all]|offboard|template check|apply|review gate|sweep|govern [--dry-run] [--json] [--loop SECONDS]|version]"
+				opts.banner = "Usage: carson [status [--json]|setup|audit [--json]|sync [--json]|deliver [--merge] [--json] [--title T] [--body-file F]|prune [--all] [--json]|worktree [--json] create|done|remove <name>|onboard|refresh [--all]|offboard|template check|apply|review gate|sweep|govern [--dry-run] [--json] [--loop SECONDS]|version]"
 			end
 		end
 
@@ -175,6 +175,7 @@ module Carson
 		end
 
 		def self.parse_worktree_subcommand( argv:, parser:, err: )
+			json_flag = argv.delete( "--json" ) ? true : false
 			action = argv.shift
 			if action.to_s.strip.empty?
 				err.puts "#{BADGE} Missing subcommand for worktree. Use: carson worktree create|done|remove <name>"
@@ -189,10 +190,10 @@ module Carson
 					err.puts "#{BADGE} Missing name for worktree create. Use: carson worktree create <name>"
 					return { command: :invalid }
 				end
-				{ command: "worktree:create", worktree_name: name }
+				{ command: "worktree:create", worktree_name: name, json: json_flag }
 			when "done"
 				name = argv.shift
-				{ command: "worktree:done", worktree_name: name }
+				{ command: "worktree:done", worktree_name: name, json: json_flag }
 			when "remove"
 				force = argv.delete( "--force" ) ? true : false
 				worktree_path = argv.shift
@@ -200,7 +201,7 @@ module Carson
 					err.puts "#{BADGE} Missing path for worktree remove. Use: carson worktree remove <name-or-path>"
 					return { command: :invalid }
 				end
-				{ command: "worktree:remove", worktree_path: worktree_path, force: force }
+				{ command: "worktree:remove", worktree_path: worktree_path, force: force, json: json_flag }
 			else
 				err.puts "#{BADGE} Unknown worktree subcommand: #{action}. Use: carson worktree create|done|remove <name>"
 				{ command: :invalid }
@@ -352,11 +353,11 @@ module Carson
 			when "prune:all"
 				runtime.prune_all!
 			when "worktree:create"
-				runtime.worktree_create!( name: parsed.fetch( :worktree_name ) )
+				runtime.worktree_create!( name: parsed.fetch( :worktree_name ), json_output: parsed.fetch( :json, false ) )
 			when "worktree:done"
-				runtime.worktree_done!( name: parsed.fetch( :worktree_name, nil ) )
+				runtime.worktree_done!( name: parsed.fetch( :worktree_name, nil ), json_output: parsed.fetch( :json, false ) )
 			when "worktree:remove"
-				runtime.worktree_remove!( worktree_path: parsed.fetch( :worktree_path ), force: parsed.fetch( :force, false ) )
+				runtime.worktree_remove!( worktree_path: parsed.fetch( :worktree_path ), force: parsed.fetch( :force, false ), json_output: parsed.fetch( :json, false ) )
 			when "onboard"
 				runtime.onboard!
 			when "refresh"

data/lib/carson/runtime/local/worktree.rb

@@ -1,19 +1,23 @@
+# Safe worktree lifecycle management for coding agents.
+# Three operations: create, done (mark completed), remove (batch cleanup).
+# The deferred deletion model: worktrees persist after use, cleaned up later.
+# Supports --json for machine-readable structured output with recovery commands.
 module Carson
 	class Runtime
 		module Local
-			# Safe worktree lifecycle management for coding agents.
-			# Three operations: create, done (mark completed), remove (batch cleanup).
-			# The deferred deletion model: worktrees persist after use, cleaned up later.
 
 			# Creates a new worktree under .claude/worktrees/<name> with a fresh branch.
-			def worktree_create!( name: )
+			def worktree_create!( name:, json_output: false )
 				worktrees_dir = File.join( repo_root, ".claude", "worktrees" )
 				wt_path = File.join( worktrees_dir, name )
 
 				if Dir.exist?( wt_path )
-					puts_line "ERROR: worktree already exists: #{name}"
-					puts_line "  Path: #{wt_path}"
-					return EXIT_ERROR
+					return worktree_finish(
+						result: { command: "worktree create", status: "error", name: name, path: wt_path,
+							error: "worktree already exists: #{name}",
+							recovery: "carson worktree remove #{name}, then retry" },
+						exit_code: EXIT_ERROR, json_output: json_output
+					)
 				end
 
 				# Determine the base branch (main branch from config).
@@ -25,38 +29,51 @@ module Carson
 				unless wt_success
 					error_text = wt_stderr.to_s.strip
 					error_text = "unable to create worktree" if error_text.empty?
-					puts_line "ERROR: #{error_text}"
-					return EXIT_ERROR
+					return worktree_finish(
+						result: { command: "worktree create", status: "error", name: name,
+							error: error_text },
+						exit_code: EXIT_ERROR, json_output: json_output
+					)
 				end
 
-				puts_line "Worktree created: #{name}"
-				puts_line "  Path: #{wt_path}"
-				puts_line "  Branch: #{name}"
-				EXIT_OK
+				worktree_finish(
+					result: { command: "worktree create", status: "ok", name: name, path: wt_path, branch: name },
+					exit_code: EXIT_OK, json_output: json_output
+				)
 			end
 
 			# Marks a worktree as completed without deleting it.
 			# Verifies all changes are committed. Deferred deletion — cleanup happens later.
-			def worktree_done!( name: nil )
+			def worktree_done!( name: nil, json_output: false )
 				if name.to_s.strip.empty?
-					# Try to detect current worktree from CWD.
-					puts_line "ERROR: missing worktree name. Use: carson worktree done <name>"
-					return EXIT_ERROR
+					return worktree_finish(
+						result: { command: "worktree done", status: "error",
+							error: "missing worktree name",
+							recovery: "carson worktree done <name>" },
+						exit_code: EXIT_ERROR, json_output: json_output
+					)
 				end
 
 				resolved_path = resolve_worktree_path( worktree_path: name )
 
 				unless worktree_registered?( path: resolved_path )
-					puts_line "ERROR: #{name} is not a registered worktree."
-					return EXIT_ERROR
+					return worktree_finish(
+						result: { command: "worktree done", status: "error", name: name,
+							error: "#{name} is not a registered worktree",
+							recovery: "git worktree list" },
+						exit_code: EXIT_ERROR, json_output: json_output
+					)
 				end
 
 				# Check for uncommitted changes in the worktree.
 				wt_status, _, status_success, = Open3.capture3( "git", "status", "--porcelain", chdir: resolved_path )
 				if status_success && !wt_status.strip.empty?
-					puts_line "Worktree has uncommitted changes: #{name}"
-					puts_line "  Commit your changes first, then run `carson worktree done #{name}` again."
-					return EXIT_BLOCK
+					return worktree_finish(
+						result: { command: "worktree done", status: "block", name: name,
+							error: "worktree has uncommitted changes",
+							recovery: "git -C #{resolved_path} add -A && git -C #{resolved_path} commit, then carson worktree done #{name}" },
+						exit_code: EXIT_BLOCK, json_output: json_output
+					)
 				end
 
 				# Check for unpushed commits.
@@ -66,39 +83,54 @@ module Carson
 					remote_ref = "#{remote}/#{branch}"
 					ahead, _, ahead_ok, = Open3.capture3( "git", "rev-list", "--count", "#{remote_ref}..#{branch}", chdir: resolved_path )
 					if ahead_ok && ahead.strip.to_i > 0
-						puts_line "Worktree has unpushed commits: #{name}"
-						puts_line "  Push with `git -C #{resolved_path} push #{remote} #{branch}` first."
-						return EXIT_BLOCK
+						return worktree_finish(
+							result: { command: "worktree done", status: "block", name: name, branch: branch,
+								error: "worktree has unpushed commits",
+								recovery: "git -C #{resolved_path} push #{remote} #{branch}" },
+							exit_code: EXIT_BLOCK, json_output: json_output
+						)
 					end
 				end
 
-				puts_line "Worktree done: #{name}"
-				puts_line "  Branch: #{branch || '(detached)'}"
-				puts_line "  Cleanup later with `carson worktree remove #{name}` or `carson housekeep`."
-				EXIT_OK
+				worktree_finish(
+					result: { command: "worktree done", status: "ok", name: name, branch: branch || "(detached)",
+						next_step: "carson worktree remove #{name}" },
+					exit_code: EXIT_OK, json_output: json_output
+				)
 			end
 
 			# Removes a worktree: directory, git registration, and branch.
 			# Never forces removal — if the worktree has uncommitted changes, refuses unless
 			# the user explicitly passes force: true via CLI --force flag.
-			def worktree_remove!( worktree_path:, force: false )
+			def worktree_remove!( worktree_path:, force: false, json_output: false )
 				fingerprint_status = block_if_outsider_fingerprints!
-				return fingerprint_status unless fingerprint_status.nil?
+				unless fingerprint_status.nil?
+					if json_output
+						out.puts JSON.pretty_generate( {
+							command: "worktree remove", status: "block",
+							error: "Carson-owned artefacts detected in host repository",
+							recovery: "remove Carson-owned files (.carson.yml, bin/carson, .tools/carson) then retry",
+							exit_code: EXIT_BLOCK
+						} )
+					end
+					return fingerprint_status
+				end
 
 				resolved_path = resolve_worktree_path( worktree_path: worktree_path )
 
 				unless worktree_registered?( path: resolved_path )
-					puts_line "ERROR: #{resolved_path} is not a registered worktree."
-					puts_line "  Registered worktrees:"
-					worktree_list.each { |wt| puts_line "  - #{wt.fetch( :path )} [#{wt.fetch( :branch )}]" }
-					return EXIT_ERROR
+					return worktree_finish(
+						result: { command: "worktree remove", status: "error", name: File.basename( resolved_path ),
+							error: "#{resolved_path} is not a registered worktree",
+							recovery: "git worktree list" },
+						exit_code: EXIT_ERROR, json_output: json_output
+					)
 				end
 
 				branch = worktree_branch( path: resolved_path )
 				puts_verbose "worktree_remove: path=#{resolved_path} branch=#{branch} force=#{force}"
 
 				# Step 1: remove the worktree (directory + git registration).
-				# Try safe removal first. Only use --force if the user explicitly requested it.
 				rm_args = [ "worktree", "remove" ]
 				rm_args << "--force" if force
 				rm_args << resolved_path
@@ -107,40 +139,96 @@ module Carson
 					error_text = rm_stderr.to_s.strip
 					error_text = "unable to remove worktree" if error_text.empty?
 					if !force && ( error_text.downcase.include?( "untracked" ) || error_text.downcase.include?( "modified" ) )
-						puts_line "Worktree has uncommitted changes: #{File.basename( resolved_path )}"
-						puts_line "  Commit or discard changes first, or use --force to override."
-					else
-						puts_line "ERROR: #{error_text}"
+						return worktree_finish(
+							result: { command: "worktree remove", status: "error", name: File.basename( resolved_path ),
+								error: "worktree has uncommitted changes",
+								recovery: "commit or discard changes first, or use --force to override" },
+							exit_code: EXIT_ERROR, json_output: json_output
+						)
 					end
-					return EXIT_ERROR
+					return worktree_finish(
+						result: { command: "worktree remove", status: "error", name: File.basename( resolved_path ),
+							error: error_text },
+						exit_code: EXIT_ERROR, json_output: json_output
+					)
 				end
 				puts_verbose "worktree_removed: #{resolved_path}"
 
 				# Step 2: delete the local branch.
+				branch_deleted = false
 				if branch && !config.protected_branches.include?( branch )
 					_, del_stderr, del_success, = git_run( "branch", "-D", branch )
 					if del_success
 						puts_verbose "branch_deleted: #{branch}"
+						branch_deleted = true
 					else
 						puts_verbose "branch_delete_skipped: #{branch} reason=#{del_stderr.to_s.strip}"
 					end
 				end
 
 				# Step 3: delete the remote branch (best-effort).
+				remote_deleted = false
 				if branch && !config.protected_branches.include?( branch )
 					remote_branch = branch
-					git_run( "push", config.git_remote, "--delete", remote_branch )
-					puts_verbose "remote_branch_deleted: #{config.git_remote}/#{remote_branch}"
+					_, _, rd_success, = git_run( "push", config.git_remote, "--delete", remote_branch )
+					if rd_success
+						puts_verbose "remote_branch_deleted: #{config.git_remote}/#{remote_branch}"
+						remote_deleted = true
+					end
 				end
 
-				unless verbose?
-					puts_line "Worktree removed: #{File.basename( resolved_path )}"
-				end
-				EXIT_OK
+				worktree_finish(
+					result: { command: "worktree remove", status: "ok", name: File.basename( resolved_path ),
+						branch: branch, branch_deleted: branch_deleted, remote_deleted: remote_deleted },
+					exit_code: EXIT_OK, json_output: json_output
+				)
 			end
 
 		private
 
+			# Unified output for worktree results — JSON or human-readable.
+			def worktree_finish( result:, exit_code:, json_output: )
+				result[ :exit_code ] = exit_code
+
+				if json_output
+					out.puts JSON.pretty_generate( result )
+				else
+					print_worktree_human( result: result )
+				end
+
+				exit_code
+			end
+
+			# Human-readable output for worktree results.
+			def print_worktree_human( result: )
+				command = result[ :command ]
+				status = result[ :status ]
+
+				case status
+				when "ok"
+					case command
+					when "worktree create"
+						puts_line "Worktree created: #{result[ :name ]}"
+						puts_line "  Path: #{result[ :path ]}"
+						puts_line "  Branch: #{result[ :branch ]}"
+					when "worktree done"
+						puts_line "Worktree done: #{result[ :name ]}"
+						puts_line "  Branch: #{result[ :branch ]}"
+						puts_line "  Cleanup later with `#{result[ :next_step ]}` or `carson housekeep`."
+					when "worktree remove"
+						unless verbose?
+							puts_line "Worktree removed: #{result[ :name ]}"
+						end
+					end
+				when "error"
+					puts_line "ERROR: #{result[ :error ]}"
+					puts_line "  Recovery: #{result[ :recovery ]}" if result[ :recovery ]
+				when "block"
+					puts_line "#{result[ :error ]&.capitalize || 'Blocked'}: #{result[ :name ]}"
+					puts_line "  Recovery: #{result[ :recovery ]}" if result[ :recovery ]
+				end
+			end
+
 			# Resolves a worktree path: if it's a bare name, look under .claude/worktrees/.
 			def resolve_worktree_path( worktree_path: )
 				return File.expand_path( worktree_path ) if worktree_path.include?( "/" )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carson
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Hailei Wang