class YARD::Config
This class maintains all system-wide configuration for YARD
and handles the loading of plugins. To access options call {options}, and to load a plugin use {load_plugin}. All other public methods are used by YARD
during load time.
User Configuration Files¶ ↑
Persistent user configuration files can be stored in the file +~/.yard/config+, which is read when YARD
first loads. The file should be formatted as YAML, and should contain a map of keys and values.
Although you can specify any key-value mapping in the configuration file, YARD
defines special keys specified in {DEFAULT_CONFIG_OPTIONS}.
An example of a configuration file is listed below:
!!!yaml load_plugins: true # Auto-load plugins when YARD starts ignored_plugins: - yard-broken - broken2 # yard- prefix not necessary autoload_plugins: - yard-rspec
Automatic Loading of Plugins¶ ↑
YARD
0.6.2 will no longer automatically load all plugins by default. This option can be reset by setting 'load_plugins' to true in the configuration file. In addition, you can specify a set of specific plugins to load on load through the 'autoload_plugins' list setting. This setting is independent of the 'load_plugins' value and will always be processed.
Ignored Plugins File
¶ ↑
YARD
0.5 and below used a +~/.yard/ignored_plugins+ file to specify plugins to be ignored at load time. Ignored plugins in 0.6.2 and above should now be specified in the main configuration file, though YARD
will support the ignored_plugins
file until 0.7.x.
Safe Mode¶ ↑
YARD
supports running in safe-mode. By doing this, it will avoid executing any user code such as require files or queries. Plugins will still be loaded with safe mode on, because plugins are properly namespaced with a 'yard-' prefix, must be installed as a gem, and therefore cannot be touched by the user. To specify safe mode, use the safe_mode
key.
Plugin Specific Configuration¶ ↑
Additional settings can be defined within the configuration file specifically to provide configuration for a plugin. A plugin that utilizes the YARD
configuration is strongly encouraged to utilize namespacing of their configuration content.
!!!yaml load_plugins: true # Auto-load plugins when YARD starts ignored_plugins: - yard-broken - broken2 # yard- prefix not necessary autoload_plugins: - yard-rspec # Plugin Specific Configuration yard-sample-plugin: show-results-inline: true
As the configuration is available system wide, it can be accessed within the plugin code.
if YARD::Config.options['yard-sample-plugin'] and YARD::Config.options['yard-sample-plugin']['show-results-inline'] # ... perform the action that places the results inline ... else # ... do the default behavior of not showing the results inline ... end
When accessing the configuration, be aware that this file is user managed so configuration keys and values may not be present. Make no assumptions and instead ensure that you check for the existence of keys before proceeding to retrieve values.
@since 0.6.2 @see options
Constants
- CONFIG_DIR
The location where
YARD
stores user-specific settings- CONFIG_FILE
The main configuration YAML file.
- DEFAULT_CONFIG_OPTIONS
Default configuration options
- IGNORED_PLUGINS
File
listing all ignored plugins @deprecated Set `ignored_plugins` in the {CONFIG_FILE} instead.- YARD_PLUGIN_PREFIX
The prefix used for
YARD
plugins. Name your gem with this prefix to allow it to be used as a plugin.
Attributes
The system-wide configuration options for YARD
@return [SymbolHash] a map a key-value pair settings. @see DEFAULT_CONFIG_OPTIONS
Public Class Methods
Legacy support for {IGNORED_PLUGINS}
# File lib/yard/config.rb, line 221 def self.add_ignored_plugins_file if File.file?(IGNORED_PLUGINS) options[:ignored_plugins] += File.read(IGNORED_PLUGINS).split(/\s+/) end end
@return [Array<String>] arguments from commandline and yardopts file
# File lib/yard/config.rb, line 264 def self.arguments ARGV + @yardopts end
Loads settings from {CONFIG_FILE}. This method is called by YARD
at load time and should not be called by the user. @return [void]
# File lib/yard/config.rb, line 119 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.backtrace(e) options.update(DEFAULT_CONFIG_OPTIONS) end
Load plugins set in :autoload_plugins
# File lib/yard/config.rb, line 189 def self.load_autoload_plugins options[:autoload_plugins].each {|name| load_plugin(name) } end
Load plugins from {arguments}
# File lib/yard/config.rb, line 194 def self.load_commandline_plugins with_yardopts do arguments.each_with_index do |arg, i| next unless arg == '--plugin' load_plugin(arguments[i + 1]) end end end
Check for command-line safe_mode switch in {arguments}
# File lib/yard/config.rb, line 204 def self.load_commandline_safemode with_yardopts do arguments.each_with_index do |arg, _i| options[:safe_mode] = true if arg == '--safe' end end end
Load gem plugins if :load_plugins is true
# File lib/yard/config.rb, line 169 def self.load_gem_plugins return true unless options[:load_plugins] require 'rubygems' result = true YARD::GemIndex.each do |gem| begin next true unless gem.name =~ YARD_PLUGIN_PREFIX load_plugin(gem.name) rescue Gem::LoadError => e tmp = load_plugin_failed(gem.name, e) result = tmp unless tmp end end result rescue LoadError log.debug "RubyGems is not present, skipping plugin loading" false end
Loads an individual plugin by name. It is not necessary to include the yard-
plugin prefix here.
@param [String] name the name of the plugin (with or without yard-
prefix) @return [Boolean] whether the plugin was successfully loaded
# File lib/yard/config.rb, line 157 def self.load_plugin(name) name = translate_plugin_name(name) return false if options[:ignored_plugins].include?(name) return false if name =~ /^yard-doc-/ log.debug "Loading plugin '#{name}'..." require name true rescue LoadError => e load_plugin_failed(name, e) end
Print a warning if the plugin failed to load @return [false]
# File lib/yard/config.rb, line 214 def self.load_plugin_failed(name, exception) log.error "Error loading plugin '#{name}'" log.backtrace(exception) if $DEBUG false end
Loads gems that match the name 'yard-*' (recommended) or 'yard_*' except those listed in +~/.yard/ignored_plugins+. This is called immediately after YARD
is loaded to allow plugin support.
@return [Boolean] true if all plugins loaded successfully, false otherwise.
# File lib/yard/config.rb, line 146 def self.load_plugins load_gem_plugins && load_autoload_plugins && load_commandline_plugins ? true : false end
Loads the YAML configuration file into memory @return [Hash] the contents of the YAML file from disk @see CONFIG_FILE
# File lib/yard/config.rb, line 236 def self.read_config_file if File.file?(CONFIG_FILE) require 'yaml' YAML.load_file(CONFIG_FILE) else {} end end
Saves settings to {CONFIG_FILE}. @return [void]
# File lib/yard/config.rb, line 135 def self.save require 'yaml' Dir.mkdir(CONFIG_DIR) unless File.directory?(CONFIG_DIR) File.open(CONFIG_FILE, 'w') {|f| f.write(YAML.dump(options)) } end
Sanitizes and normalizes a plugin name to include the 'yard-' prefix. @param [String] name the plugin name @return [String] the sanitized and normalized plugin name.
# File lib/yard/config.rb, line 248 def self.translate_plugin_name(name) name = name.delete('/') # Security sanitization name = "yard-" + name unless name =~ YARD_PLUGIN_PREFIX name end
Translates plugin names to add yard- prefix.
# File lib/yard/config.rb, line 228 def self.translate_plugin_names options[:ignored_plugins].map! {|name| translate_plugin_name(name) } options[:autoload_plugins].map! {|name| translate_plugin_name(name) } end
Temporarily loads .yardopts file into @yardopts
# File lib/yard/config.rb, line 255 def self.with_yardopts yfile = CLI::Yardoc::DEFAULT_YARDOPTS_FILE @yardopts = File.file?(yfile) ? File.read_binary(yfile).shell_split : [] result = yield @yardopts = nil result end