"Invalid configuration file, using default options" -- should throw additional debugging information in logs

[nitinmohan87]

When there is an error in the yard plugin the debug logs shows the following debug logs which is not quite informative.

> yardoc --plugin chef '.' --debug --backtrace
[error]: Invalid configuration file, using default options
[debug]: Parsing ["."] with `ruby` parser
...

This line could at least add the exception message (backtrace would also be great!)

def self.load
      self.options = SymbolHash.new(false)
      options.update(DEFAULT_CONFIG_OPTIONS)
      options.update(read_config_file)
      load_commandline_safemode
      add_ignored_plugins_file
      translate_plugin_names
      load_plugins
    rescue => e
      log.error "Invalid configuration file, using default options"
      log.error e.message
      log.error e.backtrace.inspect
      options.update(DEFAULT_CONFIG_OPTIONS)
    end

The log would look like this

> yardoc --plugin chef '.' --debug --backtrace
[error]: Invalid configuration file, using default options
[error]: undefined method `register' for class `YARD::CodeObjects::Chef::ChefObject'

[lsegal]

I would accept this as a patch assuming you changed those new lines to log.debug, not log.error. That way they would display with --debug mode.

[nitinmohan87]

That makes sense. I will go ahead and submit the patch asap.

[lsegal]

Actually take a look at log.backtrace: http://rubydoc.org/gems/yard/YARD/Logger#backtrace-instance_method

[nitinmohan87]

If I set log level to be :debug when using log.backtrace, the error messages do not get printed in the logs. I have to use either :error or :warn to actually print the logs.

[lsegal]

Using the default loglevel on backtrace would work because we have a separate "are backtraces on?" check for that one (--backtrace)