Class: YardJunk::Logger
- Inherits:
-
Object
show all
- Includes:
- Singleton
- Defined in:
- lib/yard-junk/logger.rb,
lib/yard-junk/logger/message.rb
Defined Under Namespace
Modules: Mixin
Classes: CircularReference, DuplicateParam, InvalidDirectiveFormat, InvalidLink, InvalidTagFormat, MacroAttachError, MacroNameError, Message, MissingParamName, RedundantBraces, SyntaxError, Undocumentable, UnknownDirective, UnknownNamespace, UnknownParam, UnknownTag
Constant Summary
collapse
- DEFAULT_IGNORE =
%w[Undocumentable].freeze
Instance Method Summary
collapse
Instance Method Details
42
43
44
|
# File 'lib/yard-junk/logger.rb', line 42
def format=(fmt)
@format = fmt.to_s
end
|
#ignore=(list) ⇒ Object
46
47
48
49
|
# File 'lib/yard-junk/logger.rb', line 46
def ignore=(list)
@ignore = Array(list).map(&:to_s)
.each { |type| Message.valid_type?(type) or fail(ArgumentError, "Unrecognized message type to ignore: #{type}") }
end
|
#messages ⇒ Object
14
15
16
|
# File 'lib/yard-junk/logger.rb', line 14
def messages
@messages ||= []
end
|
#notify(msg) ⇒ Object
26
27
28
29
30
31
32
33
34
|
# File 'lib/yard-junk/logger.rb', line 26
def notify(msg)
case msg
when /Parsing (\w\S+)$/
@current_parsed_file = Regexp.last_match(1)
when /^Generating/ @current_parsed_file = nil
end
end
|
#register(msg, severity = :warn) ⇒ Object
18
19
20
21
22
23
24
|
# File 'lib/yard-junk/logger.rb', line 18
def register(msg, severity = :warn)
message = Message.registry
.map { |t| t.try_parse(msg, severity: severity, file: @current_parsed_file) }
.compact.first || Message.new(message: msg, file: @current_parsed_file)
messages << message
puts message.to_s(@format) if output?(message)
end
|