Class: DocGuard::Cli

Inherits:
Thor
  • Object
show all
Defined in:
lib/doc_guard/cli.rb

Overview

Command-line interface for DocGuard.

Usage:

doc_guard assess --documentation-path=docs --digests-store-file-path=.digests.json
doc_guard record

Instance Method Summary collapse

Instance Method Details

#assess ⇒ Object

Parameters:

  • options (Hash) —

    a customizable set of options



22
23
24
25
26
27
28
29
 
# File 'lib/doc_guard/cli.rb', line 22

def assess
  ::DocGuard::AssessDocumentationRelevance::Process.run(config: build_config_from_options)
rescue SystemExit => e
  exit e.status
rescue StandardError => e
  warn "‼️ Error: #{e.message}"
  exit 2
end

#record ⇒ Object

Parameters:

  • options (Hash) —

    a customizable set of options



38
39
40
41
42
43
44
45
 
# File 'lib/doc_guard/cli.rb', line 38

def record
  ::DocGuard::RecordDocumentationRelevance::Process.run(config: build_config_from_options)
rescue SystemExit => e
  exit e.status
rescue StandardError => e
  warn "‼️ Error: #{e.message}"
  exit 2
end