workroom 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 709e14f9e8836400b840ad9772320ad6ddc9f2fbb163c800a0ba932b5d26ebe1
-  data.tar.gz: 6334a7e2daa13faaf34e3d7931bfe1082ec752b456f88531b255d429515c99da
+  metadata.gz: ba934ec40dd2fd562407526db171825603588166a1cdcbd757115815f2ef463a
+  data.tar.gz: f2b210d1f30f5efa1e8d00c9c0f06dc555439fae28e1decd1e40365fd58b84d5
 SHA512:
-  metadata.gz: 07ec6e20dfc896dec2a75cd11fe402b31c9dad2619ca323ac5b191ef23aa8cef681c742d41254356e62edef460aa5377c1e37d20c461d1e9f14caf15dec14658
-  data.tar.gz: 8915fa7afb229916379e8c0343550734b25300f87d6a64d3b495b4509afe1112e976e3138720920c1881dbac02366aee68dee7bed4e8f26d6c27ed95d6d49e40
+  metadata.gz: e26cfda013486738f9b16ee329048185be9b4dfc16d391b30ee36427c673b594e21327626c55de188dd619e12eeca11c5087dc2c54a94b592a3db0610acc67fc
+  data.tar.gz: '02567952050efaf0862f589097a5808d37c2bb48733cf20c06d57381f92491c7bcc1170b4f36895b461d79849bb4cfcd5cd2f60b2450761c756c3761aad59264'

data/README.md

@@ -1,8 +1,8 @@
 # Workroom
 
-Create and manage local development workrooms using [JJ](https://martinvonz.github.io/jj/) workspaces or git worktrees.
+Create and manage local development workrooms using [Git](https://git-scm.com/) worktrees or [Jujutsu](https://martinvonz.github.io/jj/) workspaces.
 
-A workroom is an isolated copy of your project created as a sibling directory, allowing you to work on multiple branches or features simultaneously without stashing or switching contexts.
+A workroom is an isolated copy of your project, allowing you to work on multiple branches or features simultaneously without stashing or switching contexts. Workrooms are created under a centralized directory (`~/workrooms` by default, configurable via `workrooms_dir` in `~/.config/workroom/config.json`).
 
 ## Installation
 
@@ -23,17 +23,29 @@ gem install workroom
 ## Requirements
 
 - Ruby >= 3.1
-- [JJ (Jujutsu)](https://martinvonz.github.io/jj/) or Git
+- [JJ (Jujutsu)](https://martinvonz.github.io/jj/) or [Git](https://git-scm.com/)
 
 ## Usage
 
 ### Create a workroom
 
 ```bash
-workroom create my-feature
+workroom create
 ```
 
-This creates a new workroom at `../my-feature` relative to your project root. Workroom automatically detects whether you're using JJ or Git and uses the appropriate mechanism (JJ workspace or git worktree).
+A random friendly name (e.g. `swift-meadow`) is auto-generated. Workroom automatically detects whether you're using JJ or Git and uses the appropriate mechanism (JJ workspace or git worktree).
+
+Alias: `workroom c`
+
+### List workrooms
+
+```bash
+workroom list
+```
+
+Lists all workrooms for the current project. When run from outside a known project, lists all workrooms grouped by parent project. When run from inside a workroom, shows the parent project path.
+
+Aliases: `workroom ls`, `workroom l`
 
 ### Delete a workroom
 
@@ -43,14 +55,25 @@ workroom delete my-feature
 
 Removes the workspace/worktree and cleans up the directory. You'll be prompted for confirmation before deletion.
 
+When run without a name, an interactive multi-select menu is shown, allowing you to pick one or more workrooms to delete:
+
+```bash
+workroom delete
+```
+
+To skip the confirmation prompt (useful for scripting), pass `--confirm` with the workroom name:
+
+```bash
+workroom delete my-feature --confirm my-feature
+```
+
+Alias: `workroom d`
+
 ### Options
 
 - `-v`, `--verbose` - Print detailed output
 - `-p`, `--pretend` - Run through the command without making changes (dry run)
-
-### Naming rules
-
-Workroom names must be alphanumeric (dashes and underscores allowed) and must not start or end with a dash or underscore.
+- `--confirm NAME` - Skip delete confirmation when NAME matches the workroom being deleted
 
 ## Setup and teardown scripts
 
@@ -62,7 +85,13 @@ Place an executable script at `scripts/workroom_setup` in your project. It will
 
 ### Teardown script
 
-Place an executable script at `scripts/workroom_teardown` in your project. It will run after a workroom is deleted.
+Place an executable script at `scripts/workroom_teardown` in your project. It will run inside the workroom directory before it is deleted.
+
+### Environment variables
+
+The following environment variables are available to setup and teardown scripts:
+
+- `WORKROOM_PARENT_DIR` - The absolute path to the parent project directory. Since scripts run inside the workroom directory, this lets you reference files in the original project root.
 
 ## Rails integration
 

data/bin/workroom

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler'
-Bundler.require
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '/../lib'))
+require 'workroom'
 
 Workroom::Commands.start

data/lib/workroom/commands.rb

@@ -2,6 +2,8 @@
 
 require 'open3'
 require 'thor'
+require 'tty-prompt'
+require 'pathname'
 
 module Workroom
   class Commands < Thor
@@ -19,15 +21,19 @@ module Workroom
       true
     end
 
-    desc 'create NAME', 'Create a new workroom'
+    map 'c' => :create
+    map 'd' => :delete
+    map %w[ls l] => :list
+
+    desc 'create|c', 'Create a new workroom'
     long_desc <<-DESC, wrap: false
-      Create a new workroom with the given NAME at the same level as your main project directory,
-      using JJ workspaces if available, otherwise falling back to git worktrees.
+      Create a new workroom at the same level as your main project directory, using JJ workspaces
+      if available, otherwise falling back to git worktrees. A random friendly name is
+      auto-generated.
     DESC
-    def create(name)
-      @name = name
+    def create
       check_not_in_workroom!
-      validate_name!
+      @name = generate_unique_name
 
       if !options[:pretend]
         if workroom_exists?
@@ -36,26 +42,76 @@ module Workroom
         end
 
         if workroom_path.exist?
-          raise_error DirExistsError, "Workroom directory '#{workroom_path}' already exists!"
+          raise_error DirExistsError,
+                      "Workroom directory '#{display_path(workroom_path)}' already exists!"
         end
       end
 
       create_workroom
+      update_config(:add)
       run_setup_script
 
       say
-      say "Workroom '#{name}' created successfully at #{workroom_path}.", :green
+      say "Workroom '#{name}' created successfully at #{display_path(workroom_path)}.", :green
 
-      return if !@setup_result
+      if @setup_result
+        say 'Setup script output:', :blue
+        say @setup_result
+      end
 
-      say 'Setup script output:', :blue
-      say @setup_result
+      say
     end
 
-    desc 'delete NAME', 'Delete an existing workroom'
-    def delete(name)
-      @name = name
+    desc 'list|l|ls', 'List all workrooms for the current project'
+    def list
+      project_path, project = config.find_current_project
+
+      # Inside a workroom
+      if project && Pathname.pwd.to_s != project_path
+        say 'You are already in a workroom.', :yellow
+        say "Parent project is at #{display_path(project_path)}"
+        return
+      end
+
+      # Inside a parent project
+      if project
+        workrooms = project['workrooms']
+        if !workrooms || workrooms.empty?
+          say 'No workrooms found for this project.'
+          return
+        end
+
+        list_workrooms(workrooms, project['vcs'])
+        return
+      end
+
+      # Neither — list all workrooms grouped by parent
+      if config.projects_with_workrooms.empty?
+        say 'No workrooms found.'
+        return
+      end
+
+      config.projects_with_workrooms.each do |path, proj|
+        say "#{display_path(path)}:"
+        inside path do
+          list_workrooms(proj['workrooms'], proj['vcs'])
+        end
+        say
+      end
+    end
+
+    desc 'delete|d [NAME]', 'Delete an existing workroom'
+    method_option :confirm, type: :string,
+                            desc: 'Skip confirmation if value matches the workroom name'
+    def delete(name = nil)
       check_not_in_workroom!
+
+      if !name
+        interactive_delete
+        return
+      end
+
+      @name = name
       validate_name!
 
       if !options[:pretend]
@@ -64,30 +120,19 @@ module Workroom
           raise_error exception, "#{vcs_label} '#{name}' does not exist!"
         end
 
-        if !yes?("Are you sure you want to delete workroom '#{name}'?")
+        if options[:confirm]
+          if options[:confirm] != name
+            raise_error ArgumentError,
+                        "--confirm value '#{options[:confirm]}' does not match " \
+                        "workroom name '#{name}'."
+          end
+        elsif !yes?("Are you sure you want to delete workroom '#{name}'?")
           say_error "Aborting. Workroom '#{name}' was not deleted.", :yellow
           return
         end
       end
 
-      delete_workroom
-      cleanup_directory if jj?
-      run_teardown_script
-
-      say
-      say "Workroom '#{name}' deleted successfully.", :green
-
-      if !jj?
-        say
-        say "Note: Git branch '#{name}' was not deleted."
-        say "      Delete manually with `git branch -D #{name}` if needed."
-      end
-
-      return if !@teardown_result
-
-      say
-      say 'Teardown script output:', :blue
-      say @teardown_result
+      delete_by_name(name)
     end
 
     private
@@ -95,13 +140,14 @@ module Workroom
       def run_setup_script
         return if !setup_script.exist?
 
+        parent_dir = Pathname.pwd.to_s
         inside workroom_path do
-          run_user_script :setup, setup_script_to_run.to_s
+          run_user_script :setup, setup_script_to_run.to_s, parent_dir
         end
       end
 
       def setup_script
-        @setup_script ||= workroom_path.join('scripts', 'workroom_setup')
+        @setup_script ||= Pathname.pwd.join('scripts', 'workroom_setup')
       end
 
       def setup_script_to_run
@@ -111,7 +157,10 @@ module Workroom
       def run_teardown_script
         return if !teardown_script.exist?
 
-        run_user_script :teardown, teardown_script_to_run.to_s
+        parent_dir = Pathname.pwd.to_s
+        inside workroom_path do
+          run_user_script :teardown, teardown_script_to_run.to_s, parent_dir
+        end
       end
 
       def teardown_script
@@ -122,7 +171,7 @@ module Workroom
         teardown_script
       end
 
-      def run_user_script(type, command)
+      def run_user_script(type, command, parent_dir)
         return if behavior != :invoke
 
         destination = relative_to_original_destination_root(destination_root, false)
@@ -131,7 +180,7 @@ module Workroom
 
         return if options[:pretend]
 
-        result, status = Open3.capture2e(command)
+        result, status = Open3.capture2e({ 'WORKROOM_PARENT_DIR' => parent_dir }, command)
 
         instance_variable_set :"@#{type}_result", result
 
@@ -147,8 +196,20 @@ module Workroom
         raise exception_class, message
       end
 
+      def config
+        @config ||= Config.new
+      end
+
+      def workrooms_dir
+        @workrooms_dir ||= config.workrooms_dir
+      end
+
+      def vcs_name
+        "workroom/#{name}"
+      end
+
       def workroom_path
-        @workroom_path ||= Pathname.pwd.join("../#{name}")
+        @workroom_path ||= workrooms_dir.join(name)
       end
 
       def jj?
@@ -163,9 +224,9 @@ module Workroom
                    say_status :repo, 'Detected Git'
                    :git
                  else
-                   say_status :repo, 'No supported VCS detected', :red
+                   say_status :repo, 'No supported VCS detected in this directory.', :red
                    raise_error UnsupportedVCSError, <<~_
-                     No supported VCS detected. Workroom requires either Jujutsu or Git to manage workspaces.
+                     No supported VCS detected in this directory. Workroom requires either Git or Jujutsu to manage workspaces.
                    _
                  end
       end
@@ -179,7 +240,7 @@ module Workroom
       end
 
       def jj_workspace_exists?
-        jj_workspaces.include?(name)
+        jj_workspaces.include?(vcs_name)
       end
 
       def git_worktree_exists?
@@ -230,22 +291,106 @@ module Workroom
       def check_not_in_workroom!
         return if !Pathname.pwd.join('.Workroom').exist?
 
-        say_status :create, name, :red
         raise_error InWorkroomError, <<~_
           Looks like you are already in a workroom. Run this command from the root of your main development directory, not from within an existing workroom.
         _
       end
 
+      def interactive_delete
+        _, project = config.find_current_project
+
+        if !project || !project['workrooms'] || project['workrooms'].empty?
+          say 'No workrooms found for this project.'
+          return
+        end
+
+        workrooms = project['workrooms']
+        prompt = TTY::Prompt.new
+        selected = prompt.multi_select(
+          'Select workrooms to delete:',
+          workrooms.keys
+        )
+
+        if selected.empty?
+          say_error 'Aborting. No workrooms were selected.', :yellow
+          return
+        end
+
+        names_list = selected.map { |n| "'#{n}'" }.join(', ')
+        if !yes?("Are you sure you want to delete #{selected.size} workroom(s): #{names_list}?")
+          say_error 'Aborting. No workrooms were deleted.', :yellow
+          return
+        end
+
+        selected.each { |n| delete_by_name(n) }
+      end
+
+      def delete_by_name(selected_name)
+        @name = selected_name
+        @workroom_path = nil
+
+        run_teardown_script
+        delete_workroom
+        cleanup_directory if jj?
+        update_config(:remove)
+
+        say "Workroom '#{name}' deleted successfully.", :green
+
+        if !jj?
+          say
+          say "Note: Git branch '#{vcs_name}' was not deleted."
+          say "      Delete manually with `git branch -D #{vcs_name}` if needed."
+        end
+
+        return if !@teardown_result
+
+        say
+        say 'Teardown script output:', :blue
+        say @teardown_result
+        say
+      end
+
+      def generate_unique_name
+        generator = NameGenerator.new
+        last_name = nil
+
+        5.times do
+          last_name = generator.generate
+          if !workroom_exists_for?(last_name) && !workroom_path_for(last_name).exist?
+            return last_name
+          end
+        end
+
+        loop do
+          candidate = "#{last_name}-#{rand(10..99)}"
+          if !workroom_exists_for?(candidate) && !workroom_path_for(candidate).exist?
+            return candidate
+          end
+        end
+      end
+
+      def workroom_exists_for?(candidate)
+        @name = candidate
+        @workroom_path = nil
+        workroom_exists?
+      end
+
+      def workroom_path_for(candidate)
+        workrooms_dir.join(candidate)
+      end
+
       def create_workroom
+        FileUtils.mkdir_p(workrooms_dir) if !workrooms_dir.exist?
+
         if testing?
           FileUtils.copy('./', workroom_path)
           return
         end
 
         if jj?
-          run "jj workspace add #{workroom_path}"
+          run "jj workspace add #{workroom_path} --name #{vcs_name}"
         else
-          run "git worktree add -b #{name} #{workroom_path}"
+          run "git worktree add -b #{vcs_name} #{workroom_path}"
         end
       end
 
@@ -256,7 +401,7 @@ module Workroom
         end
 
         if jj?
-          run "jj workspace forget #{name}"
+          run "jj workspace forget #{vcs_name}"
         else
           run "git worktree remove #{workroom_path} --force"
         end
@@ -268,6 +413,16 @@ module Workroom
         remove_dir(workroom_path, verbose:)
       end
 
+      def update_config(action)
+        return if options[:pretend]
+
+        if action == :add
+          config.add_workroom Pathname.pwd.to_s, name, workroom_path.to_s, vcs
+        else
+          config.remove_workroom Pathname.pwd.to_s, name
+        end
+      end
+
       def run(command, config = {})
         if !config[:force] && testing?
           raise TestError, "Command execution blocked during testing: `#{command}`"
@@ -290,5 +445,33 @@ module Workroom
       def testing?
         ENV['WORKROOM_TEST'] == '1'
       end
+
+      def display_path(path)
+        path.to_s.sub(/\A#{Regexp.escape(Dir.home)}/, '~')
+      end
+
+      def list_workrooms(workrooms, vcs)
+        rows = workrooms.map do |name, info|
+          warnings = workroom_warnings(name, info, vcs)
+          row = [shell.set_color(name, :bold), shell.set_color(display_path(info['path']), :black)]
+          row << shell.set_color("[#{warnings.join(', ')}]", :yellow) if warnings.any?
+          row
+        end
+        print_table rows, indent: 2
+      end
+
+      def workroom_warnings(name, info, stored_vcs)
+        warnings = []
+        warnings << 'directory not found' if !Dir.exist?(info['path'])
+        if !testing?
+          vcs_missing = if stored_vcs == 'jj'
+                          !jj_workspaces.include?("workroom/#{name}")
+                        elsif stored_vcs == 'git'
+                          git_worktrees.none? { |path| File.basename(path) == name }
+                        end
+          warnings << "#{stored_vcs} workspace not found" if vcs_missing
+        end
+        warnings
+      end
   end
 end

data/lib/workroom/config.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+module Workroom
+  class Config
+    CONFIG_DIR = File.expand_path('~/.config/workroom')
+    DEFAULT_WORKROOMS_DIR = '~/workrooms'
+
+    def config_path
+      @config_path ||= File.join(CONFIG_DIR, 'config.json')
+    end
+
+    def read
+      return {} if !File.exist?(config_path)
+
+      JSON.parse(File.read(config_path))
+    end
+
+    def write(data)
+      dir = File.dirname(config_path)
+      FileUtils.mkdir_p(dir)
+      File.write(config_path, JSON.pretty_generate(data))
+    end
+
+    def add_workroom(parent_path, name, workroom_path, vcs)
+      update do |data|
+        data[parent_path] ||= { 'vcs' => vcs.to_s, 'workrooms' => {} }
+        data[parent_path]['vcs'] = vcs.to_s
+        data[parent_path]['workrooms'][name] = { 'path' => workroom_path }
+      end
+    end
+
+    def remove_workroom(parent_path, name)
+      update do |data|
+        return if !data[parent_path]
+
+        data[parent_path]['workrooms'].delete(name)
+        data.delete(parent_path) if data[parent_path]['workrooms'].empty?
+      end
+    end
+
+    # Find the project for the current directory. If pwd is a project in the config, return it
+    # directly. Otherwise, check if pwd is a workroom path under any project.
+    def find_current_project
+      data = read
+      pwd = Pathname.pwd.to_s
+      return [pwd, data[pwd]] if data.key?(pwd)
+
+      data.each do |project_path, project|
+        workrooms = project['workrooms'] || {}
+        return [project_path, project] if workrooms.any? { |_, info| info['path'] == pwd }
+      end
+
+      [pwd, nil]
+    end
+
+    def projects_with_workrooms
+      @projects_with_workrooms ||= read.select { |_, p| p['workrooms']&.any? }
+    end
+
+    def workrooms_dir
+      Pathname.new(File.expand_path(read['workrooms_dir'] || DEFAULT_WORKROOMS_DIR))
+    end
+
+    def workrooms_dir=(path)
+      update { |data| data['workrooms_dir'] = path }
+    end
+
+    private
+
+      def update
+        data = read
+        yield data
+        write data
+      end
+  end
+end

data/lib/workroom/name_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Workroom
+  class NameGenerator
+    ADJECTIVES = %w[
+      agile amber apt azure bold brave bright brisk calm cedar clear cold cool
+      coral crisp cyan damp dark dawn deep deft dry dusk dusty easy even fair
+      fast firm flat fond free fresh full glad gold good gray green hale happy
+      hazy high idle jade keen kind lark last lean left light lime long lost
+      loud lush mild mint misty mossy neat nice noble north novel oak odd opal
+      open pale peak pine pink plum proud pure quick quiet rapid rare red rich
+      ripe rosy ruby safe sage salt sharp shy silk slim slow smart snowy soft
+      solid south stark steel still stout sunny sure swift tall tame teal thin
+      tidy trim true vivid warm west wide wild wise young
+    ].freeze
+
+    NOUNS = %w[
+      acre arch aspen badge bank bark basin bay beach bear birch blade blaze
+      bloom bolt bone bow brace brass breeze brick bridge brook brush canopy
+      cape cave cedar chain chime cliff cloud clover colt coop coral core
+      cove crane creek crest crow curve dale dawn deer delta dew dock dove
+      drake drift dune dusk eagle edge elm ember fawn feather fern field finch
+      fjord flame flask flint float flora flute fog font forge fox frost gate
+      glade glen globe gorge grain grove gulf gust hare haven hawk hazel
+      heath hedge heron hill hollow horn inlet isle ivy jade jewel knoll
+      lake larch lark latch laurel leaf ledge light lilac lily linen lodge
+      loft lynx maple marsh meadow mesa mint mirror mist moon moss mound
+      nest north oak opal orbit orion otter palm pass path peak pearl
+      pebble perch petal pine pixel plume pond pool porch prism quail
+      quarry quartz rail rain raven reef ridge river robin rock root rose
+      ruby sage sand scope seal seed shade shell shore silk sky slate
+      slope smoke snow south spark spire spoke spring spruce star stem
+      stone stork storm strand surf swift tern thyme tide timber tower
+      trail tree vale vault vine vista wand ward wave west wheat willow
+      wind wing wolf wren yard
+    ].freeze
+
+    def generate
+      "#{ADJECTIVES.sample}-#{NOUNS.sample}"
+    end
+  end
+end

data/lib/workroom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Workroom
-  VERSION = '0.1.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workroom
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Joel Moss
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -51,7 +65,9 @@ files:
 - bin/workroom
 - lib/workroom.rb
 - lib/workroom/commands.rb
+- lib/workroom/config.rb
 - lib/workroom/engine.rb
+- lib/workroom/name_generator.rb
 - lib/workroom/version.rb
 homepage: https://github.com/joelmoss/workroom
 licenses: