Method: YARD::Parser::SourceParser.before_parse_list

Defined in:

lib/yard/parser/source_parser.rb

.before_parse_list {|files, globals| ... } ⇒ Proc

Registers a callback to be called before a list of files is parsed via parse. The block passed to this method will be called on subsequent parse calls.

Examples:

Installing a simple callback

SourceParser.before_parse_list do |files, globals|
  puts "Starting to parse..."
end
YARD.parse('lib/**/*.rb')
# prints "Starting to parse..."

Setting global state

SourceParser.before_parse_list do |files, globals|
  globals.method_count = 0
end
SourceParser.after_parse_list do |files, globals|
  puts "Found #{globals.method_count} methods"
end
class MyCountHandler < Handlers::Ruby::Base
  handles :def, :defs
  process { globals.method_count += 1 }
end
YARD.parse
# Prints: "Found 37 methods"

Using a global callback to cancel parsing

SourceParser.before_parse_list do |files, globals|
  return false if files.include?('foo.rb')
end

YARD.parse(['foo.rb', 'bar.rb']) # callback cancels this method
YARD.parse('bar.rb') # parses normally

Yields:

• (files, globals) —

  the yielded block is called once before parsing all files

Yield Parameters:

• files (Array<String>) —

  the list of files that will be parsed.

• globals (OpenStruct) —

  a global structure to store arbitrary state for post processing (see Handlers::Processor#globals)

Yield Returns:

• (Boolean) —

  if the block returns false, parsing is cancelled.

Returns:

• (Proc) —

  the yielded block

See Also:

• after_parse_list
• before_parse_file

Since:

• 0.7.0

# File 'lib/yard/parser/source_parser.rb', line 231

def before_parse_list(&block)
  before_parse_list_callbacks << block
end