Class: RuboCop::DevDoc::Plugin

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

Overview

lint_roller entry point: tells RuboCop where this gem's cops and default configuration live.

Instance Method Summary collapse

Instance Method Details

#about ⇒ Object 



6
7
8
9
10
11
12
13
 
# File 'lib/rubocop/dev_doc/plugin.rb', line 6

def about
  LintRoller::About.new(
    name: "rubocop-dev_doc",
    version: VERSION,
    homepage: "https://github.com/hgani/dev-doc",
    description: "RuboCop cops enforcing dev-doc best practices"
  )
end

#rules(_context) ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/rubocop/dev_doc/plugin.rb', line 19

def rules(_context)
  LintRoller::Rules.new(
    type: :path,
    config_format: :rubocop,
    value: RuboCop::DevDoc::CONFIG_DEFAULT
  )
end

#supported?(context) ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/rubocop/dev_doc/plugin.rb', line 15

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