vagrant/plugins/commands/plugin/command/root.rb

# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: BUSL-1.1

require 'optparse'

module VagrantPlugins
  module CommandPlugin
    module Command
      class Root < Vagrant.plugin("2", :command)
        def self.synopsis
          "manages plugins: install, uninstall, update, etc."
        end

        def initialize(argv, env)
          super

          @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)

          @subcommands = Vagrant::Registry.new
          @subcommands.register(:expunge) do
            require_relative "expunge"
            Expunge
          end

          @subcommands.register(:install) do
            require_relative "install"
            Install
          end

          @subcommands.register(:license) do
            require_relative "license"
            License
          end

          @subcommands.register(:list) do
            require_relative "list"
            List
          end

          @subcommands.register(:repair) do
            require_relative "repair"
            Repair
          end

          @subcommands.register(:update) do
            require_relative "update"
            Update
          end

          @subcommands.register(:uninstall) do
            require_relative "uninstall"
            Uninstall
          end
        end

        def execute
          if @main_args.include?("-h") || @main_args.include?("--help")
            # Print the help for all the sub-commands.
            return help
          end

          # If we reached this far then we must have a subcommand. If not,
          # then we also just print the help and exit.
          command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
          return help if !command_class || !@sub_command
          @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")

          # Initialize and execute the command class
          command_class.new(@sub_args, @env).execute
        end

        # Prints the help out for this command
        def help
          opts = OptionParser.new do |o|
            o.banner = "Usage: vagrant plugin <command> [<args>]"
            if !Vagrant.server_mode?
              o.separator ""
              o.separator "Available subcommands:"
  
              # Add the available subcommands as separators in order to print them
              # out as well.
              keys = []
              @subcommands.each { |key, value| keys << key.to_s }
  
              keys.sort.each do |key|
                o.separator "     #{key}"
              end
            end
            o.separator ""
            o.separator "For help on any individual command run `vagrant plugin COMMAND -h`"
          end

          @env.ui.info(opts.help, prefix: false)
        end
      end
    end
  end
end