Module: MarkdownLint
- Defined in:
- lib/mdl.rb,
lib/mdl/cli.rb,
lib/mdl/doc.rb,
lib/mdl/style.rb,
lib/mdl/config.rb,
lib/mdl/ruleset.rb,
lib/mdl/version.rb
Defined Under Namespace
Modules: Config Classes: CLI, Doc, Rule, RuleSet, Style
Constant Summary collapse
- VERSION =
"0.9.0"
Class Method Summary collapse
Class Method Details
.run(argv = ARGV) ⇒ Object
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/mdl.rb', line 12 def self.run(argv=ARGV) cli = MarkdownLint::CLI.new cli.run(argv) ruleset = RuleSet.new unless Config[:skip_default_ruleset] ruleset.load_default end unless Config[:rulesets].nil? Config[:rulesets].each do |r| ruleset.load(r) end end rules = ruleset.rules Style.load(Config[:style], rules) # Rule option filter if Config[:rules] rules.select! {|r, v| Config[:rules][:include].include?(r) or !(Config[:rules][:include] & v.aliases).empty? } \ unless Config[:rules][:include].empty? rules.select! {|r, v| not Config[:rules][:exclude].include?(r) and (Config[:rules][:exclude] & v.aliases).empty? } \ unless Config[:rules][:exclude].empty? end # Tag option filter if Config[:tags] rules.select! {|r, v| not (v. & Config[:tags][:include]).empty? } \ unless Config[:tags][:include].empty? rules.select! {|r, v| (v. & Config[:tags][:exclude]).empty? } \ unless Config[:tags][:exclude].empty? end if Config[:list_rules] puts "Enabled rules:" rules.each do |id, rule| if Config[:verbose] puts "#{id} (#{rule.aliases.join(', ')}) [#{rule..join(', ')}] - #{rule.description}" elsif Config[:show_aliases] puts "#{rule.aliases.first || id} - #{rule.description}" else puts "#{id} - #{rule.description}" end end exit 0 end # Recurse into directories cli.cli_arguments.each_with_index do |filename, i| if Dir.exist?(filename) if Config[:git_recurse] Dir.chdir(filename) do cli.cli_arguments[i] = %x(git ls-files '*.md' '*.markdown').split("\n") end else cli.cli_arguments[i] = Dir["#{filename}/**/*.{md,markdown}"] end end end cli.cli_arguments.flatten! status = 0 results = [] cli.cli_arguments.each do |filename| puts "Checking #{filename}..." if Config[:verbose] doc = Doc.new_from_file(filename, Config[:ignore_front_matter]) filename = '(stdin)' if filename == "-" if Config[:show_kramdown_warnings] status = 2 if not doc.parsed.warnings.empty? doc.parsed.warnings.each do |w| puts "#{filename}: Kramdown Warning: #{w}" end end rules.sort.each do |id, rule| puts "Processing rule #{id}" if Config[:verbose] error_lines = rule.check.call(doc) next if error_lines.nil? or error_lines.empty? status = 1 error_lines.each do |line| line += doc.offset # Correct line numbers for any yaml front matter if Config[:json] results << { 'filename' => filename, 'line' => line, 'rule' => id, 'aliases' => rule.aliases, 'description' => rule.description, } elsif Config[:show_aliases] puts "#{filename}:#{line}: #{rule.aliases.first || id} #{rule.description}" else puts "#{filename}:#{line}: #{id} #{rule.description}" end end end end if Config[:json] require 'json' puts JSON.generate(results) elsif status != 0 puts "\nA detailed description of the rules is available at "\ "https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md" end exit status end |