Module: Yard::Lint

Defined in:
lib/yard/lint.rb,
lib/yard/lint/config.rb,
lib/yard/lint/errors.rb,
lib/yard/lint/runner.rb,
lib/yard/lint/version.rb,
lib/yard/lint/parsers/base.rb,
lib/yard/lint/results/base.rb,
lib/yard/lint/command_cache.rb,
lib/yard/lint/config_loader.rb,
lib/yard/lint/result_builder.rb,
lib/yard/lint/validators/base.rb,
lib/yard/lint/results/aggregate.rb,
lib/yard/lint/validators/config.rb,
lib/yard/lint/formatters/progress.rb,
lib/yard/lint/parsers/one_line_base.rb,
lib/yard/lint/parsers/two_line_base.rb,
lib/yard/lint/validators/tags/order.rb,
lib/yard/lint/validators/tags/api_tags.rb,
lib/yard/lint/validators/tags/option_tags.rb,
lib/yard/lint/validators/tags/order/config.rb,
lib/yard/lint/validators/tags/order/parser.rb,
lib/yard/lint/validators/tags/order/result.rb,
lib/yard/lint/validators/tags/invalid_types.rb,
lib/yard/lint/validators/tags/api_tags/config.rb,
lib/yard/lint/validators/tags/api_tags/parser.rb,
lib/yard/lint/validators/tags/api_tags/result.rb,
lib/yard/lint/validators/tags/order/validator.rb,
lib/yard/lint/validators/warnings/unknown_tag.rb,
lib/yard/lint/validators/tags/api_tags/validator.rb,
lib/yard/lint/validators/tags/option_tags/config.rb,
lib/yard/lint/validators/tags/option_tags/parser.rb,
lib/yard/lint/validators/tags/option_tags/result.rb,
lib/yard/lint/validators/semantic/abstract_methods.rb,
lib/yard/lint/validators/tags/invalid_types/config.rb,
lib/yard/lint/validators/tags/invalid_types/parser.rb,
lib/yard/lint/validators/tags/invalid_types/result.rb,
lib/yard/lint/validators/tags/option_tags/validator.rb,
lib/yard/lint/validators/warnings/unknown_directive.rb,
lib/yard/lint/validators/tags/order/messages_builder.rb,
lib/yard/lint/validators/warnings/invalid_tag_format.rb,
lib/yard/lint/validators/warnings/unknown_tag/config.rb,
lib/yard/lint/validators/warnings/unknown_tag/parser.rb,
lib/yard/lint/validators/warnings/unknown_tag/result.rb,
lib/yard/lint/validators/tags/invalid_types/validator.rb,
lib/yard/lint/validators/tags/api_tags/messages_builder.rb,
lib/yard/lint/validators/warnings/unknown_tag/validator.rb,
lib/yard/lint/validators/warnings/unknown_parameter_name.rb,
lib/yard/lint/validators/semantic/abstract_methods/config.rb,
lib/yard/lint/validators/semantic/abstract_methods/parser.rb,
lib/yard/lint/validators/semantic/abstract_methods/result.rb,
lib/yard/lint/validators/tags/option_tags/messages_builder.rb,
lib/yard/lint/validators/warnings/invalid_directive_format.rb,
lib/yard/lint/validators/warnings/unknown_directive/config.rb,
lib/yard/lint/validators/warnings/unknown_directive/parser.rb,
lib/yard/lint/validators/warnings/unknown_directive/result.rb,
lib/yard/lint/validators/documentation/undocumented_objects.rb,
lib/yard/lint/validators/warnings/duplicated_parameter_name.rb,
lib/yard/lint/validators/warnings/invalid_tag_format/config.rb,
lib/yard/lint/validators/warnings/invalid_tag_format/parser.rb,
lib/yard/lint/validators/warnings/invalid_tag_format/result.rb,
lib/yard/lint/validators/semantic/abstract_methods/validator.rb,
lib/yard/lint/validators/tags/invalid_types/messages_builder.rb,
lib/yard/lint/validators/warnings/unknown_directive/validator.rb,
lib/yard/lint/validators/warnings/invalid_tag_format/validator.rb,
lib/yard/lint/validators/warnings/unknown_parameter_name/config.rb,
lib/yard/lint/validators/warnings/unknown_parameter_name/parser.rb,
lib/yard/lint/validators/warnings/unknown_parameter_name/result.rb,
lib/yard/lint/validators/warnings/invalid_directive_format/config.rb,
lib/yard/lint/validators/warnings/invalid_directive_format/parser.rb,
lib/yard/lint/validators/warnings/invalid_directive_format/result.rb,
lib/yard/lint/validators/documentation/undocumented_objects/config.rb,
lib/yard/lint/validators/documentation/undocumented_objects/parser.rb,
lib/yard/lint/validators/documentation/undocumented_objects/result.rb,
lib/yard/lint/validators/warnings/duplicated_parameter_name/config.rb,
lib/yard/lint/validators/warnings/duplicated_parameter_name/parser.rb,
lib/yard/lint/validators/warnings/duplicated_parameter_name/result.rb,
lib/yard/lint/validators/warnings/unknown_parameter_name/validator.rb,
lib/yard/lint/validators/documentation/undocumented_boolean_methods.rb,
lib/yard/lint/validators/semantic/abstract_methods/messages_builder.rb,
lib/yard/lint/validators/documentation/undocumented_method_arguments.rb,
lib/yard/lint/validators/warnings/invalid_directive_format/validator.rb,
lib/yard/lint/validators/documentation/undocumented_objects/validator.rb,
lib/yard/lint/validators/warnings/duplicated_parameter_name/validator.rb,
lib/yard/lint/validators/documentation/undocumented_boolean_methods/config.rb,
lib/yard/lint/validators/documentation/undocumented_boolean_methods/parser.rb,
lib/yard/lint/validators/documentation/undocumented_boolean_methods/result.rb,
lib/yard/lint/validators/documentation/undocumented_method_arguments/config.rb,
lib/yard/lint/validators/documentation/undocumented_method_arguments/parser.rb,
lib/yard/lint/validators/documentation/undocumented_method_arguments/result.rb,
lib/yard/lint/validators/documentation/undocumented_objects/messages_builder.rb,
lib/yard/lint/validators/documentation/undocumented_boolean_methods/validator.rb,
lib/yard/lint/validators/documentation/undocumented_method_arguments/validator.rb,
lib/yard/lint/validators/documentation/undocumented_method_arguments/messages_builder.rb

Overview

YARD Lint module providing linting functionality for YARD documentation

Defined Under Namespace

Modules: Errors, Formatters, Parsers, Results, Validators Classes: CommandCache, Config, ConfigLoader, ResultBuilder, Runner

Constant Summary collapse

VERSION =

Returns version of the YARD Lint gem.

Returns:

  • (String) —

    version of the YARD Lint gem

'0.2.0'

Class Method Summary collapse

Class Method Details

.run(path:, config: nil, config_file: nil, progress: nil) ⇒ Yard::Lint::Result

Main entry point for running YARD lint

Parameters:

  • path (String, Array<String>) —

    file or glob pattern to check

  • config (Yard::Lint::Config, nil) (defaults to: nil) —

    configuration object

  • config_file (String, nil) (defaults to: nil) —

    path to config file (auto-loads .yard-lint.yml if not specified)

  • progress (Boolean) (defaults to: nil) —

    show progress indicator (default: true for TTY)

Returns:

  • (Yard::Lint::Result) —

    result object with offenses



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/yard/lint.rb', line 22

def run(path:, config: nil, config_file: nil, progress: nil)
  config ||= load_config(config_file)
  files = expand_path(path, config)
  runner = Runner.new(files, config)

  # Enable progress by default if output is a TTY
  show_progress = progress.nil? ? $stdout.tty? : progress
  runner.progress_formatter = Formatters::Progress.new if show_progress

  runner.run
end