Class: YARD::CLI::YardoptsCommand Abstract

Inherits:
Command
  • Object
show all
Defined in:
lib/yard/cli/yardopts_command.rb

Overview

This class is abstract.

Abstract base class for command that reads .yardopts file

Since:

  • 0.8.3

Direct Known Subclasses

Graph, Yardoc

Constant Summary

DEFAULT_YARDOPTS_FILE =

The configuration filename to load extra options from

Since:

  • 0.8.3

".yardopts"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeYardoptsCommand

Creates a new command that reads .yardopts

Since:

  • 0.8.3



25
26
27
28
29
30
# File 'lib/yard/cli/yardopts_command.rb', line 25

def initialize
  super
  @options_file = DEFAULT_YARDOPTS_FILE
  @use_yardopts_file = true
  @use_document_file = true
end

Instance Attribute Details

#options_fileString

The options file name (defaults to DEFAULT_YARDOPTS_FILE)

Returns:

  • (String)

    the filename to load extra options from

Since:

  • 0.8.3



22
23
24
# File 'lib/yard/cli/yardopts_command.rb', line 22

def options_file
  @options_file
end

#use_document_fileBoolean

Returns whether to parse options from .document

Returns:

  • (Boolean)

    whether to parse options from .document

Since:

  • 0.8.3



18
19
20
# File 'lib/yard/cli/yardopts_command.rb', line 18

def use_document_file
  @use_document_file
end

#use_yardopts_fileBoolean

Returns whether to parse options from .yardopts

Returns:

  • (Boolean)

    whether to parse options from .yardopts

Since:

  • 0.8.3



15
16
17
# File 'lib/yard/cli/yardopts_command.rb', line 15

def use_yardopts_file
  @use_yardopts_file
end

Instance Method Details

#parse_arguments(*args) ⇒ Boolean

Parses commandline arguments

Parameters:

Returns:

  • (Boolean)

    whether or not arguments are valid

Since:

  • 0.5.6



36
37
38
39
40
41
42
43
# File 'lib/yard/cli/yardopts_command.rb', line 36

def parse_arguments(*args)
  parse_yardopts_options(*args)

  # Parse files and then command line arguments
  parse_rdoc_document_file
  parse_yardopts
  optparse(*args)
end

#yardopts_options(opts) ⇒ Object (protected)

Adds –[no-]yardopts / –[no-]document

Since:

  • 0.8.3



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/yard/cli/yardopts_command.rb', line 48

def yardopts_options(opts)
  opts.on('--[no-]yardopts [FILE]',
          "If arguments should be read from FILE",
          "  (defaults to yes, FILE defaults to .yardopts)") do |use_yardopts|
    if use_yardopts.is_a?(String)
      self.options_file = use_yardopts
      self.use_yardopts_file = true
    else
      self.use_yardopts_file = (use_yardopts != false)
    end
  end

  opts.on('--[no-]document', "If arguments should be read from .document file. ",
                             "  (defaults to yes)") do |use_document|
    self.use_document_file = use_document
  end
end