mdl 0.0.1

data/test/rule_tests/incorrect_header_setext.md

@@ -0,0 +1,6 @@
+# Header 1 {MD003} #
+
+## Header 2 {MD003}
+
+Header 3
+--------

data/test/rule_tests/incorrect_header_setext_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD003', :style => :setext

data/test/rule_tests/long_lines.md

@@ -0,0 +1,3 @@
+This is a very very very very very very very very very very very very very very long line {MD013}
+
+This line however, while very long, doesn't have whitespace after the 80th columnwhichallowsforURLsandotherlongthings.

data/test/rule_tests/long_lines_100.md

@@ -0,0 +1,7 @@
+This is a very very very very very very very very long line over 80 chars but less than 100
+
+This is a very very very very very very very very very very long line over 80 chars, and also over 100. {MD013}
+
+This is a very very very very very very very very very long line that is exactly 100 characters long
+
+This line however, while very long, doesn't have whitespace after the 100th columnwhichallowsforURLsandotherlongthings.

data/test/rule_tests/long_lines_100_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD013', :line_length => 100

data/test/rule_tests/mixed_header_types_atx.md

@@ -0,0 +1,6 @@
+# Header
+
+## Header 2 {MD003} ##
+
+Header 3 {MD003}
+----------------

data/test/rule_tests/mixed_header_types_atx_closed.md

@@ -0,0 +1,6 @@
+# Header 1 #
+
+## Header 2 {MD003}
+
+Header 3 {MD003}
+----------------

data/test/rule_tests/mixed_header_types_setext.md

@@ -0,0 +1,6 @@
+Header 1
+========
+
+## Header 2 {MD003}
+
+## Header 3 {MD003} ##

data/test/rule_tests/ordered_list_item_prefix.md

@@ -0,0 +1,13 @@
+Good list:
+
+1. Do this.
+1. Do that.
+1. ???
+1. Profit!
+
+Bad list:
+
+1. Do this.
+2. Do nothing. {MD029}
+3. ??? {MD029}
+4. Failed! {MD029}

data/test/rule_tests/ordered_list_item_prefix_ordered.md

@@ -0,0 +1,13 @@
+Good list:
+
+1. Do this.
+2. Do that.
+3. ???
+4. Profit!
+
+Bad list:
+
+1. Do this.
+1. Do nothing. {MD029}
+1. ??? {MD029}
+1. Failed! {MD029}

data/test/rule_tests/ordered_list_item_prefix_ordered_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD029', :style => :ordered

data/test/rule_tests/reversed_link.md

@@ -0,0 +1,7 @@
+Go to (this website)[http://www.example.com] {MD011}
+
+However, this shouldn't trigger inside code blocks:
+
+    myObj.getFiles("test")[0]
+
+Nor inline code: `myobj.getFiles("test")[0]`

data/test/rule_tests/spaces_after_list_marker.md

@@ -0,0 +1,74 @@
+Normal list
+
+* Foo
+* Bar
+* Baz
+
+List with incorrect spacing
+
+*  Foo {MD030}
+*  Bar {MD030}
+*   Baz {MD030}
+
+List with children:
+
+* Foo {MD030}
+    * Bar {MD030}
+        * Baz
+
+List with children and correct spacing:
+
+*   Foo
+    *   Bar
+        * Baz (This sublist has no children)
+
+List with Multiple paragraphs and correct spacing
+
+*   Foo
+
+    Here is the second paragraph
+
+*   All items in the list need the same indent
+
+List with multiple paragraphs and incorrect spacing
+
+*  Foo {MD030}
+
+   Here is the second paragraph
+
+*    Bar {MD030}
+
+List with code blocks:
+
+*   Foo
+
+        Here is some code
+
+*   Bar
+
+Ordered lists:
+
+1. Foo
+1. Bar
+1. Baz
+
+And with incorrect spacing:
+
+1.  Foo {MD030}
+1.  Bar {MD030}
+1.  Baz {MD030}
+
+Ordered lists with children:
+
+1. Foo {MD030}
+    * Hi
+1. Bar {MD030}
+1. Baz {MD030}
+
+Ordered lists with children (correct spacing), and with something other than
+the first item determining that the entire list has children:
+
+1.  Foo
+1.  Bar
+    * Hi
+1.  Baz

data/test/rule_tests/spaces_after_list_marker_style.rb

@@ -0,0 +1,3 @@
+all
+rule "MD007", :indent => 4
+rule "MD030", :ul_multi => 3, :ol_multi => 2

data/test/rule_tests/whitespace issues.md

@@ -0,0 +1,3 @@
+Some text {MD009} 
+Some	more text {MD010}
+Some more text

data/test/setup_tests.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+Bundler.setup
+
+require_relative '../lib/mdl'
+require 'minitest/autorun'

data/test/test_ruledocs.rb

@@ -0,0 +1,45 @@
+require_relative 'setup_tests'
+
+# Ensures there is documentation for every rule, and that the
+# descriptions/tags/etc in the rule match those in the documentation
+class TestRuledocs < Minitest::Test
+  @@rules = MarkdownLint::RuleSet.load_default
+
+  def setup
+    @ruledocs = load_ruledocs
+  end
+
+  def load_ruledocs
+    rules = Hash.new({}) # Default to {} if no docs for the rule
+    curr_rule = nil
+    rules_file = File.expand_path('../../docs/RULES.md', __FILE__)
+    File.read(rules_file).split("\n").each do |l|
+      if l.match(/^## (MD\d+) - (.*)$/)
+        rules[$1] = { :description => $2, :params => {} }
+        curr_rule = $1
+      elsif l.match(/^Tags: (.*)$/)
+        rules[curr_rule][:tags] = $1.split(',').map{|i| i.strip.to_sym}
+      elsif l.match(/^Parameters: (.*)$/)
+        rules[curr_rule][:params] = $1.split(',').map{|i| i.strip.to_sym}
+      end
+    end
+    rules
+  end
+
+  @@rules.each do |id, r|
+    define_method("test_ruledoc_description_#{id}") do
+      assert_equal r.description, @ruledocs[id][:description]
+    end
+    define_method("test_ruledoc_tags_#{id}") do
+      assert_equal r.tags, @ruledocs[id][:tags]
+    end
+    define_method("test_ruledoc_params_#{id}") do
+      assert_equal r.params.keys.sort, (@ruledocs[id][:params] || []).sort
+    end
+  end
+
+  def test_ruledoc_for_every_rule
+    # (and vice versa)
+    assert_equal @@rules.keys, @ruledocs.keys
+  end
+end

data/test/test_rules.rb

@@ -0,0 +1,56 @@
+require_relative 'setup_tests'
+
+class TestRules < Minitest::Test
+
+  def get_expected_errors(lines)
+    # Looks for lines tagged with {MD123} to signify that a rule is expected to
+    # fire for this line. It also looks for lines tagged with {MD123:1} to
+    # signify that a rule is expected to fire on another line (the line number
+    # after the colon).
+    expected_errors = {}
+    re = /\{(MD\d+)(?::(\d+))?\}/
+    lines.each_with_index do |line, num|
+      m = re.match(line)
+      while m
+        expected_errors[m[1]] ||= []
+        if m[2]
+          expected_line = m[2].to_i
+        else
+          expected_line = num + 1 # 1 indexed lines
+        end
+        expected_errors[m[1]] << expected_line
+        m = re.match(line, m.end(0))
+      end
+    end
+    expected_errors
+  end
+
+  def do_lint(filename)
+    # Check for a test_case_style.rb style file for individual tests
+    style_file = filename.sub(/.md$/, '_style.rb')
+    if ! File.exist?(style_file)
+      style_file = 'all'
+    end
+
+    rules = MarkdownLint::RuleSet.load_default
+    style = MarkdownLint::Style.load(style_file, rules)
+    rules.select! {|r| style.rules.include?(r)}
+
+    doc = MarkdownLint::Doc.new(File.read(filename))
+    expected_errors = get_expected_errors(doc.lines)
+    actual_errors = {}
+    rules.sort.each do |id, rule|
+      error_lines = rule.check.call(doc)
+      if error_lines and not error_lines.empty?
+        actual_errors[id] = error_lines
+      end
+    end
+    assert_equal expected_errors, actual_errors
+  end
+
+  Dir[File.expand_path("../rule_tests/*.md", __FILE__)].each do |filename|
+    define_method("test_#{File.basename(filename, '.md')}") do
+      do_lint(filename)
+    end
+  end
+end

data/tools/README.md

@@ -0,0 +1,3 @@
+This directory contains a few scripts that, while not part of markdownlint
+directly, can be useful for inspecting markdown documents and debugging
+issues.

data/tools/test_location.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# Script for identifying when markdownlint is receiving an incorrect line
+# number for an element. It checks all headers, then grabs the lines
+# associated with the headers according to markdown and compares the content,
+# printing out any that don't match.
+require 'mdl/doc'
+require 'pry'
+
+text = File.read(ARGV[0])
+unless ARGV[1].nil?
+  # If we provide a second argument, then start the document from line N of
+  # the original file.
+  text = text.split("\n")[ARGV[1].to_i - 1..-1].join("\n")
+end
+doc = MarkdownLint::Doc.new(text)
+headers = doc.find_type(:header)
+bad_headers = headers.select do |e|
+   doc.element_line(e).nil? || ! doc.element_line(e).include?(e[:raw_text])
+end
+pp bad_headers

data/tools/view_markdown.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# Quick script for viewing getting at kramdown's and markdownlint's view of a
+# markdown file
+require 'mdl/doc'
+require 'pry'
+
+
+doc = MarkdownLint::Doc.new_from_file(ARGV[0])
+children = doc.parsed.root.children
+
+binding.pry

metadata

@@ -0,0 +1,314 @@
+--- !ruby/object:Gem::Specification
+name: mdl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: mixlib-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Style checker/lint tool for markdown files
+email:
+- mark@mivok.net
+executables:
+- mdl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mdl
+- docs/RULES.md
+- docs/creating_rules.md
+- docs/creating_styles.md
+- example/markdown_spec.md
+- lib/mdl.rb
+- lib/mdl/cli.rb
+- lib/mdl/config.rb
+- lib/mdl/doc.rb
+- lib/mdl/kramdown_parser.rb
+- lib/mdl/rules.rb
+- lib/mdl/ruleset.rb
+- lib/mdl/style.rb
+- lib/mdl/styles/all.rb
+- lib/mdl/styles/cirosantilli.rb
+- lib/mdl/styles/default.rb
+- lib/mdl/styles/relaxed.rb
+- lib/mdl/version.rb
+- mdl.gemspec
+- test/rule_tests/atx_closed_header_spacing.md
+- test/rule_tests/atx_header_spacing.md
+- test/rule_tests/blockquote_blank_lines.md
+- test/rule_tests/blockquote_spaces.md
+- test/rule_tests/bulleted_list_2_space_indent.md
+- test/rule_tests/bulleted_list_2_space_indent_style.rb
+- test/rule_tests/bulleted_list_4_space_indent.md
+- test/rule_tests/bulleted_list_not_at_beginning_of_line.md
+- test/rule_tests/code_block_dollar.md
+- test/rule_tests/consecutive_blank_lines.md
+- test/rule_tests/consistent_bullet_styles_asterisk.md
+- test/rule_tests/consistent_bullet_styles_dash.md
+- test/rule_tests/consistent_bullet_styles_plus.md
+- test/rule_tests/empty_doc.md
+- test/rule_tests/fenced_code_blocks.md
+- test/rule_tests/first_header_bad_atx.md
+- test/rule_tests/first_header_bad_setext.md
+- test/rule_tests/first_header_good_atx.md
+- test/rule_tests/first_header_good_setext.md
+- test/rule_tests/header_duplicate_content.md
+- test/rule_tests/header_multiple_toplevel.md
+- test/rule_tests/header_mutliple_h1_no_toplevel.md
+- test/rule_tests/header_trailing_punctuation.md
+- test/rule_tests/header_trailing_punctuation_customized.md
+- test/rule_tests/header_trailing_punctuation_customized_style.rb
+- test/rule_tests/headers_bad.md
+- test/rule_tests/headers_good.md
+- test/rule_tests/headers_surrounding_space_atx.md
+- test/rule_tests/headers_surrounding_space_setext.md
+- test/rule_tests/headers_with_spaces_at_the_beginning.md
+- test/rule_tests/inconsistent_bullet_indent_same_level.md
+- test/rule_tests/inconsistent_bullet_styles_asterisk.md
+- test/rule_tests/inconsistent_bullet_styles_dash.md
+- test/rule_tests/inconsistent_bullet_styles_plus.md
+- test/rule_tests/incorrect_bullet_style_asterisk.md
+- test/rule_tests/incorrect_bullet_style_asterisk_style.rb
+- test/rule_tests/incorrect_bullet_style_dash.md
+- test/rule_tests/incorrect_bullet_style_dash_style.rb
+- test/rule_tests/incorrect_bullet_style_plus.md
+- test/rule_tests/incorrect_bullet_style_plus_style.rb
+- test/rule_tests/incorrect_header_atx.md
+- test/rule_tests/incorrect_header_atx_closed.md
+- test/rule_tests/incorrect_header_atx_closed_style.rb
+- test/rule_tests/incorrect_header_atx_style.rb
+- test/rule_tests/incorrect_header_setext.md
+- test/rule_tests/incorrect_header_setext_style.rb
+- test/rule_tests/long_lines.md
+- test/rule_tests/long_lines_100.md
+- test/rule_tests/long_lines_100_style.rb
+- test/rule_tests/mixed_header_types_atx.md
+- test/rule_tests/mixed_header_types_atx_closed.md
+- test/rule_tests/mixed_header_types_setext.md
+- test/rule_tests/ordered_list_item_prefix.md
+- test/rule_tests/ordered_list_item_prefix_ordered.md
+- test/rule_tests/ordered_list_item_prefix_ordered_style.rb
+- test/rule_tests/reversed_link.md
+- test/rule_tests/spaces_after_list_marker.md
+- test/rule_tests/spaces_after_list_marker_style.rb
+- test/rule_tests/whitespace issues.md
+- test/setup_tests.rb
+- test/test_ruledocs.rb
+- test/test_rules.rb
+- tools/README.md
+- tools/test_location.rb
+- tools/view_markdown.rb
+homepage: http://github.com/mivok/mdl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Markdown lint tool
+test_files:
+- test/rule_tests/atx_closed_header_spacing.md
+- test/rule_tests/atx_header_spacing.md
+- test/rule_tests/blockquote_blank_lines.md
+- test/rule_tests/blockquote_spaces.md
+- test/rule_tests/bulleted_list_2_space_indent.md
+- test/rule_tests/bulleted_list_2_space_indent_style.rb
+- test/rule_tests/bulleted_list_4_space_indent.md
+- test/rule_tests/bulleted_list_not_at_beginning_of_line.md
+- test/rule_tests/code_block_dollar.md
+- test/rule_tests/consecutive_blank_lines.md
+- test/rule_tests/consistent_bullet_styles_asterisk.md
+- test/rule_tests/consistent_bullet_styles_dash.md
+- test/rule_tests/consistent_bullet_styles_plus.md
+- test/rule_tests/empty_doc.md
+- test/rule_tests/fenced_code_blocks.md
+- test/rule_tests/first_header_bad_atx.md
+- test/rule_tests/first_header_bad_setext.md
+- test/rule_tests/first_header_good_atx.md
+- test/rule_tests/first_header_good_setext.md
+- test/rule_tests/header_duplicate_content.md
+- test/rule_tests/header_multiple_toplevel.md
+- test/rule_tests/header_mutliple_h1_no_toplevel.md
+- test/rule_tests/header_trailing_punctuation.md
+- test/rule_tests/header_trailing_punctuation_customized.md
+- test/rule_tests/header_trailing_punctuation_customized_style.rb
+- test/rule_tests/headers_bad.md
+- test/rule_tests/headers_good.md
+- test/rule_tests/headers_surrounding_space_atx.md
+- test/rule_tests/headers_surrounding_space_setext.md
+- test/rule_tests/headers_with_spaces_at_the_beginning.md
+- test/rule_tests/inconsistent_bullet_indent_same_level.md
+- test/rule_tests/inconsistent_bullet_styles_asterisk.md
+- test/rule_tests/inconsistent_bullet_styles_dash.md
+- test/rule_tests/inconsistent_bullet_styles_plus.md
+- test/rule_tests/incorrect_bullet_style_asterisk.md
+- test/rule_tests/incorrect_bullet_style_asterisk_style.rb
+- test/rule_tests/incorrect_bullet_style_dash.md
+- test/rule_tests/incorrect_bullet_style_dash_style.rb
+- test/rule_tests/incorrect_bullet_style_plus.md
+- test/rule_tests/incorrect_bullet_style_plus_style.rb
+- test/rule_tests/incorrect_header_atx.md
+- test/rule_tests/incorrect_header_atx_closed.md
+- test/rule_tests/incorrect_header_atx_closed_style.rb
+- test/rule_tests/incorrect_header_atx_style.rb
+- test/rule_tests/incorrect_header_setext.md
+- test/rule_tests/incorrect_header_setext_style.rb
+- test/rule_tests/long_lines.md
+- test/rule_tests/long_lines_100.md
+- test/rule_tests/long_lines_100_style.rb
+- test/rule_tests/mixed_header_types_atx.md
+- test/rule_tests/mixed_header_types_atx_closed.md
+- test/rule_tests/mixed_header_types_setext.md
+- test/rule_tests/ordered_list_item_prefix.md
+- test/rule_tests/ordered_list_item_prefix_ordered.md
+- test/rule_tests/ordered_list_item_prefix_ordered_style.rb
+- test/rule_tests/reversed_link.md
+- test/rule_tests/spaces_after_list_marker.md
+- test/rule_tests/spaces_after_list_marker_style.rb
+- test/rule_tests/whitespace issues.md
+- test/setup_tests.rb
+- test/test_ruledocs.rb
+- test/test_rules.rb
+has_rdoc: