Class: RuboCop::YARD::Plugin

Inherits:
LintRoller::Plugin
  • Object
show all
Defined in:
lib/rubocop/yard/plugin.rb

Overview

A plugin that integrates RuboCop Performance with RuboCop’s plugin system.

Instance Method Summary collapse

Instance Method Details

#about ⇒ Object 



9
10
11
12
13
14
15
16
 
# File 'lib/rubocop/yard/plugin.rb', line 9

def about
  LintRoller::About.new(
    name: 'rubocop-yard',
    version: VERSION,
    homepage: 'https://github.com/ksss/rubocop-yard',
    description: 'Check yardoc format like tag type.'
  )
end

#rules(_context) ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/rubocop/yard/plugin.rb', line 22

def rules(_context)
  LintRoller::Rules.new(
    type: :path,
    config_format: :rubocop,
    value: Pathname.new(__dir__).join('../../../config/default.yml')
  )
end

#supported?(context) ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/rubocop/yard/plugin.rb', line 18

def supported?(context)
  context.engine == :rubocop
end