mdl 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e51fd852e7791bcde9513e139c43c93fc0377ec3
-  data.tar.gz: d566428c48d875eb1bd0f89e4cdff094f50a23d6
+SHA256:
+  metadata.gz: 38b73db54b5ec02a8b079558f3cb444c3f29e7ffd0e9a752483115d5c0a13a93
+  data.tar.gz: 47c88efb0b9aa6ac538c769096d02d36170109ef4a7bc9e4370af8d45143c6d0
 SHA512:
-  metadata.gz: dd7a9864461857232915798e54111bfeaf3cc957b53fed0dc74bc28e94496e13616f91be2e2b930f38fcbb1581108f8e41e4dd5e642eb6f2cd411becb31376a8
-  data.tar.gz: d561fd970ab869fb6a43780e19b20d861e4f46a48e891bfc9e5e99c464afcfc0295715e22f2c2986ca0b70f91c7b0b3b41b660519586d5ffa3eed705f63f9527
+  metadata.gz: 3a9c8c520e4f1e31517bb4b34549e45c505f86ed84daff6548092df02a34b594a7b81a8c4972ea93ba14fd75d4ea8a753e5c8f6f67994857d3e55449fbeb55bf
+  data.tar.gz: a8b3d72b3ff83bd86eb72c3b3911d16a5951ebc26372fa40995662f9372931aa192948517eafb7d7a8ec3eb0ede0d226423754c60c037543d7d55023d55f801f

data/.travis.yml

@@ -1,9 +1,23 @@
+sudo: false
+dist: trusty
 language: ruby
 
+notifications:
+  email: false
+
+# Temporary disable of jruby testing. There are problems on travis-ci
+# currently with this. See:
+#
+#   https://github.com/travis-ci/travis-ci/issues/9826
+#
+# before_install:
+#  - unset _JAVA_OPTIONS
+
 matrix:
   include:
-    - rvm: 2.1.10
-    - rvm: 2.2.5
-    - rvm: 2.3.1
-    - rvm: jruby-9.1.2.0
-      env: JRUBY_OPTS="--dev"
+    - rvm: 2.3.4
+    - rvm: 2.4.1
+    - rvm: 2.5.1
+#    - rvm: jruby-9.1.9.0
+#      env: JRUBY_OPTS="--dev"
+#    - rvm: jruby-9.2.0.0

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Change Log
 
+## [Unreleased]
+
+### Changed
+
+## [v0.5.0]
+
+### Added
+
+* Add md042 to enforce code block style
+* JSON formatter/output
+
+### Changed
+
+* PR #200: allow different nesting on headers duplication check
+* MD036 - Ignore multi-line emphasized paragraphs, and emphasized paragraphs
+  that end in punctuation (#140)
+
+### Fixed
+
+* PR #168: fix issue numbers false positives
+* Fix issue #102: lint MD039 checking for nodes inside link text
+
 ## [v0.4.0] (2016-08-22)
 
 ### Added
@@ -33,7 +55,7 @@
 ### Added
 
 * You can now load your own custom rules with the `-u` option. See
-  [rules.rb](https://github.com/mivok/markdownlint/blob/master/lib/mdl/rules.rb)
+  [rules.rb](https://github.com/markdownlint/markdownlint/blob/master/lib/mdl/rules.rb)
   for an example of what a rules file looks like. Use the `-d` option if you
   don't want to load markdownlint's default ruleset.
 * You can now refer to rules by human-readable/writable aliases, such as
@@ -55,20 +77,20 @@
 * Crash with MD034 and pipe character (#93, #97)
 * MD031 failed on nested code blocks (#100, #109)
 * MD037 crashes on <li> with underscores (#83)
-* Regression introducted in v0.2.1 - ignoring rules/tags on the command line
+* Regression introduced in v0.2.1 - ignoring rules/tags on the command line
   caused a crash (#108)
 * MD027 false positive when line starts with a backtick (#105)
 
 ### Merged pull requests
 
 * [Add support for nested code fences to MD031/MD032 - David
-  Anson](https://github.com/mivok/markdownlint/pull/109)
+  Anson](https://github.com/markdownlint/markdownlint/pull/109)
 * [Add missing word to description of MD035 in RULES.md - David
-  Anson](https://github.com/mivok/markdownlint/pull/86)
+  Anson](https://github.com/markdownlint/markdownlint/pull/86)
 * [Probe for .mdlrc in current and parent directories - Loic
-  Nageleisen](https://github.com/mivok/markdownlint/pull/111)
+  Nageleisen](https://github.com/markdownlint/markdownlint/pull/111)
 * [MD013: allow excluding code blocks and tables - Loic
-  Nageleisen](https://github.com/mivok/markdownlint/pull/112)
+  Nageleisen](https://github.com/markdownlint/markdownlint/pull/112)
 
 ## [v0.2.1] (2015-04-13)
 
@@ -104,7 +126,7 @@
 
 ### Merged pull requests
 
-* [Add parameter (value and default) information to rule documentation. - David Anson](https://github.com/mivok/markdownlint/pull/76)
+* [Add parameter (value and default) information to rule documentation. - David Anson](https://github.com/markdownlint/markdownlint/pull/76)
 
 ## [v0.1.0] (2015-02-22)
 
@@ -119,10 +141,10 @@
 
 ### Merged pull requests
 
-* [MD032 - Lists should be surrounded by blank lines - David Anson](https://github.com/mivok/markdownlint/pull/70)
-* [MD031 - Fenced code blocks should be surrounded by blank lines - David Anson](https://github.com/mivok/markdownlint/pull/68)
-* [Clarify how to specify your own style - mjankowski](https://github.com/mivok/markdownlint/pull/65)
-* [Use single quotes to prevent early escaping - highb](https://github.com/mivok/markdownlint/pull/64)
+* [MD032 - Lists should be surrounded by blank lines - David Anson](https://github.com/markdownlint/markdownlint/pull/70)
+* [MD031 - Fenced code blocks should be surrounded by blank lines - David Anson](https://github.com/markdownlint/markdownlint/pull/68)
+* [Clarify how to specify your own style - mjankowski](https://github.com/markdownlint/markdownlint/pull/65)
+* [Use single quotes to prevent early escaping - highb](https://github.com/markdownlint/markdownlint/pull/64)
 
 ## [v0.0.1] (2014-09-07)
 
@@ -155,11 +177,11 @@
 * MD029 - Ordered list item prefix
 * MD030 - Spaces after list markers
 
-[Unreleased]: https://github.com/mivok/markdownlint/tree/master
-[v0.4.0]: https://github.com/mivok/markdownlint/tree/v0.4.0
-[v0.3.1]: https://github.com/mivok/markdownlint/tree/v0.3.1
-[v0.3.0]: https://github.com/mivok/markdownlint/tree/v0.3.0
-[v0.2.1]: https://github.com/mivok/markdownlint/tree/v0.2.1
-[v0.2.0]: https://github.com/mivok/markdownlint/tree/v0.2.0
-[v0.1.0]: https://github.com/mivok/markdownlint/tree/v0.1.0
-[v0.0.1]: https://github.com/mivok/markdownlint/tree/v0.0.1
+[Unreleased]: https://github.com/markdownlint/markdownlint/tree/master
+[v0.4.0]: https://github.com/markdownlint/markdownlint/tree/v0.4.0
+[v0.3.1]: https://github.com/markdownlint/markdownlint/tree/v0.3.1
+[v0.3.0]: https://github.com/markdownlint/markdownlint/tree/v0.3.0
+[v0.2.1]: https://github.com/markdownlint/markdownlint/tree/v0.2.1
+[v0.2.0]: https://github.com/markdownlint/markdownlint/tree/v0.2.0
+[v0.1.0]: https://github.com/markdownlint/markdownlint/tree/v0.1.0
+[v0.0.1]: https://github.com/markdownlint/markdownlint/tree/v0.0.1

data/README.md

@@ -1,5 +1,5 @@
 [![Issues on deck](https://badge.waffle.io/mivok/markdownlint.png?label=on%20deck&title=On%20Deck)](https://waffle.io/mivok/markdownlint)
-[![Travis build status](http://api.travis-ci.org/mivok/markdownlint.svg)](https://travis-ci.org/mivok/markdownlint)
+[![Travis build status](http://api.travis-ci.org/markdownlint/markdownlint.svg)](https://travis-ci.org/markdownlint/markdownlint)
 [![Gem Version](https://badge.fury.io/rb/mdl.svg)](http://badge.fury.io/rb/mdl)
 
 # Markdown lint tool
@@ -18,7 +18,7 @@ To install from rubygems, run:
 
 To install the latest development version from github:
 
-    git clone https://github.com/mivok/markdownlint
+    git clone https://github.com/markdownlint/markdownlint
     cd markdownlint
     rake install
 
@@ -79,7 +79,7 @@ For more information on creating style files, see the
 
 ## Contributing
 
-1. Fork it ( <http://github.com/mivok/markdownlint/fork> )
+1. Fork it ( <http://github.com/markdownlint/markdownlint/fork> )
 1. Create your feature branch (`git checkout -b my-new-feature`)
 1. Commit your changes (`git commit -am 'Add some feature'`)
 1. Push to the branch (`git push origin my-new-feature`)

data/docs/RULES.md

@@ -485,6 +485,8 @@ Tags: headers
 
 Aliases: no-duplicate-header
 
+Parameters: allow_different_nesting (boolean; default false)
+
 This rule is triggered if there are multiple headers in the document that have
 the same text:
 
@@ -502,6 +504,21 @@ Rationale: Some markdown parses generate anchors for headers based on the
 header name, and having headers with the same content can cause problems with
 this.
 
+If the parameter `allow_different_nesting` is set to `true`, header duplication
+under different nesting is allowed, like it usually happens in change logs:
+
+    # Change log
+
+    ## 2.0.0
+
+    ### Bug fixes
+
+    ### Features
+
+    ## 1.0.0
+
+    ### Bug fixes
+
 ## MD025 - Multiple top level headers in the same document
 
 Tags: headers
@@ -856,6 +873,8 @@ is allowed.
 
 Tags: headers, emphasis
 
+Parameters: punctuation (string; default ".,;:!?")
+
 Aliases: no-emphasis-as-header
 
 This check looks for instances where emphasized (i.e. bold or italic) text is
@@ -880,8 +899,11 @@ sections:
 
     Consectetur adipiscing elit, sed do eiusmod.
 
-Note: this rule looks for paragraphs that consist entirely of emphasized text.
-It won't fire on emphasis used within regular text.
+Note: this rule looks for single line paragraphs that consist entirely of
+emphasized text.  It won't fire on emphasis used within regular text,
+multi-line emphasized paragraphs, and paragraphs ending in punctuation.
+Similarly to rule MD026, you can configure what characters are recognized as
+punctuation.
 
 ## MD037 - Spaces inside emphasis markers
 
@@ -994,3 +1016,32 @@ To fix this, add a header to the top of your file:
 
 Note: The `level` parameter can be used to change the top level (ex: to h2) in
 cases where an h1 is added externally.
+
+## MD046 - Code block style
+
+Tags: code
+
+Aliases: code-block-style
+
+Parameters: style ("fenced", "indented", "consistent", default "fenced")
+
+This rule is truggered what a different code block style is used than the
+configured one. For example, in the default configuration this triggers:
+
+    Some text.
+
+        Code block
+
+    Some more text.
+
+To fix this, used fenced code blocks:
+
+    Some text.
+
+    ```ruby
+    Code block
+    ```
+
+    Some more text.
+
+Or the reverse for the `indented` style.

data/docs/rolling_a_release.md

@@ -21,7 +21,7 @@ Update the changelog:
 
         This goes at the bottom:
 
-        [v0.2.0]: https://github.com/mivok/markdownlint/tree/v0.2.0
+        [v0.2.0]: https://github.com/markdownlint/markdownlint/tree/v0.2.0
 
 * Changelog entries can and should be added in an 'Unreleased' section as
   commits are made. However, the following steps can be performed before each
@@ -30,7 +30,7 @@ Update the changelog:
   * Use `git diff v0.1.0..v0.2.0 docs/RULES.md | grep '## MD'` to discover
     what these are.
 * Search for closed issues:
-  * Go to <https://github.com/mivok/markdownlint/issues>
+  * Go to <https://github.com/markdownlint/markdownlint/issues>
   * Search for `closed:>1900-01-01`, changing the date to the date
     of the last release.
   * From this list of issues, make sections for:

data/lib/mdl.rb

@@ -6,6 +6,7 @@ require 'mdl/ruleset'
 require 'mdl/style'
 require 'mdl/version'
 
+require 'json'
 require 'kramdown'
 
 module MarkdownLint
@@ -69,6 +70,7 @@ module MarkdownLint
     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])
@@ -86,7 +88,15 @@ module MarkdownLint
         status = 1
         error_lines.each do |line|
           line += doc.offset # Correct line numbers for any yaml front matter
-          if Config[:show_aliases]
+          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}"
@@ -94,6 +104,13 @@ module MarkdownLint
         end
       end
     end
+
+    if Config[: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
 end

data/lib/mdl/cli.rb

@@ -98,6 +98,12 @@ module MarkdownLint
       :proc => Proc.new { puts MarkdownLint::VERSION },
       :exit => 0
 
+    option :json,
+      :short => '-j',
+      :long => '--json',
+      :description => "JSON output",
+      :boolean => true
+
     def run(argv=ARGV)
       parse_options(argv)
 

data/lib/mdl/doc.rb

@@ -246,7 +246,7 @@ module MarkdownLint
     # Extracts the text from an element whose children consist of text
     # elements and other things
 
-    def extract_text(element, prefix="")
+    def extract_text(element, prefix="", restore_whitespace = true)
       quotes = {
         :rdquo => '"',
         :ldquo => '"',
@@ -260,7 +260,7 @@ module MarkdownLint
         if e.type == :text
           e.value
         elsif [:strong, :em, :p, :codespan].include?(e.type)
-          extract_text(e, prefix).join("\n")
+          extract_text(e, prefix, restore_whitespace).join("\n")
         elsif e.type == :smart_quote
           quotes[e.value]
         end
@@ -268,7 +268,9 @@ module MarkdownLint
       # Text blocks have whitespace stripped, so we need to add it back in at
       # the beginning. Because this might be in something like a blockquote,
       # we optionally strip off a prefix given to the function.
-      lines[0] = element_line(element).sub(prefix, "")
+      if restore_whitespace
+        lines[0] = element_line(element).sub(prefix, "")
+      end
       lines
     end
 

data/lib/mdl/rules.rb

@@ -33,7 +33,7 @@ rule "MD003", "Header style" do
   # :style can be one of :consistent, :atx, :atx_closed, :setext
   params :style => :consistent
   check do |doc|
-    headers = doc.find_type_elements(:header)
+    headers = doc.find_type_elements(:header, false)
     if headers.empty?
       nil
     else
@@ -257,7 +257,7 @@ rule "MD022", "Headers should be surrounded by blank lines" do
   aliases 'blanks-around-headers'
   check do |doc|
     errors = []
-    doc.find_type_elements(:header).each do |h|
+    doc.find_type_elements(:header, false).each do |h|
       header_bad = false
       linenum = doc.element_linenumber(h)
       # Check previous line
@@ -303,7 +303,7 @@ rule "MD023", "Headers must start at the beginning of the line" do
     errors = []
     # The only type of header with spaces actually parsed as such is setext
     # style where only the text is indented. We check for that first.
-    doc.find_type_elements(:header).each do |h|
+    doc.find_type_elements(:header, false).each do |h|
       errors << doc.element_linenumber(h) if doc.element_line(h).match(/^\s/)
     end
     # Next we have to look for things that aren't parsed as headers because
@@ -332,11 +332,42 @@ end
 rule "MD024", "Multiple headers with the same content" do
   tags :headers
   aliases 'no-duplicate-header'
+  params :allow_different_nesting => false
   check do |doc|
-    header_content = Set.new
-    doc.find_type(:header).select do |h|
-      not header_content.add?(h[:raw_text])
-    end.map { |h| doc.element_linenumber(h) }
+    headers = doc.find_type(:header)
+    allow_different_nesting = params[:allow_different_nesting]
+
+    duplicates = headers.select do |h|
+      headers.any? do |e|
+        e[:location] < h[:location] &&
+          e[:raw_text] == h[:raw_text] &&
+          (allow_different_nesting == false || e[:level] != h[:level])
+      end
+    end.to_set
+
+    if allow_different_nesting
+      same_nesting_duplicates = Set.new
+      stack = []
+      current_level = 0
+      doc.find_type(:header).each do |header|
+        level = header[:level]
+        text = header[:raw_text]
+
+        if current_level > level
+          stack.pop
+        elsif current_level < level
+          stack.push([text])
+        else
+          same_nesting_duplicates.add(header) if stack.last.include?(text)
+        end
+
+        current_level = level
+      end
+
+      duplicates += same_nesting_duplicates
+    end
+
+    duplicates.map { |h| doc.element_linenumber(h) }
   end
 end
 
@@ -345,7 +376,7 @@ rule "MD025", "Multiple top level headers in the same document" do
   aliases 'single-h1'
   params :level => 1
   check do |doc|
-    headers = doc.find_type(:header).select { |h| h[:level] == params[:level] }
+    headers = doc.find_type(:header, false).select { |h| h[:level] == params[:level] }
     if not headers.empty? and doc.element_linenumber(headers[0]) == 1
       headers[1..-1].map { |h| doc.element_linenumber(h) }
     end
@@ -544,11 +575,20 @@ end
 rule "MD036", "Emphasis used instead of a header" do
   tags :headers, :emphasis
   aliases 'no-emphasis-as-header'
+  params :punctuation => '.,;:!?'
   check do |doc|
     # We are looking for a paragraph consisting entirely of emphasized
     # (italic/bold) text.
-    doc.element_linenumbers(doc.find_type_elements(:p, false).select{|p|
-      p.children.length == 1 && [:em, :strong].include?(p.children[0].type)})
+    errors = []
+    doc.find_type_elements(:p, false).each do |p|
+      next if p.children.length > 1
+      next unless [:em, :strong].include?(p.children[0].type)
+      lines = doc.extract_text(p.children[0], "", false)
+      next if lines.length > 1
+      next if lines[0].match(/[#{params[:punctuation]}]$/)
+      errors << doc.element_linenumber(p)
+    end
+    errors
   end
 end
 
@@ -579,10 +619,12 @@ rule "MD039", "Spaces inside link text" do
   tags :whitespace, :links
   aliases 'no-space-in-links'
   check do |doc|
-    doc.element_linenumbers(doc.find_type_elements(:a).select{|e|
-      e.children[0].type == :text and
-      (e.children[0].value.start_with?(" ") or
-      e.children[0].value.end_with?(" ")) })
+    doc.element_linenumbers(
+      doc.find_type_elements(:a).select{|e|
+      e.children[0].type == :text and (
+        e.children.first.value.start_with?(" ") or
+        e.children.last.value.end_with?(" "))}
+    )
   end
 end
 
@@ -608,3 +650,29 @@ rule "MD041", "First line in file should be a top level header" do
       or first_header[:level] != params[:level]
   end
 end
+
+rule "MD046", "Code block style" do
+  tags :code
+  aliases 'code-block-style'
+  params :style => :fenced
+  check do |doc|
+    style = @params[:style]
+    doc.element_linenumbers(
+      doc.find_type_elements(:codeblock).select do |i|
+        # for consistent we determine the first one
+        if style == :consistent
+          if doc.element_line(i).start_with?("    ")
+            style = :indented
+          else
+            style = :fenced
+          end
+        end
+        if @params[:style] == :fenced
+          doc.element_line(i).start_with?("    ")
+        else
+          !doc.element_line(i).start_with?("    ")
+        end
+      end
+    )
+  end
+end

data/lib/mdl/ruleset.rb

@@ -7,7 +7,7 @@ module MarkdownLint
       @aliases = []
       @tags = []
       @params = {}
-      instance_eval &block
+      instance_eval(&block)
     end
 
 

data/lib/mdl/version.rb

@@ -1,3 +1,3 @@
 module MarkdownLint
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/mdl.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["mark@mivok.net"]
   spec.summary       = %q{Markdown lint tool}
   spec.description   = %q{Style checker/lint tool for markdown files}
-  spec.homepage      = "http://github.com/mivok/markdownlint"
+  spec.homepage      = "http://github.com/markdownlint/markdownlint"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/test/rule_tests/code_block_consistency.md

@@ -0,0 +1,11 @@
+This is text.
+
+    This is a
+    code block.
+
+And here is more text
+
+```
+and here is a different {MD046:8}
+code block
+```

data/test/rule_tests/code_block_consistency_style.rb

@@ -0,0 +1 @@
+rule 'MD046', :style => :consistent

data/test/rule_tests/code_block_fenced.md

@@ -0,0 +1,17 @@
+This is text.
+
+    This is a {MD046}
+    code block.
+
+And here is more text
+
+```
+This is a code block that won't trigger.
+```
+
+But we'll do another:
+
+    And this {MD046}
+    will.
+
+Final text is here

data/test/rule_tests/code_block_fenced_style.rb

@@ -0,0 +1 @@
+rule 'MD046', :style => :fenced

data/test/rule_tests/code_block_indented.md

@@ -0,0 +1,17 @@
+This is text.
+
+    This is a
+    code block.
+
+And here is more text
+
+```
+This is {MD046:8} also a code block.
+```
+
+But we'll do another:
+
+    And this
+    will.
+
+Final text is here

data/test/rule_tests/code_block_indented_style.rb

@@ -0,0 +1 @@
+rule 'MD046', :style => :indented

data/test/rule_tests/default_test_style.rb

@@ -2,3 +2,4 @@
 all
 
 exclude_rule "MD041"
+exclude_rule "MD046"

data/test/rule_tests/emphasis_instead_of_headers.md

@@ -33,3 +33,8 @@ even though the emphasized text is on its own line.
 
 This is another **normal** paragraph with some text in it. This also should
 not trigger the rule.
+
+**This is an entire paragraph that has been emphasized, and shouldn't be
+detected as a header because it's on multiple lines**
+
+**This also shouldn't be detected as a header as it ends in punctuation.**

data/test/rule_tests/fix_102_extra_nodes_in_link_text.md

@@ -0,0 +1,8 @@
+[test _test_ test](www.test.com)
+[test `test` test](www.test.com)
+[test *test* test](www.test.com)
+[test *test* *test* test](www.test.com)
+[test *test* *test* *test* test](www.test.com)
+[test **test** test](www.test.com)
+[test __test__ test](www.test.com)
+[this should not raise](www.shouldnotraise.com)

data/test/rule_tests/header_duplicate_content_different_nesting.md

@@ -0,0 +1,11 @@
+# Change log
+
+## 2.0.0
+
+### Bug fixes
+
+### Features
+
+## 1.0.0
+
+### Bug fixes

data/test/rule_tests/header_duplicate_content_different_nesting_style.rb

@@ -0,0 +1 @@
+rule "MD024", :allow_different_nesting => true

data/test/rule_tests/header_duplicate_content_no_different_nesting.md

@@ -0,0 +1,13 @@
+# Change log
+
+## 2.0.0
+
+### Bug fixes
+
+### Features
+
+## 1.0.0
+
+### Bug fixes
+
+{MD024:11}

data/test/rule_tests/headers_good_with_issue_numbers.md

@@ -0,0 +1,12 @@
+# Heading 1
+
+## Heading 2
+
+See the following issues:
+
+* #1234
+* #5678 (and related)
+  * #5678
+  * #9101
+
+## Heading 3

data/test/rule_tests/spaces_after_list_marker_style.rb

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

data/test/test_cli.rb

@@ -183,14 +183,21 @@ class TestCli < Minitest::Test
   def test_directory_scanning
     path = File.expand_path("./fixtures/dir_with_md_and_markdown", File.dirname(__FILE__))
     result = run_cli("#{path}")
-    files_with_issues = result[:stdout].split("\n").map { |l| l.split(":")[0] }.sort
+    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}")
-    assert_equal(result[:stdout], "#{path}/jekyll_post.md:16: MD001 Header levels should only increment by one level at a time\n")
+
+    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

data/tools/docker/Dockerfile

@@ -0,0 +1,13 @@
+FROM alpine:3.4
+
+MAINTAINER Mark Harrison <mark@mivok.net>
+
+RUN apk update && \
+    apk add --no-cache ruby && \
+    gem install --no-rdoc --no-ri mdl && \
+    mkdir /data
+
+WORKDIR /data
+
+ENTRYPOINT ["mdl"]
+CMD ["--help"]

data/tools/docker/README.md

@@ -0,0 +1,19 @@
+# Docker container for markdownlint
+
+## Using the docker image
+
+To check a single file:
+
+    docker run --rm -v ${PWD}:/data mivok/markdownlint myfile.md
+
+Or, to check all files in a directory:
+
+    docker run --rm -v ${PWD}:/data mivok/markdownlint .
+
+## Building from a docker file
+
+The following will tag and upload a new release. Replace X.Y.Z as appropriate.
+
+    docker build -t mivok/markdownlint:latest -t mivok/markdownlint:X.Y.Z .
+    docker push mivok/markdownlint:latest
+    docker push mivok/markdownling:X.Y.Z

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdl
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mark Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-22 00:00:00.000000000 Z
+date: 2018-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -181,8 +181,14 @@ files:
 - 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_consistency.md
+- test/rule_tests/code_block_consistency_style.rb
 - test/rule_tests/code_block_dollar.md
 - test/rule_tests/code_block_dollar_fence.md
+- test/rule_tests/code_block_fenced.md
+- test/rule_tests/code_block_fenced_style.rb
+- test/rule_tests/code_block_indented.md
+- test/rule_tests/code_block_indented_style.rb
 - test/rule_tests/consecutive_blank_lines.md
 - test/rule_tests/consistent_bullet_styles_asterisk.md
 - test/rule_tests/consistent_bullet_styles_dash.md
@@ -202,7 +208,11 @@ files:
 - test/rule_tests/first_line_top_level_header_atx_style.rb
 - test/rule_tests/first_line_top_level_header_setext.md
 - test/rule_tests/first_line_top_level_header_setext_style.rb
+- test/rule_tests/fix_102_extra_nodes_in_link_text.md
 - test/rule_tests/header_duplicate_content.md
+- test/rule_tests/header_duplicate_content_different_nesting.md
+- test/rule_tests/header_duplicate_content_different_nesting_style.rb
+- test/rule_tests/header_duplicate_content_no_different_nesting.md
 - test/rule_tests/header_multiple_toplevel.md
 - test/rule_tests/header_mutliple_h1_no_toplevel.md
 - test/rule_tests/header_trailing_punctuation.md
@@ -212,6 +222,7 @@ files:
 - test/rule_tests/headers_good.md
 - test/rule_tests/headers_good_setext_with_atx.md
 - test/rule_tests/headers_good_setext_with_atx_style.rb
+- test/rule_tests/headers_good_with_issue_numbers.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
@@ -270,9 +281,11 @@ files:
 - test/test_ruledocs.rb
 - test/test_rules.rb
 - tools/README.md
+- tools/docker/Dockerfile
+- tools/docker/README.md
 - tools/test_location.rb
 - tools/view_markdown.rb
-homepage: http://github.com/mivok/markdownlint
+homepage: http://github.com/markdownlint/markdownlint
 licenses:
 - MIT
 metadata: {}
@@ -292,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Markdown lint tool
@@ -316,8 +329,14 @@ test_files:
 - 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_consistency.md
+- test/rule_tests/code_block_consistency_style.rb
 - test/rule_tests/code_block_dollar.md
 - test/rule_tests/code_block_dollar_fence.md
+- test/rule_tests/code_block_fenced.md
+- test/rule_tests/code_block_fenced_style.rb
+- test/rule_tests/code_block_indented.md
+- test/rule_tests/code_block_indented_style.rb
 - test/rule_tests/consecutive_blank_lines.md
 - test/rule_tests/consistent_bullet_styles_asterisk.md
 - test/rule_tests/consistent_bullet_styles_dash.md
@@ -337,7 +356,11 @@ test_files:
 - test/rule_tests/first_line_top_level_header_atx_style.rb
 - test/rule_tests/first_line_top_level_header_setext.md
 - test/rule_tests/first_line_top_level_header_setext_style.rb
+- test/rule_tests/fix_102_extra_nodes_in_link_text.md
 - test/rule_tests/header_duplicate_content.md
+- test/rule_tests/header_duplicate_content_different_nesting.md
+- test/rule_tests/header_duplicate_content_different_nesting_style.rb
+- test/rule_tests/header_duplicate_content_no_different_nesting.md
 - test/rule_tests/header_multiple_toplevel.md
 - test/rule_tests/header_mutliple_h1_no_toplevel.md
 - test/rule_tests/header_trailing_punctuation.md
@@ -347,6 +370,7 @@ test_files:
 - test/rule_tests/headers_good.md
 - test/rule_tests/headers_good_setext_with_atx.md
 - test/rule_tests/headers_good_setext_with_atx_style.rb
+- test/rule_tests/headers_good_with_issue_numbers.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