mdl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b4aab66e36530dc982328a64e931370dcd484c9
-  data.tar.gz: 69c11c9027df69c408e9f854341a6e54412d2c1c
+  metadata.gz: 754ba4fcea65ab367c6851469bb744fbf4339800
+  data.tar.gz: 22488dfa5f78f22cbf15ea204eadd437854515da
 SHA512:
-  metadata.gz: 47a151052b1220aedefc36019406ec451a6f03c919c91e500780dcb696637bf2e315204ae08d468937d93536eaca078d2295b5ef013adecc4bb21155c9d8956e
-  data.tar.gz: 36228402d91b627ee1d35e2447dba6fa65457f971fc55a8dbdc94fd262032c7f541a43c7ea69441d987b0591bcf293ace021aa0ec13baf6882ef56ef3265d5e0
+  metadata.gz: 9129f6ab9f1dc20326f2171eb70fd0d620becbc825f7b2d913a679b26a1f536643550f6db309590349ad1a7fcda3ae5cebed97e73bce5e1840ffb973348b2ec0
+  data.tar.gz: 554f83c5d7f92e0ae15442acab0d9d18a7b2052fafc3c61037e15140354c2db6c6fca38f4d9a8bfbce95a817d6975d911016735b040414ad825186e85b276d72

data/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Change Log
+
+## [v0.2.0](https://github.com/mivok/markdownlint/tree/v0.2.0) (2015-04-13)
+
+[Full Changelog](https://github.com/mivok/markdownlint/compare/v0.1.0...v0.2.0)
+
+### Rules added
+
+* MD033 - Inline HTML
+* MD034 - Bare URL used
+* MD035 - Horizontal rule style
+* MD036 - Emphasis used instead of a header
+* MD037 - Spaces inside emphasis markers
+* MD038 - Spaces inside code span elements
+* MD039 - Spaces inside link text
+* MD040 - Fenced code blocks should have a language specified
+
+## Enhancements implemented
+
+* Trailing spaces rule should allow an excemption for deliberate <br/\>
+  insertion.
+* Rules can be excluded in .mdlrc and on the command line by specifying a rule
+  as ~MD000.
+
+### Merged pull requests
+
+* [Add parameter (value and default) information to rule documentation. - David Anson](https://github.com/mivok/markdownlint/pull/76)
+
+## [v0.1.0](https://github.com/mivok/markdownlint/tree/v0.1.0) (2015-02-22)
+
+[Full Changelog](https://github.com/mivok/markdownlint/compare/v0.0.1...v0.1.0)
+
+### Rules added
+
+* MD031 - Fenced code blocks should be surrounded by blank lines
+* MD032 - Lists should be surrounded by blank lines
+
+### Bugs fixed
+
+* MD014 triggers when it shouldn't
+
+### 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)
+
+## [v0.0.1](https://github.com/mivok/markdownlint/tree/v0.0.1) (2014-09-07)
+
+### Rules added
+
+* MD001 - Header levels should only increment by one level at a time
+* MD002 - First header should be a h1 header
+* MD003 - Header style
+* MD004 - Unordered list style
+* MD005 - Inconsistent indentation for list items at the same level
+* MD006 - Consider starting bulleted lists at the beginning of the line
+* MD007 - Unordered list indentation
+* MD009 - Trailing spaces
+* MD010 - Hard tabs
+* MD011 - Reversed link syntax
+* MD012 - Multiple consecutive blank lines
+* MD013 - Line length
+* MD014 - Dollar signs used before commands without showing output
+* MD018 - No space after hash on atx style header
+* MD019 - Multiple spaces after hash on atx style header
+* MD020 - No space inside hashes on closed atx style header
+* MD021 - Multiple spaces inside hashes on closed atx style header
+* MD022 - Headers should be surrounded by blank lines
+* MD023 - Headers must start at the beginning of the line
+* MD024 - Multiple headers with the same content
+* MD025 - Multiple top level headers in the same document
+* MD026 - Trailing punctuation in header
+* MD027 - Multiple spaces after blockquote symbol
+* MD028 - Blank line inside blockquote
+* MD029 - Ordered list item prefix
+* MD030 - Spaces after list markers

data/docs/RULES.md

@@ -53,7 +53,7 @@ The first header in the document should be a h1 header:
 
 Tags: headers
 
-Parameters: style
+Parameters: style ("consistent", "atx", "atx_closed", "setext"; default "consistent")
 
 This rule is triggered when different header styles (atx, setext, and 'closed'
 atx) are used in the same document:
@@ -79,7 +79,7 @@ document.
 
 Tags: bullet, ul
 
-Parameters: style
+Parameters: style ("consistent", "asterisk", "plus", "dash"; default "consistent")
 
 This rule is triggered when the symbols used in the document for unordered
 list items do not match the configured unordered list style:
@@ -149,7 +149,7 @@ characters if you use 4 space tabs, or 1 character if you use 2 space tabs).
 
 Tags: bullet, ul, indentation
 
-Parameters: indent
+Parameters: indent (number; default 2)
 
 This rule is triggered when list items are not indented by the configured
 number of spaces (default: 2).
@@ -182,9 +182,20 @@ for a description of the problem.
 
 Tags: whitespace
 
+Parameters: br_spaces (number; default: 0)
+
 This rule is triggered on any lines that end with whitespace. To fix this,
 find the line that is triggered and remove any trailing spaces from the end.
 
+The br_spaces parameter allows an exception to this rule for a specific amount
+of trailing spaces used to insert an explicit line break/br element. For
+example, set br_spaces to 2 to allow exactly 2 spaces at the end of a line.
+
+Note: you have to set br_spaces to 2 or higher for this exception to take
+effect - you can't insert a br element with just a single trailing space, so
+if you set br_spaces to 1, the exception will be disabled, just as if it was
+set to the default of 0.
+
 ## MD010 - Hard tabs
 
 Tags: whitespace, hard_tab
@@ -244,7 +255,7 @@ lines inside code blocks.
 
 Tags: line_length
 
-Parameters: line_length
+Parameters: line_length (number; default 80)
 
 This rule is triggered when there are lines that are longer than the
 configured line length (default: 80 characters). To fix this, split the line
@@ -463,7 +474,7 @@ should be contained within this header.
 
 Tags: headers
 
-Parameters: punctuation
+Parameters: punctuation (string; default ".,;:!?")
 
 This rule is triggered on any header that has a punctuation character as the
 last character in the line:
@@ -531,7 +542,7 @@ separate blockquotes.
 
 Tags: ol
 
-Parameters: style
+Parameters: style ("one", "ordered"; default "one")
 
 This rule is triggered on ordered lists that do not either start with '1.' or
 do not have a prefix that increases in numerical order (depending on the
@@ -553,7 +564,7 @@ Example valid list if the style is configured as 'ordered':
 
 Tags: ol, ul, whitespace
 
-Parameters: ul_single, ol_single, ul_multi, ol_multi
+Parameters: ul_single, ol_single, ul_multi, ol_multi (number, default 1)
 
 This rule checks for the number of spaces between a list marker (e.g. '`-`',
 '`*`', '`+`' or '`1.`') and the text of the list item.
@@ -682,3 +693,182 @@ items with hanging indents are okay:
 
     * This is
       okay
+
+## MD033 - Inline HTML
+
+Tags: html
+
+This rule is triggered whenever raw HTML is used in a markdown document:
+
+    <h1>Inline HTML header</h1>
+
+To fix this, use 'pure' markdown instead of including raw HTML:
+
+    # Markdown header
+
+Rationale: Raw HTML is allowed in markdown, but this rule is included for
+those who want their documents to only include "pure" markdown, or for those
+who are rendering markdown documents in something other than HTML.
+
+## MD034 - Bare URL used
+
+Tags: links, url
+
+This rule is triggered whenever a URL is given that isn't surrounded by angle
+brackets:
+
+    For more information, see http://www.example.com/.
+
+To fix this, add angle brackets around the URL:
+
+    For more information, see <http://www.example.com/>.
+
+Rationale: Without angle brackets, the URL isn't converted into a link in many
+markdown parsers.
+
+Note: if you do want a bare URL without it being converted into a link,
+enclose it in a code block, otherwise in some markdown parsers it _will_ be
+converted:
+
+    `http://www.example.com`
+
+## MD035 - Horizontal rule style
+
+Tags: hr
+
+Parameters: style ("consistent", "---", "***", or other string specifying the
+horizontal rule; default "consistent")
+
+This rule is triggered when inconsistent styles of horizontal rules used in
+the document:
+
+    ---
+
+    - - -
+
+    ***
+
+    * * *
+
+    ****
+
+To fix this, ensure any horizontal rules used in the document are consistent,
+or match the given style if the rule is so configured:
+
+    ---
+
+    ---
+
+Note: by default, this rule is configured to just require that all horizontal
+rules in the document are the same, and will trigger if any of the horizontal
+rules are different than the first one encountered in the document. If you
+want to configure the rule to match a specific style, the parameter given to
+the 'style' option is a string containing the exact horizontal rule text that
+is allowed.
+
+## MD036 - Emphasis used instead of a header
+
+Tags: headers, emphasis
+
+This check looks for instances where emphasized (i.e. bold or italic) text is
+used to separate sections, where a header should be used instead:
+
+    **My document**
+
+    Lorem ipsum dolor sit amet...
+
+    _Another section_
+
+    Consectetur adipiscing elit, sed do eiusmod.
+
+To fix this, use markdown headers instead of emphasized text to denote
+sections:
+
+    # My document
+
+    Lorem ipsum dolor sit amet...
+
+    ## Another section
+
+    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.
+
+## MD037 - Spaces inside emphasis markers
+
+Tags: whitespace, emphasis
+
+This rule is triggered when emphasis markers (bold, italic) are used, but they
+have spaces between the markers and the text:
+
+    Here is some ** bold ** text.
+
+    Here is some * italic * text.
+
+    Here is some more __ bold __ text.
+
+    Here is some more _ italic _ text.
+
+To fix this, remove the spaces around the emphasis markers:
+
+    Here is some **bold** text.
+
+    Here is some *italic* text.
+
+    Here is some more __bold__ text.
+
+    Here is some more _italic_ text.
+
+Rationale: Emphasis is only parsed as such when the asterisks/underscores
+aren't completely surrounded by spaces. This rule attempts to detect where
+they were surrounded by spaces, but it appears that emphasized text was
+intended by the author.
+
+## MD038 - Spaces inside code span elements
+
+Tags: whitespace, code
+
+This rule is triggered on code span elements that have spaces right inside the
+backticks:
+
+    ` some text `
+
+    `some text `
+
+    ` some text`
+
+To fix this, remove the spaces inside the codespan markers:
+
+    `some text`
+
+## MD039 - Spaces inside link text
+
+Tags: whitespace, links
+
+This rule is triggered on links that have spaces surrounding the link text:
+
+    [ a link ](http://www.example.com/)
+
+To fix this, remove the spaces surrounding the link text:
+
+    [a link](http://www.example.com/)
+
+## MD040 - Fenced code blocks should have a language specified
+
+Tags: code, language
+
+This rule is triggered when fenced code blocks are used, but a language isn't
+specified:
+
+    ```
+    #!/bin/bash
+    echo Hello world
+    ```
+
+To fix this, add a language specifier to the code block:
+
+    ```bash
+    #!/bin/bash
+    echo Hello world
+    ```

data/docs/configuration.md

@@ -42,19 +42,23 @@ instead, and ignore any files git doesn't know about.
 
 Tags - Limit the rules mdl enables to those containing the provided tags.
 
-* Command line: `-t tag1,tag2`, `--tags tag1,tag2`
+* Command line: `-t tag1,tag2`, `--tags tag1,tag2`, `-t ~tag1,~tag2`
 * Config file: `tags "tag1", "tag2"`
 * Default: process all rules (no tag limit)
 
 Rules - Limit the rules mdl enables to those provided in this option.
 
-* Command line: `-r MD001,MD002`, `--rules MD001,MD002`
+* Command line: `-r MD001,MD002`, `--rules MD001,MD002`, `-r ~MD001,~MD002`
 * Config file: `rules "MD001", "MD002"`
 * Default: process all rules (no rule limit)
 
+If a rule or tag ID is preceded by a tilde (`~`), then it _disables_ the
+matching rules instead of enabling them, starting with all rules being enabled.
+
 Note: if both `--rules` and `--tags` are provided, then a given rule has to
 both be in the list of enabled rules, as well as be tagged with one of the
-tags provided with the `--tags` option.
+tags provided with the `--tags` option. Use the `-l/--list-rules` option to
+test this behavior.
 
 Style - Select which style mdl uses. A 'style' is a file containing a list of
 enabled/disable rules, as well as options for some rules that take them. For

data/docs/rolling_a_release.md

@@ -12,6 +12,29 @@ Bump the version. Markdownlint uses semantic versioning. From
 To bump the version, edit `lib/mdl/version.rb` and commit to the master
 branch.
 
+Update the changelog:
+
+* Add a new header and 'full changelog' link for the new release:
+
+        ## [v0.2.0](https://github.com/mivok/markdownlint/tree/v0.2.0) (2015-04-13)
+
+        [Full Changelog](https://github.com/mivok/markdownlint/compare/v0.1.0...v0.2.0)
+
+* Add an 'Rules added' section, listing every new rule added for this version.
+  * 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>
+  * Search for `is:closed closed:>1900-01-01`, changing the date to the date
+    of the last release.
+  * From this list of issues, make sections for:
+    * Enhancements implemented
+    * Bugs fixed
+* Search for merged pull requests:
+  * Search for `is:pull-request  merged:>1900-01-01`
+  * Add an entry for each merged pull request:
+    * `[Title - author](https://github.com/mivok/markdownlint/pull/NN)`
+
 Next, run `rake release`. This will:
 
 * Tag vX.Y.Z in git and push it.

data/lib/mdl.rb

@@ -13,11 +13,21 @@ module MarkdownLint
     cli = MarkdownLint::CLI.new
     cli.run
     rules = RuleSet.load_default
-    style = Style.load(Config[:style], rules)
+    Style.load(Config[:style], rules)
     # Rule option filter
-    rules.select! {|r| Config[:rules].include?(r) } if Config[:rules]
+    if Config[:rules]
+      rules.select! {|r| Config[:rules][:include].include?(r) } \
+        unless Config[:rules][:include].empty?
+      rules.select! {|r| not Config[:rules][:exclude].include?(r) } \
+        unless Config[:rules][:exclude].empty?
+    end
     # Tag option filter
-    rules.select! {|r, v| not (v.tags & Config[:tags]).empty? } if Config[:tags]
+    if Config[:tags]
+      rules.select! {|r, v| not (v.tags & Config[:tags][:include]).empty? } \
+        unless Config[:tags][:include].empty?
+      rules.select! {|r, v| (v.tags & Config[:tags][:exclude]).empty? } \
+        unless Config[:tags][:exclude].empty?
+    end
 
     if Config[:list_rules]
       puts "Enabled rules:"
@@ -34,7 +44,6 @@ module MarkdownLint
     # Recurse into directories
     cli.cli_arguments.each_with_index do |filename, i|
       if Dir.exist?(filename)
-        pattern = "#{filename}/**/*.md" # This works for both Dir and ls-files
         if Config[:git_recurse]
           Dir.chdir(filename) do
             cli.cli_arguments[i] = %x(git ls-files '*.md').split("\n")

data/lib/mdl/cli.rb

@@ -28,13 +28,13 @@ module MarkdownLint
       :short => '-t',
       :long => '--tags TAG1,TAG2',
       :description => 'Only process rules with these tags',
-      :proc => Proc.new { |v| v.split(',').map { |t| t.to_sym } }
+      :proc => Proc.new { |v| toggle_list(v, true) }
 
     option :rules,
       :short => '-r',
       :long => '--rules RULE1,RULE2',
       :description => 'Only process these rules',
-      :proc => Proc.new { |v| v.split(',') }
+      :proc => Proc.new { |v| toggle_list(v) }
 
     option :style,
       :short => '-s',
@@ -85,5 +85,16 @@ module MarkdownLint
         cli_arguments << "-"
       end
     end
+
+    def self.toggle_list(s, to_sym=false)
+      parts = s.split(',')
+      inc = parts.select{|p| not p.start_with?('~')}
+      exc = parts.select{|p| p.start_with?('~')}.map{|p| p[1..-1]}
+      if to_sym
+        inc.map!{|p| p.to_sym}
+        exc.map!{|p| p.to_sym}
+      end
+      {:include => inc, :exclude => exc}
+    end
   end
 end

data/lib/mdl/doc.rb

@@ -84,6 +84,33 @@ module MarkdownLint
       results
     end
 
+    ##
+    # A variation on find_type_elements that allows you to skip drilling down
+    # into children of specific element types.
+    #
+    # Instead of a single type, a list of types can be provided instead to
+    # find all types.
+    #
+    # Unlike find_type_elements, this method will always search for nested
+    # elements, and skip the element types given to nested_except.
+
+    def find_type_elements_except(type, nested_except=[], elements=@elements)
+      results = []
+      if type.class == Symbol
+        type = [type]
+      end
+      if nested_except.class == Symbol
+        nested_except = [nested_except]
+      end
+      elements.each do |e|
+        results.push(e) if type.include?(e.type)
+        unless nested_except.include?(e.type) or e.children.empty?
+          results.concat(find_type_elements_except(type, nested_except, e.children))
+        end
+      end
+      results
+    end
+
     ##
     # Returns the line number a given element is located on in the source
     # file. You can pass in either an element object or an options hash here.
@@ -186,9 +213,9 @@ module MarkdownLint
     # Returns line numbers for lines that match the given regular expression.
     # Only considers text inside of 'text' elements (i.e. regular markdown
     # text and not code/links or other elements).
-    def matching_text_element_lines(re)
+    def matching_text_element_lines(re, exclude_nested=[:a])
       matches = []
-      find_type_elements(:text).each do |e|
+      find_type_elements_except(:text, exclude_nested).each do |e|
         first_line = e.options[:location]
         lines = e.value.split("\n")
         lines.each_with_index do |l, i|

data/lib/mdl/rules.rb

@@ -115,8 +115,13 @@ end
 
 rule "MD009", "Trailing spaces" do
   tags :whitespace
+  params :br_spaces => 0
   check do |doc|
-    doc.matching_lines(/\s$/)
+    errors = doc.matching_lines(/\s$/)
+    if params[:br_spaces] > 1
+      errors -= doc.matching_lines(/\S\s{#{params[:br_spaces]}}$/)
+    end
+    errors
   end
 end
 
@@ -442,3 +447,86 @@ rule "MD032", "Lists should be surrounded by blank lines" do
     errors.uniq
   end
 end
+
+rule "MD033", "Inline HTML" do
+  tags :html
+  check do |doc|
+    doc.element_linenumbers(doc.find_type(:html_element))
+  end
+end
+
+rule "MD034", "Bare URL used" do
+  tags :links, :url
+  check do |doc|
+    doc.matching_text_element_lines(/https?:\/\//)
+  end
+end
+
+rule "MD035", "Horizontal rule style" do
+  tags :hr
+  params :style => :consistent
+  check do |doc|
+    hrs = doc.find_type(:hr)
+    if hrs.empty?
+      []
+    else
+      if params[:style] == :consistent
+        doc_style = doc.element_line(hrs[0])
+      else
+        doc_style = params[:style]
+      end
+      doc.element_linenumbers(hrs.select{|e| doc.element_line(e) != doc_style})
+    end
+  end
+end
+
+rule "MD036", "Emphasis used instead of a header" do
+  tags :headers, :emphasis
+  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)})
+  end
+end
+
+rule "MD037", "Spaces inside emphasis markers" do
+  tags :whitespace, :emphasis
+  check do |doc|
+    # Kramdown doesn't parse emphasis with spaces, which means we can just
+    # look for emphasis patterns inside regular text with spaces just inside
+    # them.
+    (doc.matching_text_element_lines(/(\*\*?|__?)\s.+\1/) | \
+      doc.matching_text_element_lines(/(\*\*?|__?).+\s\1/)).sort
+  end
+end
+
+rule "MD038", "Spaces inside code span elements" do
+  tags :whitespace, :code
+  check do |doc|
+    # We only want to check single line codespan elements and not fenced code
+    # block that happen to be parsed as code spans.
+    doc.element_linenumbers(doc.find_type_elements(:codespan).select{
+      |i| i.value.match(/(^\s|\s$)/) and not i.value.include?("\n")})
+  end
+end
+
+rule "MD039", "Spaces inside link text" do
+  tags :whitespace, :links
+  check do |doc|
+    doc.element_linenumbers(doc.find_type_elements(:a).select{|e|
+      e.children[0].value.start_with?(" ") or
+      e.children[0].value.end_with?(" ")})
+  end
+end
+
+rule "MD040", "Fenced code blocks should have a language specified" do
+  tags :code, :language
+  check do |doc|
+    # Kramdown parses code blocks with language settings as code blocks with
+    # the class attribute set to language-languagename.
+    doc.element_linenumbers(doc.find_type_elements(:codeblock).select{|i|
+      not i.attr['class'].to_s.start_with?("language-") and
+        not doc.element_line(i).start_with?("    ")})
+  end
+end

data/lib/mdl/styles/cirosantilli.rb

@@ -4,3 +4,8 @@ rule 'MD003', :style => :atx
 rule 'MD004', :style => :dash
 rule 'MD007', :indent => 4
 rule 'MD030', :ul_multi => 3, :ol_multi => 2
+rule 'MD035', :style => "---"
+
+# Inline HTML - this isn't forbidden by the style guide, and raw HTML use is
+# explicitly mentioned in the 'email automatic links' section.
+exclude_rule 'MD033'

data/lib/mdl/styles/default.rb

@@ -1 +1,3 @@
 all
+
+exclude_rule 'MD040' # Fenced code blocks should have a language specified

data/lib/mdl/styles/relaxed.rb

@@ -4,3 +4,6 @@ exclude_tag :line_length
 
 exclude_rule 'MD006' # Lists at beginning of line
 exclude_rule 'MD007' # List indentation
+exclude_rule 'MD033' # Inline HTML
+exclude_rule 'MD034' # Bare URL used
+exclude_rule 'MD040' # Fenced code blocks should have a language specified

data/lib/mdl/version.rb

@@ -1,3 +1,3 @@
 module MarkdownLint
-  VERSION = "0.1.0"
+  VERSION = "0.2.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/mdl"
+  spec.homepage      = "http://github.com/mivok/markdownlint"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/test/rule_tests/code_block_dollar.md

@@ -29,5 +29,5 @@ The following code block doesn't have any dollar signs, and shouldn't fire:
 The following (fenced) code block doesn't have any content at all, and
 shouldn't fire:
 
-```
+```bash
 ```

data/test/rule_tests/emphasis_instead_of_headers.md

@@ -0,0 +1,35 @@
+**Section 1: the first section {MD036}**
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore
+eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt
+in culpa qui officia deserunt mollit anim id est laborum.
+
+__Section 1.1: another section {MD036}__
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore
+eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt
+in culpa qui officia deserunt mollit anim id est laborum.
+
+*Section 2: yet more sections {MD036}*
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore
+eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt
+in culpa qui officia deserunt mollit anim id est laborum.
+
+_Section 3: oh no more sections {MD036}_
+
+This is a normal paragraph
+**that just happens to have emphasized text in**
+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.

data/test/rule_tests/fenced_code_blocks.md

@@ -19,3 +19,9 @@ echo "World"
 ~~~
 
 None of the above should trigger any heading related rules.
+
+```
+Code block without a language specifier
+```
+
+{MD040:23}

data/test/rule_tests/fenced_code_without_blank_lines_style.rb

@@ -0,0 +1,2 @@
+all
+exclude_rule "MD040"

data/test/rule_tests/hr_style_dashes.md

@@ -0,0 +1,22 @@
+***
+
+* * *
+
+*****
+
+---
+
+- - -
+
+-----
+
+___
+
+_ _ _
+
+_____
+
+***
+
+{MD035:1} {MD035:3} {MD035:5} {MD035:9} {MD035:11} {MD035:13} {MD035:15}
+{MD035:17} {MD035:19}

data/test/rule_tests/hr_style_dashes_style.rb

@@ -0,0 +1,2 @@
+all
+rule "MD035", :style => "---"

data/test/rule_tests/hr_style_inconsistent.md

@@ -0,0 +1,22 @@
+***
+
+* * *
+
+*****
+
+---
+
+- - -
+
+-----
+
+___
+
+_ _ _
+
+_____
+
+***
+
+{MD035:3} {MD035:5} {MD035:7} {MD035:9} {MD035:11} {MD035:13} {MD035:15}
+{MD035:17}

data/test/rule_tests/hr_style_long.md

@@ -0,0 +1,22 @@
+***
+
+* * *
+
+*****
+
+---
+
+- - -
+
+-----
+
+___
+
+_ _ _
+
+_____
+
+***
+
+{MD035:1} {MD035:3} {MD035:5} {MD035:7} {MD035:9} {MD035:11} {MD035:13}
+{MD035:15} {MD035:19}

data/test/rule_tests/hr_style_long_style.rb

@@ -0,0 +1,2 @@
+all
+rule "MD035", :style => "_____"

data/test/rule_tests/hr_style_stars.md

@@ -0,0 +1,22 @@
+***
+
+* * *
+
+*****
+
+---
+
+- - -
+
+-----
+
+___
+
+_ _ _
+
+_____
+
+***
+
+{MD035:3} {MD035:5} {MD035:7} {MD035:9} {MD035:11} {MD035:13} {MD035:15}
+{MD035:17}

data/test/rule_tests/hr_style_stars_style.rb

@@ -0,0 +1,2 @@
+all
+rule "MD035", :style => "***"

data/test/rule_tests/inline_html.md

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

@@ -0,0 +1,9 @@
+# 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/reversed_link.md

@@ -1,4 +1,4 @@
-Go to (this website)[http://www.example.com] {MD011}
+Go to (this website)[http://www.example.com] {MD011} {MD034}
 
 However, this shouldn't trigger inside code blocks:
 

data/test/rule_tests/spaces_inside_codespan_elements.md

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

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

data/test/rule_tests/spaces_inside_link_text.md

@@ -0,0 +1,7 @@
+[foo](http://bar/)
+
+[foo ](http://bar/) {MD039}
+
+[ foo](http://bar/) {MD039}
+
+[ foo ](http://bar/) {MD039}

data/test/rule_tests/trailing_spaces_br.md

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

@@ -0,0 +1,2 @@
+all
+rule 'MD009', :br_spaces => 2

data/test/test_ruledocs.rb

@@ -19,7 +19,7 @@ class TestRuledocs < Minitest::Test
         curr_rule = $1
       elsif l.match(/^Tags: (.*)$/)
         rules[curr_rule][:tags] = $1.split(',').map{|i| i.strip.to_sym}
-      elsif l.match(/^Parameters: (.*)$/)
+      elsif l.match(/^Parameters: (.*)(\(.*\)?)$/)
         rules[curr_rule][:params] = $1.split(',').map{|i| i.strip.to_sym}
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-22 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -136,6 +136,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -174,9 +175,11 @@ files:
 - 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/emphasis_instead_of_headers.md
 - test/rule_tests/empty_doc.md
 - test/rule_tests/fenced_code_blocks.md
 - test/rule_tests/fenced_code_without_blank_lines.md
+- test/rule_tests/fenced_code_without_blank_lines_style.rb
 - test/rule_tests/first_header_bad_atx.md
 - test/rule_tests/first_header_bad_setext.md
 - test/rule_tests/first_header_good_atx.md
@@ -192,6 +195,13 @@ files:
 - 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/hr_style_dashes.md
+- test/rule_tests/hr_style_dashes_style.rb
+- test/rule_tests/hr_style_inconsistent.md
+- test/rule_tests/hr_style_long.md
+- test/rule_tests/hr_style_long_style.rb
+- test/rule_tests/hr_style_stars.md
+- test/rule_tests/hr_style_stars_style.rb
 - 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
@@ -208,6 +218,8 @@ files:
 - 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/inline_html.md
+- test/rule_tests/links.md
 - test/rule_tests/lists_without_blank_lines.md
 - test/rule_tests/long_lines.md
 - test/rule_tests/long_lines_100.md
@@ -221,14 +233,19 @@ files:
 - 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/rule_tests/spaces_inside_codespan_elements.md
+- test/rule_tests/spaces_inside_emphasis_markers.md
+- test/rule_tests/spaces_inside_link_text.md
+- test/rule_tests/trailing_spaces_br.md
+- test/rule_tests/trailing_spaces_br_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
+homepage: http://github.com/mivok/markdownlint
 licenses:
 - MIT
 metadata: {}
@@ -266,9 +283,11 @@ test_files:
 - 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/emphasis_instead_of_headers.md
 - test/rule_tests/empty_doc.md
 - test/rule_tests/fenced_code_blocks.md
 - test/rule_tests/fenced_code_without_blank_lines.md
+- test/rule_tests/fenced_code_without_blank_lines_style.rb
 - test/rule_tests/first_header_bad_atx.md
 - test/rule_tests/first_header_bad_setext.md
 - test/rule_tests/first_header_good_atx.md
@@ -284,6 +303,13 @@ test_files:
 - 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/hr_style_dashes.md
+- test/rule_tests/hr_style_dashes_style.rb
+- test/rule_tests/hr_style_inconsistent.md
+- test/rule_tests/hr_style_long.md
+- test/rule_tests/hr_style_long_style.rb
+- test/rule_tests/hr_style_stars.md
+- test/rule_tests/hr_style_stars_style.rb
 - 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
@@ -300,6 +326,8 @@ test_files:
 - 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/inline_html.md
+- test/rule_tests/links.md
 - test/rule_tests/lists_without_blank_lines.md
 - test/rule_tests/long_lines.md
 - test/rule_tests/long_lines_100.md
@@ -313,7 +341,13 @@ test_files:
 - 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/rule_tests/spaces_inside_codespan_elements.md
+- test/rule_tests/spaces_inside_emphasis_markers.md
+- test/rule_tests/spaces_inside_link_text.md
+- test/rule_tests/trailing_spaces_br.md
+- test/rule_tests/trailing_spaces_br_style.rb
+- test/rule_tests/whitespace_issues.md
 - test/setup_tests.rb
 - test/test_ruledocs.rb
 - test/test_rules.rb
+has_rdoc: