Class: Mdlint::Linter::Rule

Inherits:

Object

• Object
• Mdlint::Linter::Rule

Defined in:

lib/mdlint/linter/rule.rb,
sig/mdlint.rbs,
sig/internal.rbs

Direct Known Subclasses

Mdlint::Linter::Rules::CodeBlockSyntax, Mdlint::Linter::Rules::EmphasisStyle, Mdlint::Linter::Rules::FencedCodeBlankLines, Mdlint::Linter::Rules::FencedCodeStyle, Mdlint::Linter::Rules::FirstLineHeading, Mdlint::Linter::Rules::HeadingIncrement, Mdlint::Linter::Rules::HeadingStyle, Mdlint::Linter::Rules::JapaneseCommaCount, Mdlint::Linter::Rules::JapaneseDuplicateParticle, Mdlint::Linter::Rules::JapanesePunctuation, Mdlint::Linter::Rules::JapaneseSentenceLength, Mdlint::Linter::Rules::JapaneseSpacing, Mdlint::Linter::Rules::JapaneseStyle, Mdlint::Linter::Rules::JapaneseWidth, Mdlint::Linter::Rules::LineLength, Mdlint::Linter::Rules::LinkCheck, Mdlint::Linter::Rules::ListBlankLines, Mdlint::Linter::Rules::ListMarkerSpace, Mdlint::Linter::Rules::NoBareUrls, Mdlint::Linter::Rules::NoHardTabs, Mdlint::Linter::Rules::NoMultipleBlanks, Mdlint::Linter::Rules::NoMultipleSpacesAfterBlockquote, Mdlint::Linter::Rules::NoMultipleSpacesAfterHash, Mdlint::Linter::Rules::NoSpaceAfterHash, Mdlint::Linter::Rules::NoSpaceInCode, Mdlint::Linter::Rules::NoSpaceInEmphasis, Mdlint::Linter::Rules::NoTrailingSpaces, Mdlint::Linter::Rules::SingleTrailingNewline, Mdlint::Linter::Rules::StrongStyle

Class Attribute Summary

• .aliases ⇒ Object

  Returns the value of attribute aliases.

• .description ⇒ Object

  Returns the value of attribute description.

• .preset ⇒ Object

  Returns the value of attribute preset.

• .rule_id ⇒ Object

  Returns the value of attribute rule_id.

Instance Attribute Summary

• #violations ⇒ Object readonly

  Returns the value of attribute violations.

Class Method Summary

• .inherited(subclass) ⇒ Object

Instance Method Summary

• #add_violation(message:, line:, column: nil, fixable: false) ⇒ Object
• #check(_tokens, _source) ⇒ Array[Violation]
• #fix(_tokens, _source) ⇒ String
• #initialize(options = {}) ⇒ Rule constructor

  A new instance of Rule.

Constructor Details

#initialize(options = {}) ⇒ Rule

Returns a new instance of Rule.

Parameters:

• options (options) (defaults to: {})

# File 'lib/mdlint/linter/rule.rb', line 17

def initialize(options = {})
  @options = options
  @violations = []
end

Class Attribute Details

.aliases ⇒ Object

Returns the value of attribute aliases.

Returns:

• (Object)

# File 'lib/mdlint/linter/rule.rb', line 7

def aliases
  @aliases
end

.description ⇒ Object

Returns the value of attribute description.

Returns:

• (Object)

# File 'lib/mdlint/linter/rule.rb', line 7

def description
  @description
end

.preset ⇒ Object

Returns the value of attribute preset.

Returns:

• (Object)

# File 'lib/mdlint/linter/rule.rb', line 7

def preset
  @preset
end

.rule_id ⇒ Object

Returns the value of attribute rule_id.

Returns:

• (Object)

# File 'lib/mdlint/linter/rule.rb', line 7

def rule_id
  @rule_id
end

Instance Attribute Details

#violations ⇒ Object (readonly)

Returns the value of attribute violations.

Returns:

• (Object)

# File 'lib/mdlint/linter/rule.rb', line 15

def violations
  @violations
end

Class Method Details

.inherited(subclass) ⇒ Object

Parameters:

• subclass (Object)

Returns:

• (Object)

# File 'lib/mdlint/linter/rule.rb', line 9

def inherited(subclass)
  super
  RuleRegistry.register(subclass)
end

Instance Method Details

#add_violation(message:, line:, column: nil, fixable: false) ⇒ Object

Parameters:

• message: (String)
• line: (Integer)
• column: (Integer, nil) (defaults to: nil)
• fixable: (Boolean) (defaults to: false)

Returns:

• (Object)

# File 'lib/mdlint/linter/rule.rb', line 32

def add_violation(message:, line:, column: nil, fixable: false)
  @violations << Violation.new(
    rule_id: self.class.rule_id,
    message: message,
    line: line,
    column: column,
    fixable: fixable,
    severity: @options[:severity] || :warning
  )
end

#check(_tokens, _source) ⇒ Array[Violation]

Parameters:

• tokens (Array[Token])
• source (String)

Returns:

• (Array[Violation])

Raises:

• (NotImplementedError)

# File 'lib/mdlint/linter/rule.rb', line 22

def check(_tokens, _source)
  raise NotImplementedError, "Subclasses must implement #check"
end

#fix(_tokens, _source) ⇒ String

Parameters:

• tokens (Array[Token])
• source (String)

Returns:

• (String)

# File 'lib/mdlint/linter/rule.rb', line 26

def fix(_tokens, _source)
  _source
end