Method: YARD::CLI::Yardoc#run

Defined in:

lib/yard/cli/yardoc.rb

#run(*args) ⇒ void

This method returns an undefined value.

Runs the commandline utility, parsing arguments and generating output if set.

Parameters:

• args (Array<String>) —

  the list of arguments. If the list only contains a single nil value, skip calling of #parse_arguments

Since:

• 0.2.1

# File 'lib/yard/cli/yardoc.rb', line 244

def run(*args)
  log.show_progress = true
  if args.empty? || !args.first.nil?
    # fail early if arguments are not valid
    return unless parse_arguments(*args)
  end

  checksums = nil
  if use_cache
    Registry.load
    checksums = Registry.checksums.dup
  end

  if save_yardoc
    Registry.lock_for_writing do
      YARD.parse(files, excluded)
      Registry.save(use_cache)
    end
  else
    YARD.parse(files, excluded)
  end

  if generate
    run_generate(checksums)
    copy_assets
  elsif list
    print_list
  end

  if !list && statistics && log.level < Logger::ERROR
    Registry.load_all
    log.enter_level(Logger::ERROR) do
      Stats.new(false).run(*args)
    end
  end

  abort if fail_on_warning && log.warned

  true
ensure
  log.show_progress = false
end