Module: RuboCop::Markdown

Defined in:
lib/rubocop/markdown.rb,
lib/rubocop/markdown/plugin.rb,
lib/rubocop/markdown/version.rb,
lib/rubocop/markdown/preprocess.rb,
lib/rubocop/markdown/rubocop_ext.rb

Overview

:nodoc:

Defined Under Namespace

Classes: Plugin, Preprocess

Constant Summary collapse

PROJECT_ROOT = 
Pathname.new(__dir__).parent.parent.expand_path.freeze
CONFIG_DEFAULT = 
PROJECT_ROOT.join("config", "default.yml").freeze
VERSION = 
"2.0.4"
MARKDOWN_EXTENSIONS =

See https://github.com/github-linguist/linguist/blob/8c380f360ce00b95fa08d14ce0ebccd481af1b33/lib/linguist/languages.yml#L4088-L4098 Keep in sync with config/default.yml

%w[
  .md
  .livemd
  .markdown
  .mdown
  .mdwn
  .mkd
  .mkdn
  .mkdown
  .ronn
  .scd
  .workbook
].freeze
MARKDOWN_OFFENSE_COPS =

A list of cops that could produce offenses in commented lines

%w[Lint/Syntax].freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config_store ⇒ Object

Returns the value of attribute config_store.



25
26
27
 
# File 'lib/rubocop/markdown/rubocop_ext.rb', line 25

def config_store
  @config_store
end

Class Method Details

.markdown_file?(file) ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/rubocop/markdown/rubocop_ext.rb', line 27

def markdown_file?(file)
  MARKDOWN_EXTENSIONS.include?(File.extname(file))
end