Module: DocOpsLab::Dev::Skim

Defined in:
lib/docopslab/dev/skim.rb

Overview

Source skimming via Sourcerer::SourceSkim

Constant Summary collapse

ADOC_EXTS = 
%w[.adoc .asc .ad .asciidoc].freeze
MD_EXTS = 
%w[.md .markdown].freeze
ALL_EXTS = 
(ADOC_EXTS + MD_EXTS).freeze

Class Method Summary collapse

Class Method Details

.run(path, form: nil, syntax: nil) ⇒ Object

Skim all supported file types (AsciiDoc + Markdown), format auto-detected.



17
18
19
 
# File 'lib/docopslab/dev/skim.rb', line 17

def run path, form: nil, syntax: nil
  run_with_format(path, exts: ALL_EXTS, form: form, syntax: syntax)
end

.run_adoc(path, form: nil, syntax: nil) ⇒ Object

Skim AsciiDoc source files only.



22
23
24
 
# File 'lib/docopslab/dev/skim.rb', line 22

def run_adoc path, form: nil, syntax: nil
  run_with_format(path, exts: ADOC_EXTS, form: form, syntax: syntax, default_forms: [:tree])
end

.run_md(path, form: nil, syntax: nil) ⇒ Object

Skim Markdown source files only, with optional upstream:local overlay support.



27
28
29
 
# File 'lib/docopslab/dev/skim.rb', line 27

def run_md path, form: nil, syntax: nil
  run_with_format(path, exts: MD_EXTS, form: form, syntax: syntax, overlay: true)
end