Module: Yard::Yaml::Cli

Defined in:
lib/yard/yaml/cli.rb

Overview

CLI helpers to parse .yardopts/argv flags for yard-yaml.

Phase 1: Only parses configuration flags and returns a Hash suitable for
Yard::Yaml::Config#apply. It does not mutate global state.

Constant Summary collapse

PREFIX = 
"--yard_yaml-"
NO_PREFIX = 
"--no-yard_yaml-"

Class Method Summary collapse

Class Method Details

.parse(argv) ⇒ Hash

Parse argv for yard-yaml flags.

Supported flags:

  • –yard_yaml-include (repeatable)
  • –yard_yaml-exclude (repeatable)
  • –yard_yaml-out_dir
  • –yard_yaml-index[=true false] –no-yard_yaml-index
  • –yard_yaml-front_matter[=true false] –no-yard_yaml-front_matter
  • –yard_yaml-strict[=true false] –no-yard_yaml-strict
  • –yard_yaml-allow_erb[=true false] –no-yard_yaml-allow_erb
  • –yard_yaml-toc
  • –yard_yaml-converter_options key:value[,key:value]

Parameters:

  • argv (Array<String>)

Returns:

  • (Hash) —

    normalized overrides



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/yard/yaml/cli.rb', line 29

def parse(argv)
  return {} if argv.nil? || argv.empty?

  overrides = {}
  i = 0
  while i < argv.length
    token = argv[i]

    if token.start_with?(NO_PREFIX)
      key = token.delete_prefix(NO_PREFIX).to_sym
      apply_bool(overrides, key, false)
      i += 1
      next
    end

    unless token.start_with?(PREFIX)
      i += 1
      next
    end

    # handle --flag=value form
    if token.include?("=")
      flag, raw = token.split("=", 2)
      key = flag.delete_prefix(PREFIX).to_sym
      apply_kv(overrides, key, raw)
      i += 1
      next
    end

    key = token.delete_prefix(PREFIX).to_sym

    case key
    when :include, :exclude
      value = argv[i + 1]
      if value.nil? || value.start_with?("--")
        warn_unknown("missing value for #{token}")
        i += 1
      else
        arr = (overrides[key] ||= [])
        arr << value.to_s
        i += 2
      end
    when :out_dir, :toc
      value = argv[i + 1]
      if value.nil? || value.start_with?("--")
        warn_unknown("missing value for #{token}")
        i += 1
      else
        overrides[key] = value.to_s
        i += 2
      end
    when :index, :front_matter, :strict, :allow_erb
      # Bare presence means true
      apply_bool(overrides, key, true)
      i += 1
    when :converter_options
      value = argv[i + 1]
      if value.nil? || value.start_with?("--")
        warn_unknown("missing value for #{token}")
        i += 1
      else
        overrides[:converter_options] = parse_converter_options(value)
        i += 2
      end
    else
      warn_unknown("unknown flag #{token}")
      i += 1
    end
  end

  overrides
end