Module: Mdlint::Linter

Defined in:
lib/mdlint/linter.rb,
lib/mdlint/linter/rule.rb,
lib/mdlint/linter/violation.rb,
lib/mdlint/linter/rule_engine.rb,
lib/mdlint/linter/rules/japanese.rb,
lib/mdlint/linter/directive_filter.rb,
lib/mdlint/linter/rules/link_check.rb,
lib/mdlint/linter/rules/line_length.rb,
lib/mdlint/linter/rules/source_style.rb,
lib/mdlint/linter/rules/heading_style.rb,
lib/mdlint/linter/rules/code_block_syntax.rb,
lib/mdlint/linter/rules/heading_increment.rb,
lib/mdlint/linter/rules/first_line_heading.rb,
lib/mdlint/linter/rules/no_multiple_blanks.rb,
lib/mdlint/linter/rules/no_trailing_spaces.rb,
sig/mdlint.rbs,
sig/internal.rbs

Defined Under Namespace

Modules: Rules Classes: DirectiveFilter, Rule, RuleEngine, RuleRegistry, Violation

Class Method Summary collapse

Class Method Details

.check(src, options = {}) ⇒ Array[Violation]

Parameters:

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

Returns:



21
22
23
24
25
 
# File 'lib/mdlint/linter.rb', line 21

def check(src, options = {})
  tokens = Parser.parse(src, options)
  engine = RuleEngine.new(options)
  DirectiveFilter.apply(engine.check(tokens, src), src)
end

.fix(src, options = {}) ⇒ String

Parameters:

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

Returns:

  • (String) 


27
28
29
30
31
 
# File 'lib/mdlint/linter.rb', line 27

def fix(src, options = {})
  tokens = Parser.parse(src, options)
  engine = RuleEngine.new(options)
  engine.fix(tokens, src)
end