Module: GT::CLI

Defined in:
lib/gt/cli.rb

Constant Summary collapse

RESTACK_ONLY = 
%w[restack].freeze

Class Method Summary collapse

Class Method Details

.gh_installed? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
21
22
23
 
# File 'lib/gt/cli.rb', line 18

def self.gh_installed?
  _, _, status = Open3.capture3("gh --version")
  status.success?
rescue Errno::ENOENT
  false
end

.run(argv) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/gt/cli.rb', line 25

def self.run(argv)
  command = argv.shift

  if command.nil? || command == "--help" || command == "-h"
    puts usage
    return
  end

  if command == "--version" || command == "-v" || command == "version"
    puts "gt version #{GT::VERSION}"
    return
  end

  unless gh_installed?
    raise GT::UserError, "GitHub CLI (gh) is required but not found. Install it at https://cli.github.com/"
  end

  state = GT::State.new

  if state.active? && !RESTACK_ONLY.include?(command)
    raise GT::UserError, "A restack is in progress. Run `gt restack --continue` or `gt restack --abort`."
  end

  case command
  when "create"          then GT::Commands::Create.run(argv)
  when "log", "ls"       then GT::Commands::Log.run(argv)
  when "restack"         then GT::Commands::Restack.run(argv)
  when "modify", "m"     then GT::Commands::Modify.run(argv)
  when "sync"            then GT::Commands::Sync.run(argv)
  when "checkout", "co"  then GT::Commands::Checkout.run(argv)
  when "up"              then GT::Commands::Up.run(argv)
  when "down"            then GT::Commands::Down.run(argv)
  when "top"             then GT::Commands::Top.run(argv)
  else
    raise GT::UserError, "Unknown command: #{command}. Run `gt --help` for usage."
  end
rescue GT::UserError => e
  warn "gt: #{e.message}"
  exit 1
rescue GT::GitError => e
  warn "gt: git error: #{e.message}"
  exit 2
end

.usage ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/gt/cli.rb', line 69

def self.usage
  <<~USAGE
    Usage: gt <command> [options]

    Commands:
      create <name> [-m <msg>] [-p] Create a new stacked branch and PR
      log (ls)                     Show the current stack
      restack                      Rebase the stack onto updated parents
                                   (prompts to delete if bottom PR was merged)
      modify (m) [-m <msg>] [-p]   Amend the current branch and restack
      sync                         Pull main and restack

    Navigation:
      up                           Move up one level in the stack
      down                         Move down one level in the stack
      top                          Jump to the top of the stack
      checkout (co) [branch]       Switch to a branch in the stack

    Options for restack:
      --continue                   Continue after resolving conflicts
      --abort                      Abort an in-progress restack
  USAGE
end