cli-kit 4.0.0 → 5.0.0

data/gen/lib/gen/commands/help.rb

@@ -1,19 +1,17 @@
+# typed: true
+
 require 'gen'
 
 module Gen
   module Commands
     class Help < Gen::Command
-      def call(_args, _name)
-        puts CLI::UI.fmt('{{bold:Available commands}}')
-        puts ''
+      extend T::Sig
+
+      desc('Show help for a command, or this page')
 
-        Gen::Commands::Registry.resolved_commands.each do |name, klass|
-          puts CLI::UI.fmt("{{command:#{Gen::TOOL_NAME} #{name}}}")
-          if klass.respond_to?(:help) && (help = klass.help)
-            puts CLI::UI.fmt(help)
-          end
-          puts ''
-        end
+      sig { params(args: T::Array[String], _name: String).void }
+      def call(args, _name)
+        Gen::Help.generate(args)
       end
     end
   end

data/gen/lib/gen/commands/new.rb

@@ -1,20 +1,34 @@
+# typed: true
+
 require 'gen'
 
 module Gen
   module Commands
     class New < Gen::Command
-      def call(args, _name)
-        unless args.size == 1
-          puts CLI::UI.fmt(self.class.help)
-          raise(CLI::Kit::AbortSilent)
-        end
-        project = args.first
+      extend T::Sig
+
+      command_name('new')
+      desc('Create a new project')
+      long_desc(<<~LONGDESC)
+        This is currently a very simple command. In theory it could be extended
+        to support a number of flags like {{command:bundle gem}}, etc. As it is, it only
+        takes an application name.
+      LONGDESC
+      usage('[app_name]')
+      example('mycliapp', "create a new project called 'mycliapp'")
 
-        Gen::Generator.run(project)
+      class Opts < CLI::Kit::Opts
+        extend(T::Sig)
+
+        sig { returns(String) }
+        def project_name
+          position!
+        end
       end
 
-      def self.help
-        "Generate a new cli-kit project.\nUsage: {{command:#{Gen::TOOL_NAME} new <name>}}"
+      sig { params(op: Opts, _name: T.untyped).returns(T.untyped) }
+      def invoke(op, _name)
+        Gen::Generator.run(op.project_name)
       end
     end
   end

data/gen/lib/gen/commands.rb

@@ -1,18 +1,30 @@
+# typed: true
+
 require 'gen'
 
 module Gen
   module Commands
-    Registry = CLI::Kit::CommandRegistry.new(
-      default: 'help',
-      contextual_resolver: nil
-    )
+    extend T::Sig
+
+    Registry = CLI::Kit::CommandRegistry.new(default: 'help')
 
-    def self.register(const, cmd, path)
-      autoload(const, path)
-      Registry.add(->() { const_get(const) }, cmd)
+    class << self
+      extend T::Sig
+
+      sig do
+        params(const: Symbol, cmd: String, path: String, lamda_const: T.proc.returns(T.class_of(Gen::Command))).void
+      end
+      def register(const, cmd, path, lamda_const)
+        autoload(const, path)
+        Registry.add(lamda_const, cmd)
+      end
     end
 
-    register :Help, 'help', 'gen/commands/help'
-    register :New,  'new',  'gen/commands/new'
+    register :Help, 'help', 'gen/commands/help', -> { Commands::Help }
+    register :New,  'new',  'gen/commands/new', -> { Commands::New }
+
+    # TODO(burke): Really, cli-kit needs to handle global flags/options.
+    Registry.add_alias('-h', 'help')
+    Registry.add_alias('--help', 'help')
   end
 end

data/gen/lib/gen/entry_point.rb

@@ -1,10 +1,19 @@
+# typed: true
+
 require 'gen'
 
 module Gen
   module EntryPoint
-    def self.call(args)
-      cmd, command_name, args = Gen::Resolver.call(args)
-      Gen::Executor.call(cmd, command_name, args)
+    extend T::Sig
+
+    class << self
+      extend T::Sig
+
+      sig { params(args: T::Array[String]).void }
+      def call(args)
+        cmd, command_name, args = Gen::Resolver.call(args)
+        Gen::Executor.call(cmd, command_name, args)
+      end
     end
   end
 end

data/gen/lib/gen/generator.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'gen'
 require 'fileutils'
 require 'open3'
@@ -6,8 +8,15 @@ require 'tmpdir'
 
 module Gen
   class Generator
-    def self.run(project_name)
-      new(project_name).run
+    extend T::Sig
+
+    class << self
+      extend T::Sig
+
+      sig { params(project_name: String).void }
+      def run(project_name)
+        new(project_name).run
+      end
     end
 
     TEMPLATE_ROOT = File.expand_path('gen/template', Gen::ROOT)
@@ -35,15 +44,17 @@ module Gen
     }.freeze
     private_constant :BUNDLER_TRANSLATIONS
 
+    sig { params(project_name: String).void }
     def initialize(project_name)
       raise(
         CLI::Kit::Abort,
-        "project name must match {{bold:#{VALID_PROJECT_NAME}}} (but can be changed later)"
+        "project name must match {{bold:#{VALID_PROJECT_NAME}}} (but can be changed later)",
       ) unless project_name =~ VALID_PROJECT_NAME
       @project_name = project_name
       @title_case_project_name = @project_name.sub(/^./, &:upcase)
     end
 
+    sig { void }
     def run
       vendor = ask_vendor?
       create_project_dir
@@ -57,11 +68,12 @@ module Gen
 
     private
 
+    sig { returns(T::Boolean) }
     def ask_vendor?
       return true if ENV['DEPS'] == 'vendor'
       return false if ENV['DEPS'] == 'bundler'
 
-      vendor = nil
+      vendor = T.let(nil, T.nilable(String))
       CLI::UI::Frame.open('Configuration') do
         q = 'How would you like the application to consume {{command:cli-kit}} and {{command:cli-ui}}?'
         vendor = CLI::UI::Prompt.ask(q) do |c|
@@ -72,6 +84,7 @@ module Gen
       vendor == 'vendor'
     end
 
+    sig { void }
     def create_project_dir
       info(create: '')
       FileUtils.mkdir(@project_name)
@@ -79,10 +92,12 @@ module Gen
       error("directory already exists: #{@project_name}")
     end
 
+    sig { params(translations: T::Hash[String, T.any(FalseClass, String)]).void }
     def copy_files(translations:)
       each_template_file do |source_name|
         target_name = translations.fetch(source_name, source_name)
         next if target_name == false
+
         target_name = apply_template_variables(target_name)
 
         source = File.join(TEMPLATE_ROOT, source_name)
@@ -100,6 +115,7 @@ module Gen
       end
     end
 
+    sig { void }
     def update_deps
       Dir.mktmpdir do |tmp|
         clone(tmp, 'cli-ui')
@@ -111,6 +127,7 @@ module Gen
       end
     end
 
+    sig { params(dir: String, repo: String).void }
     def clone(dir, repo)
       info(clone: repo)
       out, stat = Open3.capture2e('git', '-C', dir, 'clone', "https://github.com/shopify/#{repo}")
@@ -120,9 +137,8 @@ module Gen
       end
     end
 
-    def each_template_file
-      return enum_for(:each_template_file) unless block_given?
-
+    sig { params(block: T.proc.params(rel_path: String).void).void }
+    def each_template_file(&block)
       root = Pathname.new(TEMPLATE_ROOT)
       Dir.glob("#{TEMPLATE_ROOT}/**/*").each do |f|
         el = Pathname.new(f)
@@ -130,6 +146,7 @@ module Gen
       end
     end
 
+    sig { params(s: String).returns(String) }
     def apply_template_variables(s)
       s
         .gsub(/__app__/, @project_name)
@@ -138,16 +155,19 @@ module Gen
         .gsub(/__cli-ui-version__/, cli_ui_version)
     end
 
+    sig { returns(String) }
     def cli_kit_version
       require 'cli/kit/version'
       CLI::Kit::VERSION.to_s
     end
 
+    sig { returns(String) }
     def cli_ui_version
       require 'cli/ui/version'
       CLI::UI::VERSION.to_s
     end
 
+    sig { params(create: T.nilable(String), clone: T.nilable(String), run: T.nilable(String)).void }
     def info(create: nil, clone: nil, run: nil)
       if clone
         puts(CLI::UI.fmt("\t{{bold:{{yellow:clone}}\t#{clone}}}"))
@@ -158,6 +178,7 @@ module Gen
       end
     end
 
+    sig { params(msg: String).void }
     def error(msg)
       raise(CLI::Kit::Abort, msg)
     end

data/gen/lib/gen/help.rb

@@ -0,0 +1,63 @@
+# typed: true
+
+require 'gen'
+
+module Gen
+  module Help
+    extend T::Sig
+
+    class << self
+      extend T::Sig
+
+      sig { params(path: T::Array[String], to: IO).void }
+      def generate(path, to: STDOUT)
+        case path.size
+        when 0
+          generate_toplevel(to: to)
+        when 1
+          generate_command_help(T.must(path.first), to: to)
+        else
+          raise(NotImplementedError, 'subcommand help not implemented')
+        end
+      end
+
+      sig { params(to: IO).void }
+      def generate_toplevel(to: STDOUT)
+        to.write(CLI::UI.fmt(<<~HELP))
+          {{bold:{{command:cli-kit}} generates new cli-kit apps.}}
+
+          It basically only has one command: {{command:cli-kit new}}.
+
+          See {{command:cli-kit new --help}} for more information.
+
+          {{bold:Available commands:}}
+        HELP
+
+        cmds = Gen::Commands::Registry.resolved_commands.map do |name, klass|
+          [name, klass._desc]
+        end
+
+        max_len = cmds.map(&:first).map(&:length).max
+
+        cmds.each do |name, desc|
+          to.write(CLI::UI.fmt("  {{command:#{name.ljust(max_len)}}}  #{desc}\n"))
+        end
+      end
+
+      sig { params(cmd_name: String, to: IO).void }
+      def generate_command_help(cmd_name, to: STDOUT)
+        klass = Gen::Commands::Registry.resolved_commands[cmd_name]
+        unless klass
+          to.write(CLI::UI.fmt(<<~HELP))
+            {{red:{{bold:No help found for: #{cmd_name}}}}}
+
+          HELP
+          generate_toplevel(to: to)
+          raise(CLI::Kit::AbortSilent)
+        end
+
+        klass.new.call(['--help'], cmd_name)
+      end
+    end
+  end
+end

data/gen/lib/gen.rb

@@ -1,39 +1,34 @@
+# typed: true
+
 require 'cli/ui'
 require 'cli/kit'
 
 CLI::UI::StdoutRouter.enable
 
 module Gen
-  extend CLI::Kit::Autocall
-
   TOOL_NAME = 'cli-kit'
-  ROOT      = File.expand_path('../../..', __FILE__)
+  CLI::Kit::CommandHelp.tool_name = TOOL_NAME
+
+  ROOT = File.expand_path('../../..', __FILE__)
 
   TOOL_CONFIG_PATH = File.expand_path(File.join('~', '.config', TOOL_NAME))
   LOG_FILE = File.join(TOOL_CONFIG_PATH, 'logs', 'log.log')
   DEBUG_LOG_FILE = File.join(TOOL_CONFIG_PATH, 'logs', 'debug.log')
 
-  autoload(:Generator, 'gen/generator')
-
+  autoload(:Generator,  'gen/generator')
   autoload(:EntryPoint, 'gen/entry_point')
+  autoload(:Help,       'gen/help')
   autoload(:Commands,   'gen/commands')
 
-  autocall(:Config)  { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
-  autocall(:Command) { CLI::Kit::BaseCommand }
-  autocall(:Logger)  { CLI::Kit::Logger.new(debug_log_file: DEBUG_LOG_FILE) }
-
-  autocall(:Executor) { CLI::Kit::Executor.new(log_file: LOG_FILE) }
-  autocall(:Resolver) do
-    CLI::Kit::Resolver.new(
-      tool_name: TOOL_NAME,
-      command_registry: Gen::Commands::Registry
-    )
-  end
-
-  autocall(:ErrorHandler) do
-    CLI::Kit::ErrorHandler.new(
-      log_file: LOG_FILE,
-      exception_reporter: nil
-    )
-  end
+  Config = CLI::Kit::Config.new(tool_name: TOOL_NAME)
+  Command = CLI::Kit::BaseCommand
+  Logger = CLI::Kit::Logger.new(debug_log_file: DEBUG_LOG_FILE)
+
+  Executor = CLI::Kit::Executor.new(log_file: LOG_FILE)
+  Resolver = CLI::Kit::Resolver.new(
+    tool_name: TOOL_NAME,
+    command_registry: Gen::Commands::Registry,
+  )
+
+  ErrorHandler = CLI::Kit::ErrorHandler.new(log_file: LOG_FILE)
 end

data/gen/template/bin/update-deps

@@ -49,7 +49,7 @@ deps.each do |dep|
   dirty = false
 
   Dir.chdir(path) do
-    _, _, stat = Open3.capture3('git fetch origin master')
+    _, _, stat = Open3.capture3('git fetch origin main')
     bail("couldn't git fetch in dependency: {{yellow:#{dep}}}") unless stat.success?
 
     head_sha, stat = Open3.capture2('git rev-parse HEAD')
@@ -68,7 +68,7 @@ deps.each do |dep|
         "Copying files from {{yellow:#{path}}} to satisfy dependency {{yellow:#{dep}}}.\n" \
         "  However, the repo at {{yellow:#{path}}} isn't up to date.\n" \
         "  The checked-out revision is {{yellow:#{head_sha[0..8]}}}, and "\
-        "{{yellow:origin/master}} is {{yellow:#{fetch_head_sha[0..8]}}}.\n" \
+        "{{yellow:origin/main}} is {{yellow:#{fetch_head_sha[0..8]}}}.\n" \
         "  Unless you know what you're doing, you should {{green:cd}} to that repo and {{green:git pull}}, then run this again."
       )
     end

data/gen/template/lib/__app__/commands.rb

@@ -2,10 +2,7 @@ require '__app__'
 
 module __App__
   module Commands
-    Registry = CLI::Kit::CommandRegistry.new(
-      default: 'help',
-      contextual_resolver: nil
-    )
+    Registry = CLI::Kit::CommandRegistry.new(default: 'help')
 
     def self.register(const, cmd, path)
       autoload(const, path)

data/gen/template/lib/__app__.rb

@@ -4,8 +4,6 @@ require 'cli/kit'
 CLI::UI::StdoutRouter.enable
 
 module __App__
-  extend CLI::Kit::Autocall
-
   TOOL_NAME = '__app__'
   ROOT      = File.expand_path('../..', __FILE__)
   LOG_FILE  = '/tmp/__app__.log'
@@ -13,21 +11,14 @@ module __App__
   autoload(:EntryPoint, '__app__/entry_point')
   autoload(:Commands,   '__app__/commands')
 
-  autocall(:Config)  { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
-  autocall(:Command) { CLI::Kit::BaseCommand }
+  Config = CLI::Kit::Config.new(tool_name: TOOL_NAME)
+  Command = CLI::Kit::BaseCommand
 
-  autocall(:Executor) { CLI::Kit::Executor.new(log_file: LOG_FILE) }
-  autocall(:Resolver) do
-    CLI::Kit::Resolver.new(
-      tool_name: TOOL_NAME,
-      command_registry: __App__::Commands::Registry
-    )
-  end
+  Executor = CLI::Kit::Executor.new(log_file: LOG_FILE)
+  Resolver = CLI::Kit::Resolver.new(
+    tool_name: TOOL_NAME,
+    command_registry: __App__::Commands::Registry
+  )
 
-  autocall(:ErrorHandler) do
-    CLI::Kit::ErrorHandler.new(
-      log_file: LOG_FILE,
-      exception_reporter: nil
-    )
-  end
+  ErrorHandler = CLI::Kit::ErrorHandler.new(log_file: LOG_FILE)
 end

data/gen/template/test/example_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 module __App__
-  class ExampleTest < MiniTest::Test
+  class ExampleTest < Minitest::Test
     include CLI::Kit::Support::TestHelper
 
     def test_example