mdl 0.5.0 → 0.10.0

data/test/rule_tests/incorrect_header_atx_closed_style.rb

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

data/test/rule_tests/incorrect_header_atx_style.rb

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

data/test/rule_tests/incorrect_header_setext.md

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

data/test/rule_tests/incorrect_header_setext_style.rb

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

data/test/rule_tests/inline_html.md

@@ -1,13 +0,0 @@
-# Regular header
-
-<h1>Inline HTML Header {MD033}</h1>
-
-<p>More inline HTML {MD033}
-but this time on multiple lines
-</p>
-
-    <h1>This shouldn't trigger as it's inside a code block</h1>
-
-```text
-<p>Neither should this as it's also in a code block</p>
-```

data/test/rule_tests/links.md

@@ -1,9 +0,0 @@
-# Link test
-
-For more information, please see the
-following page: http://www.example.com/ {MD034}
-which will tell you all you want to know.
-
-http://www.google.com/ {MD034}
-
-This link should be fine: <http://www.google.com/>

data/test/rule_tests/lists_without_blank_lines.md

@@ -1,75 +0,0 @@
-* list (on first line)
-
-text
-
-* list
-
-text
-* list {MD032}
-text
-+ list {MD032}
-text
-- list {MD032}
-text
-1. list {MD032}
-text
-
-* list
-* list {MD032}
-text
-
-text
-10. list {MD032}
-20. list
-
-text
-
-* list
-  * list
-    * list
-
-text
-
-* list
-  with hanging indent
-  * list
-    with hanging indent
-* list
-  with hanging indent
-
-Note: list without hanging indent violates MD032
-
-* list
-
-  item with blank lines
-
-* list
-
-  item with blank lines
-
-text
-
-```js
-/*
- * code block
- * not a list
- */
-```
-
-text
-
-* list {MD032}
-``` {MD031}
-code
-```
-
-text
-
-```
-code
-``` {MD031}
-* list {MD032}
-
-text
-
-* list (on last line without newline)

data/test/rule_tests/long_lines.md

@@ -1,3 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

@@ -1,3 +0,0 @@
-all
-rule 'MD013', :line_length => 100
-exclude_rule "MD041"

data/test/rule_tests/long_lines_code.md

@@ -1,45 +0,0 @@
-This is a short line.
-
-This is a very very very very very very very very very very very very very very very very very very very very long line. {MD013}
-
-This is a short line.
-
-```text
-Here is a short line in a code block.
-Here is a very very very very very very very very very very very very very very very very very very very long line in a code block.
-```
-
-```text
-test
-test
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut
-```
-
-This is a short line.
-
-| First Header  | Second Header | Third Header  | Fourth Header | Fifth Header  | Sixth  Header |
-| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
-| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
-| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
-| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
-| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
-| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
-| ============= | ============= | ============= | ============= | ============= | ============= |
-| Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   |
-{: rules="groups"}
-
-This is a very very very very very very very very very very very very very very very very very very very very long line. {MD013}
-
-Another line.
-
-| First Header  | Second Header | Third Header  | Fourth Header | Fifth Header  | Sixth  Header |
-| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
-| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
-| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
-| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
-| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
-| Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  | Content Cell  |
-| ============= | ============= | ============= | ============= | ============= | ============= |
-| Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   | Footer Cell   |
-{: rules="groups"}

data/test/rule_tests/long_lines_code_style.rb

@@ -1,3 +0,0 @@
-all
-rule 'MD013', :code_blocks => false, :tables => false
-exclude_rule "MD041"

data/test/rule_tests/mixed_header_types_atx.md

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

data/test/rule_tests/mixed_header_types_atx_closed.md

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

data/test/rule_tests/mixed_header_types_setext.md

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

data/test/rule_tests/no_first_line_header.md

@@ -1 +0,0 @@
-This is a file without a top level header {MD041}

data/test/rule_tests/no_first_line_header_style.rb

@@ -1 +0,0 @@
-all

data/test/rule_tests/no_first_line_top_level_header.md

@@ -1 +0,0 @@
-## Second level header {MD041} {MD002}

data/test/rule_tests/no_first_line_top_level_header_style.rb

@@ -1 +0,0 @@
-all

data/test/rule_tests/ordered_list_item_prefix.md

@@ -1,13 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,3 +0,0 @@
-all
-rule 'MD029', :style => :ordered
-exclude_rule 'MD041'

data/test/rule_tests/reversed_link.md

@@ -1,7 +0,0 @@
-Go to (this website)[http://www.example.com] {MD011} {MD034}
-
-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

@@ -1,74 +0,0 @@
-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

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

data/test/rule_tests/spaces_inside_codespan_elements.md

@@ -1,7 +0,0 @@
-`normal codespan element`
-
-` codespan element with space inside left` {MD038}
-
-`codespan element with space inside right ` {MD038}
-
-` codespan element with spaces inside ` {MD038}

data/test/rule_tests/spaces_inside_emphasis_markers.md

@@ -1,35 +0,0 @@
-Line with *Normal emphasis*
-
-Line with **Normal strong**
-
-Line with _Normal emphasis_
-
-Line with __Normal strong__
-
-Broken * emphasis * with spaces in {MD037}
-
-Broken ** strong ** with spaces in {MD037}
-
-Broken _ emphasis _ with spaces in {MD037}
-
-Broken __ strong __ with spaces in {MD037}
-
-Mixed *ok emphasis* and * broken emphasis * {MD037}
-
-Mixed **ok strong** and ** broken strong ** {MD037}
-
-Mixed _ok emphasis_ and _ broken emphasis _ {MD037}
-
-Mixed __ok strong__ and __ broken strong __ {MD037}
-
-Mixed *ok emphasis* **ok strong** * broken emphasis * {MD037}
-
-Multiple * broken emphasis * _ broken emphasis _ {MD037}
-
-One-sided *broken emphasis * {MD037}
-
-One-sided * broken emphasis* {MD037}
-
-Don't _flag on _words with underscores before them.
-
-The same goes for words* with asterisks* after them.

data/test/rule_tests/spaces_inside_link_text.md

@@ -1,10 +0,0 @@
-[foo](http://bar/)
-
-[foo ](http://bar/) {MD039}
-
-[ foo](http://bar/) {MD039}
-
-[ foo ](http://bar/) {MD039}
-
-The following shouldn't break anything:
-[![Screenshot.png](/images/Screenshot.png)](/images/Screenshot.png)

data/test/rule_tests/trailing_spaces_br.md

@@ -1,4 +0,0 @@
-This line has a single trailing space {MD009} 
-This line has two trailing spaces and should be allowed  
-This line has three trailing spaces {MD009}   
-This line has four trailing spaces {MD009}    

data/test/rule_tests/trailing_spaces_br_style.rb

@@ -1,3 +0,0 @@
-all
-rule 'MD009', :br_spaces => 2
-exclude_rule "MD041"

data/test/rule_tests/whitespace_issues.md

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

data/test/setup_tests.rb

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

data/test/test_cli.rb

@@ -1,300 +0,0 @@
-require_relative 'setup_tests'
-require 'open3'
-require 'set'
-require 'fileutils'
-
-class TestCli < Minitest::Test
-  def test_help_text
-    result = run_cli("--help")
-    assert_match(/Usage: \S+ \[options\]/, result[:stdout])
-    assert_equal(0, result[:status])
-  end
-
-  def test_default_ruleset_loading
-    result = run_cli("-l")
-    assert_ran_ok(result)
-    assert_rules_enabled(result, ["MD001"])
-  end
-
-  def test_show_alias_rule_list
-    result = run_cli("-al")
-    assert_ran_ok(result)
-    assert_rules_enabled(result, ["header-increment"])
-  end
-
-  def test_show_alias_processing_file
-    result = run_cli_with_input("-a -r MD002", "## header2")
-    assert_equal(1, result[:status])
-    assert_equal("", result[:stderr])
-    assert_match(/^\(stdin\):1: first-header-h1/, result[:stdout])
-  end
-
-  def test_running_on_unicode_input
-    result = run_cli_with_file_and_ascii_env("## header2 🚀")
-    assert_equal(1, result[:status])
-    assert_equal("", result[:stderr])
-    assert_match(/MD002 First header should be a top level header/,
-                 result[:stdout])
-  end
-
-  def test_skipping_default_ruleset_loading
-    result = run_cli("-ld")
-    assert_rules_enabled(result, [], true)
-  end
-
-  def test_custom_ruleset_loading
-    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
-    result = run_cli("-ldu #{my_ruleset}")
-    assert_rules_enabled(result, ["MY001"], true)
-    assert_ran_ok(result)
-  end
-
-  def test_show_alias_rule_without_alias
-    # Tests that when -a is given, but the rule doesn't have an alias, it
-    # prints the rule ID instead.
-    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
-    result = run_cli("-ladu #{my_ruleset}")
-    assert_rules_enabled(result, ["MY001"], true)
-    assert_ran_ok(result)
-  end
-
-  def test_custom_ruleset_processing_success
-    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
-    result = run_cli_with_input("-du #{my_ruleset}", "Hello World")
-    assert_equal("", result[:stdout])
-    assert_ran_ok(result)
-  end
-
-  def test_custom_ruleset_processing_failure
-    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
-    result = run_cli_with_input("-du #{my_ruleset}", "Goodbye world")
-    assert_equal(1, result[:status])
-    assert_match(/^\(stdin\):1: MY001/, result[:stdout])
-    assert_equal("", result[:stderr])
-  end
-
-  def test_custom_ruleset_processing_failure_with_show_alias
-    # The custom rule doesn't have an alias, so the output should be identical
-    # to that without show_alias enabled.
-    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
-    result = run_cli_with_input("-dau #{my_ruleset}", "Goodbye world")
-    assert_equal(1, result[:status])
-    assert_match(/^\(stdin\):1: MY001/, result[:stdout])
-    assert_equal("", result[:stderr])
-  end
-
-  def test_custom_ruleset_loading_with_default
-    my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
-    result = run_cli("-lu #{my_ruleset}")
-    assert_rules_enabled(result, ["MD001", "MY001"])
-    assert_ran_ok(result)
-  end
-
-  def test_rule_inclusion_cli
-    result = run_cli("-r MD001 -l")
-    assert_rules_enabled(result, ["MD001"], true)
-    assert_ran_ok(result)
-  end
-
-  def test_rule_exclusion_cli
-    result = run_cli("-r ~MD001 -l")
-    assert_rules_disabled(result, ["MD001"])
-    assert_ran_ok(result)
-  end
-
-  def test_rule_inclusion_with_exclusion_cli
-    result = run_cli("-r ~MD001,MD039 -l")
-    assert_rules_enabled(result, ["MD039"], true)
-    assert_ran_ok(result)
-  end
-
-  def test_tag_inclusion_cli
-    result = run_cli("-t headers -l")
-    assert_rules_enabled(result, ["MD001", "MD002", "MD003"])
-    assert_rules_disabled(result, ["MD004", "MD005", "MD006"])
-    assert_ran_ok(result)
-  end
-
-  def test_tag_exclusion_cli
-    result = run_cli("-t ~headers -l")
-    assert_ran_ok(result)
-    assert_rules_disabled(result, ["MD001", "MD002", "MD003"])
-    assert_rules_enabled(result, ["MD004", "MD005", "MD006"])
-  end
-
-  def test_rule_inclusion_config
-    result = run_cli_with_custom_rc_file("-l", "mdlrc_enable_rules")
-    assert_ran_ok(result)
-    assert_rules_enabled(result, ["MD001", "MD002"], true)
-  end
-
-  def test_rule_exclusion_config
-    result = run_cli_with_custom_rc_file("-l", "mdlrc_disable_rules")
-    assert_correctly_disabled(result)
-  end
-
-  def test_mdlrc_loading_from_current_dir_by_default
-    inside_tmp_dir do |dir|
-      with_mdlrc("mdlrc_disable_rules", dir) do
-        result = run_cli_without_rc_flag("-l")
-        assert_correctly_disabled(result)
-      end
-    end
-  end
-
-  def test_mdlrc_loading_ascends_until_it_finds_an_rc_file
-    Dir.mktmpdir do |parent_dir|
-      inside_tmp_dir(parent_dir) do
-        with_mdlrc("mdlrc_disable_rules", parent_dir) do
-          result = run_cli_without_rc_flag("-l")
-          assert_correctly_disabled(result)
-        end
-      end
-    end
-  end
-
-  def test_tag_inclusion_config
-    result = run_cli_with_custom_rc_file("-l", "mdlrc_enable_tags")
-    assert_ran_ok(result)
-    assert_rules_enabled(result, ["MD001", "MD002", "MD009", "MD010"])
-    assert_rules_disabled(result, ["MD004", "MD005"])
-  end
-
-  def test_tag_exclusion_config
-    result = run_cli_with_custom_rc_file("-l", "mdlrc_disable_tags")
-    assert_ran_ok(result)
-    assert_rules_enabled(result, ["MD004", "MD030", "MD032"])
-    assert_rules_disabled(result, ["MD001", "MD005"])
-  end
-
-  def test_rule_inclusion_alias_cli
-    result = run_cli("-l -r header-increment")
-    assert_ran_ok(result)
-    assert_rules_enabled(result, ["MD001"], true)
-  end
-
-  def test_rule_exclusion_alias_cli
-    result = run_cli("-l -r ~header-increment")
-    assert_ran_ok(result)
-    assert_rules_disabled(result, ["MD001"])
-    assert_rules_enabled(result, ["MD002"])
-  end
-
-  def test_directory_scanning
-    path = File.expand_path("./fixtures/dir_with_md_and_markdown", File.dirname(__FILE__))
-    result = run_cli("#{path}")
-    lines_output = result[:stdout].lines
-    interested_lines = lines_output[0..(lines_output.count - 3)]
-    files_with_issues = interested_lines.map { |l| l.split(":")[0] }.sort
-    assert_equal(files_with_issues, ["#{path}/bar.markdown", "#{path}/foo.md"])
-  end
-
-  def test_ignore_front_matter
-    path = File.expand_path("./fixtures/front_matter", File.dirname(__FILE__))
-    result = run_cli("-i -r MD001,MD041,MD034 #{path}")
-
-    expected = \
-      "#{path}/jekyll_post.md:16: MD001 Header levels should only increment by one level at a time"\
-      "\n\nA detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md\n"
-
-    assert_equal(result[:stdout], expected)
-  end
-
-  private
-
-  def run_cli_with_input(args, stdin)
-    run_cmd("#{mdl_script} -c #{default_rc_file} #{args}", stdin)
-  end
-
-  def run_cli_without_rc_flag(args)
-    run_cmd("#{mdl_script} #{args}", "")
-  end
-
-  def run_cli(args)
-    run_cmd("#{mdl_script} -c #{default_rc_file} #{args}", "")
-  end
-
-  def run_cli_with_custom_rc_file(args, filename)
-    run_cmd("#{mdl_script} -c #{fixture_rc(filename)} #{args}", "")
-  end
-
-  def run_cli_with_file_and_ascii_env(content)
-    Tempfile.create('foo') do |f|
-      f.write(content)
-      f.close
-
-      run_cmd("ruby -E ASCII #{mdl_script} -c #{default_rc_file} #{f.path}", "")
-    end
-  end
-
-  def run_cmd(command, stdin)
-    result = {}
-    result[:stdout], result[:stderr], result[:status] = \
-      Open3.capture3("bundle", "exec", *command.split, :stdin_data => stdin)
-    result[:status] = result[:status].exitstatus
-    result
-  end
-
-  def mdl_script
-    File.expand_path("../../bin/mdl", __FILE__)
-  end
-
-  def fixture_rc(filename)
-    File.expand_path("../fixtures/#{filename}", __FILE__)
-  end
-
-  def default_rc_file
-    fixture_rc("default_mdlrc")
-  end
-
-  def inside_tmp_dir(base_dir = Dir.tmpdir)
-    Dir.mktmpdir(nil, base_dir) do |dir|
-      Dir.chdir(dir) { yield(dir) }
-    end
-  end
-
-  def assert_rules_enabled(result, rules, only_these_rules=false)
-    # Asserts that the given rules are enabled given the output of mdl -l
-    # If only_these_rules is set, then it asserts that the given rules and no
-    # others are enabled.
-    lines = result[:stdout].split("\n")
-    assert_equal("Enabled rules:", lines.first)
-    lines.shift
-    rules = rules.to_set
-    enabled_rules = lines.map{ |l| l.split(" ").first }.to_set
-    if only_these_rules
-      assert_equal(rules, enabled_rules)
-    else
-      assert_equal(Set.new, rules - enabled_rules)
-    end
-  end
-
-  def assert_rules_disabled(result, rules)
-    # Asserts that the given rules are _not_ enabled given the output of mdl -l
-    lines = result[:stdout].split("\n")
-    assert_equal("Enabled rules:", lines.first)
-    lines.shift
-    rules = rules.to_set
-    enabled_rules = lines.map{ |l| l.split(" ").first }.to_set
-    assert_equal(Set.new, rules & enabled_rules)
-  end
-
-  def assert_ran_ok(result)
-    assert_equal(0, result[:status])
-    assert_equal("", result[:stderr])
-  end
-
-  def assert_correctly_disabled(result)
-    assert_ran_ok(result)
-    assert_rules_disabled(result, ["MD001", "MD002"])
-    assert_rules_enabled(result, ["MD003", "MD004"])
-  end
-
-  def with_mdlrc(filename, dest_dir = Dir.pwd)
-    rc_path = File.join(dest_dir, ".mdlrc")
-    FileUtils.cp(fixture_rc(filename), rc_path)
-    yield
-  ensure
-    File.delete(rc_path)
-  end
-end