class YARD::CLI::MarkupTypes

Lists all markup types @since 0.8.6

Public Instance Methods

description() click to toggle source
# File lib/yard/cli/markup_types.rb, line 7
def description; 'Lists all available markup types and libraries' end
run(*args) click to toggle source

Runs the commandline utility, parsing arguments and displaying a list of markup types

@param [Array<String>] args the list of arguments. @return [void]

# File lib/yard/cli/markup_types.rb, line 14
def run(*args) # rubocop:disable Lint/UnusedMethodArgument
  log.puts "Available markup types for `doc' command:"
  log.puts
  types = Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS
  exts = Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS
  types.sort_by {|name, _| name.to_s }.each do |name, providers|
    log.puts "[#{name}]"
    libs = providers.map {|p| p[:lib] }.compact
    log.puts "  Providers: #{libs.join(" ")}" unless libs.empty?
    if exts[name]
      log.puts "  Extensions: #{exts[name].map {|e| ".#{e}" }.join(" ")}"
    end

    log.puts
  end
end