Class: RuboCop::RbsInline::Plugin

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

Overview

A plugin that integrates RuboCop RBS Inline with RuboCop’s plugin system.

Instance Method Summary collapse

Instance Method Details

#about ⇒ Object

: LintRoller::About



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

def about #: LintRoller::About
  LintRoller::About.new(
    name: 'rubocop-rbs_inline',
    version: RuboCop::RbsInline::VERSION,
    homepage: 'https://github.com/tk0miya/rubocop-rbs_inline',
    description: 'rubocop-rbs_inline is a RuboCop extension that checks for RBS::Inline annotation comments ' \
                 'in Ruby code.'
  )
end

#rules(_context) ⇒ Object 



25
26
27
28
29
 
# File 'lib/rubocop/rbs_inline/plugin.rb', line 25

def rules(_context) #: LintRoller::Rules
  project_root = Pathname.new(__dir__).join('../../../') # steep:ignore

  LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join('config', 'default.yml'))
end

#supported?(context) ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/rubocop/rbs_inline/plugin.rb', line 20

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