Module: Docscribe::CLI::Coverage

Defined in:
lib/docscribe/cli/coverage.rb

Overview

Generate documentation coverage report for Ruby files.

Defined Under Namespace

Classes: CoverageStats

Constant Summary collapse 

<<~TEXT
  Usage: docscribe coverage [options] [paths]

  Generate documentation coverage report.

  Options:
TEXT

Class Method Summary collapse

Class Method Details

.run(argv) ⇒ Integer

Parameters:

  • argv (Array<String>)

Returns:

  • (Integer) 


71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/docscribe/cli/coverage.rb', line 71

def run(argv)
  opts = parse_options(argv)
  return 0 if opts[:help]

  conf = Docscribe::Config.load(opts[:config])
  paths = expand_paths(argv, conf)

  stats = analyze_coverage(paths, conf)

  print_report(stats, opts)
  0
end