Class: Docwright::Checker

Inherits:
Object
  • Object
show all
Defined in:
lib/docwright/checker.rb

Constant Summary collapse

REQUIRED_FILES = 
%w[
  docs/database.md
  docs/api.md
  docs/models.md
  docs/overview.md
  docs/business_rules.md
  docs/setup.md
  docs/architecture.md
  docs/deployment.md
  docs/security.md
  docs/troubleshooting.md
  docs/changelog.md
  docs/readme.md
].freeze

Instance Method Summary collapse

Instance Method Details

#run ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/docwright/checker.rb', line 20

def run
  puts "\nDocWright Check"
  puts "===============\n\n"

  missing = check_required_files
  missing += check_optional_files
  placeholders = check_placeholder_content
  empty_notes = check_note_slots

  print_report(missing, placeholders, empty_notes)

  exit(1) if missing.any? || placeholders.any? || empty_notes.any?
end