mdl 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 936be64bf79d5bead9ce46cc5f259a4e7d011084
-  data.tar.gz: b31fb00915f2b8b3a400758a6d08c273138523eb
+  metadata.gz: e51fd852e7791bcde9513e139c43c93fc0377ec3
+  data.tar.gz: d566428c48d875eb1bd0f89e4cdff094f50a23d6
 SHA512:
-  metadata.gz: e29b0812ef5eff2cebe992da2dcb9887197d59756ccfc2443adeadfb67ec2a3d7a03d3c129f794f804808705208d26271af0414ebfbe631d028c346c43cda806
-  data.tar.gz: edf20cb26c6d61cb735b264e9798ab9abe6347374efcef73221408d2d97b44980530e90a4fcd9fba0c309cdefbcc77c08344147b4a0fb48cfc44bbc1ab30927f
+  metadata.gz: dd7a9864461857232915798e54111bfeaf3cc957b53fed0dc74bc28e94496e13616f91be2e2b930f38fcbb1581108f8e41e4dd5e642eb6f2cd411becb31376a8
+  data.tar.gz: d561fd970ab869fb6a43780e19b20d861e4f46a48e891bfc9e5e99c464afcfc0295715e22f2c2986ca0b70f91c7b0b3b41b660519586d5ffa3eed705f63f9527

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
-rvm:
-  - "1.9.2"
-  - "2.1.0"
-  - "2.1.6"
-  - "2.3.0"
-  - jruby-19mode # JRuby in 1.9 mode
+
+matrix:
+  include:
+    - rvm: 2.1.10
+    - rvm: 2.2.5
+    - rvm: 2.3.1
+    - rvm: jruby-9.1.2.0
+      env: JRUBY_OPTS="--dev"

data/CHANGELOG.md

@@ -1,28 +1,36 @@
 # Change Log
 
-## [v0.3.1](https://github.com/mivok/markdownlint/tree/v0.3.1) (2016-03-20)
+## [v0.4.0] (2016-08-22)
 
-[Full Changelog](https://github.com/mivok/markdownlint/compare/v0.3.0...v0.3.1)
+### Added
 
-### Bugs fixed
+* Ignore yaml front matter option (#130, #143)
 
-* Fix error on starting mdl
+### Changed
+
+* Allow top level header rules (MD002, MD025, MD041) to be configurable (#142)
 
-## [v0.3.0](https://github.com/mivok/markdownlint/tree/v0.3.0) (2016-03-19)
+### Fixed
 
-[Full Changelog](https://github.com/mivok/markdownlint/compare/v0.2.1...v0.3.0)
+* Read UTF-8 files correctly even if locale is set to C (#135, #146, #147,
+  #148)
+* Fix issues loading .mdlrc file (#126, #129, #133, #148)
+* Fix erroneous triggering of MD022/MD023 in some cases (#144)
+* Detect codeblock lines correctly when ignoring them (#141)
 
-### Rules added/changed
+## [v0.3.1] (2016-03-20)
+
+### Fixed
+
+* Fix error on starting mdl
+
+## [v0.3.0] (2016-03-19)
+
+### Rules added
 
 * MD041 - First line in file should be a top level header
-* MD003 - An additional header style, setext_with_atx, was added to require
-  setext style headers for levels 1 and 2, but allow atx style headers for
-  levels 3 and above (i.e. header levels that can't be expressed with setext
-  style headers)
-* MD013 - You now have the option to exclude code blocks and tables from the
-  line length limit check.
 
-### Enhancements implemented
+### 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)
@@ -33,7 +41,16 @@
   You can pass the `-a` option to display rule aliases instead of MDxxx rule
   IDs.
 
-### Bugs fixed
+### Changed
+
+* MD003 - An additional header style, setext_with_atx, was added to require
+  setext style headers for levels 1 and 2, but allow atx style headers for
+  levels 3 and above (i.e. header levels that can't be expressed with setext
+  style headers)
+* MD013 - You now have the option to exclude code blocks and tables from the
+  line length limit check.
+
+### Fixed
 
 * Crash with MD034 and pipe character (#93, #97)
 * MD031 failed on nested code blocks (#100, #109)
@@ -53,11 +70,9 @@
 * [MD013: allow excluding code blocks and tables - Loic
   Nageleisen](https://github.com/mivok/markdownlint/pull/112)
 
-## [v0.2.1](https://github.com/mivok/markdownlint/tree/v0.2.1) (2015-04-13)
-
-[Full Changelog](https://github.com/mivok/markdownlint/compare/v0.2.0...v0.2.1)
+## [v0.2.1] (2015-04-13)
 
-### Bugs fixed
+### Fixed
 
 * Incorrect parsing of rules/tags specification in .mdlrc (#81)
 * Exception on image links with MD039 (#82)
@@ -67,9 +82,7 @@
 
 * Exception on some lines with raw html list items in them (#83)
 
-## [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)
+## [v0.2.0] (2015-04-13)
 
 ### Rules added
 
@@ -82,7 +95,7 @@
 * MD039 - Spaces inside link text
 * MD040 - Fenced code blocks should have a language specified
 
-## Enhancements implemented
+## Added
 
 * Trailing spaces rule should allow an excemption for deliberate <br/\>
   insertion.
@@ -93,16 +106,14 @@
 
 * [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)
+## [v0.1.0] (2015-02-22)
 
 ### Rules added
 
 * MD031 - Fenced code blocks should be surrounded by blank lines
 * MD032 - Lists should be surrounded by blank lines
 
-### Bugs fixed
+### Fixed
 
 * MD014 triggers when it shouldn't
 
@@ -113,7 +124,7 @@
 * [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)
+## [v0.0.1] (2014-09-07)
 
 ### Rules added
 
@@ -143,3 +154,12 @@
 * MD028 - Blank line inside blockquote
 * 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

data/README.md

@@ -10,7 +10,7 @@ A tool to check markdown files and flag style issues.
 
 Markdownlint is written in ruby and is distributed as a rubygem. As long as
 you have a relatively up to date ruby on your system, markdownlint will be
-simple to install and use.
+simple to install and use. You have 2 options to install it:
 
 To install from rubygems, run:
 
@@ -22,6 +22,11 @@ To install the latest development version from github:
     cd markdownlint
     rake install
 
+
+Note that you will need [rake](https://github.com/ruby/rake)
+(`gem install rake`) and [bundler](https://github.com/bundler/bundler)
+(`gem install bundler`) in order to build from source.
+
 ## Usage
 
 To have markdownlint check your markdown files, simply run `mdl` with the
@@ -74,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/mivok/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

@@ -35,12 +35,14 @@ level at a time:
     ### Another Header 3
 
 
-## MD002 - First header should be a h1 header
+## MD002 - First header should be a top level header
 
 Tags: headers
 
 Aliases: first-header-h1
 
+Parameters: level (number; default 1)
+
 This rule is triggered when the first header in the document isn't a h1 header:
 
     ## This isn't a H1 header
@@ -506,6 +508,8 @@ Tags: headers
 
 Aliases: single-h1
 
+Parameters: level (number; default 1)
+
 This rule is triggered when a top level header is in use (the first line of
 the file is a h1 header), and more than one h1 header is in use in the
 document:
@@ -529,6 +533,9 @@ serves as the title for the document. If this convention is in use, then there
 can not be more than one title for the document, and the entire document
 should be contained within this header.
 
+Note: The `level` parameter can be used to change the top level (ex: to h2) in
+cases where an h1 is added externally.
+
 ## MD026 - Trailing punctuation in header
 
 Tags: headers
@@ -968,6 +975,8 @@ Tags: headers
 
 Aliases: first-line-h1
 
+Parameters: level (number; default 1)
+
 This rule is triggered when the first line in the file isn't a top level (h1)
 header:
 
@@ -982,3 +991,6 @@ To fix this, add a header to the top of your file:
 
     This is a file with a top level header
     ```
+
+Note: The `level` parameter can be used to change the top level (ex: to h2) in
+cases where an h1 is added externally.

data/docs/configuration.md

@@ -39,6 +39,16 @@ instead, and ignore any files git doesn't know about.
 * Config file: `git_recurse true`
 * Default: false
 
+Ignore YAML front matter - if this option is enabled markdownlint will ignore
+content within valid
+[YAML front matter](https://jekyllrb.com/docs/frontmatter/). Reported line
+numbers will still match the file contents but markdownlint will consider the
+line following front matter to be the first line.
+
+* Command line: `-i`, `--ignore-front-matter`
+* Config file: `ignore-front-matter true`
+* Default: false
+
 ### Specifying which rules mdl processes
 
 Tags - Limit the rules mdl enables to those containing the provided tags.

data/docs/rolling_a_release.md

@@ -14,28 +14,36 @@ branch.
 
 Update the changelog:
 
-* Add a new header and 'full changelog' link for the new release:
+* Add a new header and link for the new release, replacing any 'Unreleased'
+  header.
 
-        ## [v0.2.0](https://github.com/mivok/markdownlint/tree/v0.2.0) (2015-04-13)
+        ## [v0.2.0] (2015-04-13)
 
-        [Full Changelog](https://github.com/mivok/markdownlint/compare/v0.1.0...v0.2.0)
+        This goes at the bottom:
 
-* Add an 'Rules added' section, listing every new rule added for this version.
+        [v0.2.0]: https://github.com/mivok/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
+  release to catch anything that was missed.
+* Add a '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
+  * Search for `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)`
+    * Added - for new features
+    * Changed - for changes in existing functionality
+    * Deprecated - for once-stable features removed in upcoming releases
+    * Removed - for deprecated features removed in this release
+    * Fixed - for any bug fixes
+    * Security - for any security issues
 
 Next, run `rake release`. This will:
 
 * Tag vX.Y.Z in git and push it.
 * Upload the new gem to rubygems.org
+
+Finally, add a new 'Unreleased' section to the changelog for the next release.

data/lib/mdl.rb

@@ -71,7 +71,7 @@ module MarkdownLint
     status = 0
     cli.cli_arguments.each do |filename|
       puts "Checking #{filename}..." if Config[:verbose]
-      doc = Doc.new_from_file(filename)
+      doc = Doc.new_from_file(filename, Config[:ignore_front_matter])
       filename = '(stdin)' if filename == "-"
       if Config[:show_kramdown_warnings]
         status = 2 if not doc.parsed.warnings.empty?
@@ -85,6 +85,7 @@ module MarkdownLint
         next if error_lines.nil? or error_lines.empty?
         status = 1
         error_lines.each do |line|
+          line += doc.offset # Correct line numbers for any yaml front matter
           if Config[:show_aliases]
             puts "#{filename}:#{line}: #{rule.aliases.first || id} #{rule.description}"
           else

data/lib/mdl/cli.rb

@@ -27,6 +27,12 @@ module MarkdownLint
       :description => 'Increase verbosity',
       :boolean => true
 
+    option :ignore_front_matter,
+      :short => '-i',
+      :long => '--[no-]ignore-front-matter',
+      :boolean => true,
+      :description => 'Ignore YAML front matter'
+
     option :show_kramdown_warnings,
       :short => '-w',
       :long => '--[no-]warnings',
@@ -97,13 +103,14 @@ module MarkdownLint
 
       # Load the config file if it's present
       filename = CLI.probe_config_file(config[:config_file])
+
       # Only fall back to ~/.mdlrc if we are using the default value for -c
       if filename.nil? and config[:config_file] == CONFIG_FILE
         filename = File.expand_path("~/#{CONFIG_FILE}")
       end
 
       if not filename.nil? and File.exist?(filename)
-        MarkdownLint::Config.from_file(filename)
+        MarkdownLint::Config.from_file(filename.to_s)
         if config[:verbose]
           puts "Loaded config from #{filename}"
         end
@@ -147,15 +154,15 @@ module MarkdownLint
     end
 
     def self.probe_config_file(path)
-      # Probe up only for plain filenames
-      if path != File.basename(path)
-        return File.expand_path(path)
-      end
+      expanded_path = File.expand_path(path)
+      return expanded_path if File.exist?(expanded_path)
 
       # Look for a file up from the working dir
-      Pathname.new(path).ascend do |p|
+      Pathname.new(expanded_path).ascend do |p|
+        next unless p.directory?
+
         config_file = p.join(CONFIG_FILE)
-        return config_file if File.exist?(CONFIG_FILE)
+        return config_file if File.exist?(config_file)
       end
       nil
     end

data/lib/mdl/doc.rb

@@ -24,10 +24,23 @@ module MarkdownLint
 
     attr_reader :elements
 
+    ##
+    # The line number offset which is greater than zero when the
+    # markdown file contains YAML front matter that should be ignored.
+
+    attr_reader :offset
+
     ##
     # Create a new document given a string containing the markdown source
 
-    def initialize(text)
+    def initialize(text, ignore_front_matter = false)
+      regex = /^---\n(.*?)---\n/m
+      if ignore_front_matter and regex.match(text)
+        @offset = regex.match(text).to_s.split("\n").length
+        text.sub!(regex,'')
+      else
+        @offset = 0
+      end
       @lines = text.split("\n")
       @parsed = Kramdown::Document.new(text, :input => 'MarkdownLint')
       @elements = @parsed.root.children
@@ -37,11 +50,11 @@ module MarkdownLint
     ##
     # Alternate 'constructor' passing in a filename
 
-    def self.new_from_file(filename)
+    def self.new_from_file(filename, ignore_front_matter = false)
       if filename == "-"
-        self.new(STDIN.read)
+        self.new(STDIN.read, ignore_front_matter)
       else
-        self.new(File.read(filename))
+        self.new(File.read(filename, encoding: 'UTF-8'), ignore_front_matter)
       end
     end
 

data/lib/mdl/rules.rb

@@ -15,12 +15,13 @@ rule "MD001", "Header levels should only increment by one level at a time" do
   end
 end
 
-rule "MD002", "First header should be a h1 header" do
+rule "MD002", "First header should be a top level header" do
   tags :headers
   aliases 'first-header-h1'
+  params :level => 1
   check do |doc|
     first_header = doc.find_type(:header).first
-    [first_header[:location]] if first_header and first_header[:level] != 1
+    [first_header[:location]] if first_header and first_header[:level] != @params[:level]
   end
 end
 
@@ -164,7 +165,7 @@ rule "MD012", "Multiple consecutive blank lines" do
     # inside of a code block are acceptable.
     codeblock_lines = doc.find_type_elements(:codeblock).map{
       |e| (doc.element_linenumber(e)..
-           doc.element_linenumber(e) + e.value.count('\n') - 1).to_a }.flatten
+           doc.element_linenumber(e) + e.value.lines.count).to_a }.flatten
     blank_lines = doc.matching_lines(/^\s*$/)
     cons_blank_lines = blank_lines.each_cons(2).select{
       |p, n| n - p == 1}.map{|p, n| n}
@@ -180,7 +181,7 @@ rule "MD013", "Line length" do
     # Every line in the document that is part of a code block.
     codeblock_lines = doc.find_type_elements(:codeblock).map{
       |e| (doc.element_linenumber(e)..
-           doc.element_linenumber(e) + e.value.count('\n') - 1).to_a }.flatten
+           doc.element_linenumber(e) + e.value.lines.count).to_a }.flatten
     # Every line in the document that is part of a table.
     locations = doc.elements
                 .map { |e| [e.options[:location], e] }
@@ -272,7 +273,7 @@ rule "MD022", "Headers should be surrounded by blank lines" do
     # Kramdown requires that headers start on a block boundary, so in most
     # cases it won't pick up a header without a blank line before it. We need
     # to check regular text and pick out headers ourselves too
-    doc.find_type_elements(:p).each do |p|
+    doc.find_type_elements(:p, false).each do |p|
       linenum = doc.element_linenumber(p)
       text = p.children.select { |e| e.type == :text }.map {|e| e.value }.join
       lines = text.split("\n")
@@ -307,7 +308,7 @@ rule "MD023", "Headers must start at the beginning of the line" do
     end
     # Next we have to look for things that aren't parsed as headers because
     # they start with spaces.
-    doc.find_type_elements(:p).each do |p|
+    doc.find_type_elements(:p, false).each do |p|
       linenum = doc.element_linenumber(p)
       lines = doc.extract_text(p)
       prev_line = ""
@@ -342,8 +343,9 @@ end
 rule "MD025", "Multiple top level headers in the same document" do
   tags :headers
   aliases 'single-h1'
+  params :level => 1
   check do |doc|
-    headers = doc.find_type(:header).select { |h| h[:level] == 1 }
+    headers = doc.find_type(:header).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
@@ -599,9 +601,10 @@ end
 rule "MD041", "First line in file should be a top level header" do
   tags :headers
   aliases 'first-line-h1'
+  params :level => 1
   check do |doc|
     first_header = doc.find_type(:header).first
     [1] if first_header.nil? or first_header[:location] != 1 \
-      or first_header[:level] != 1
+      or first_header[:level] != params[:level]
   end
 end

data/lib/mdl/version.rb

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

data/mdl.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.2'
 
-  spec.add_dependency 'kramdown', '~> 1.8', '>= 1.8.0'
-  spec.add_dependency 'mixlib-config', '~> 2.1', '>= 2.1.0'
-  spec.add_dependency 'mixlib-cli', '~> 1.5', '>= 1.5.0'
+  spec.add_dependency 'kramdown', '~> 1.12', '>= 1.12.0'
+  spec.add_dependency 'mixlib-config', '~> 2.2', '>= 2.2.1'
+  spec.add_dependency 'mixlib-cli', '~> 1.7', '>= 1.7.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 11.2'
+  spec.add_development_dependency 'minitest', '~> 5.9'
   spec.add_development_dependency 'pry', '~> 0.10'
 end

data/test/fixtures/front_matter/jekyll_post.md

@@ -0,0 +1,16 @@
+---
+layout: post
+title: Hello World!
+category: Meta
+tags:
+- tag
+- another tag
+- one more tag
+url: http://example.com
+excerpt: Hello World! Vestibulum imperdiet adipiscing arcu, quis aliquam dolor condimentum dapibus. Aliquam fermentum leo aliquet quam volutpat et molestie mauris mattis. Suspendisse semper consequat velit in suscipit.
+---
+# header1
+
+This is just a sample post.
+
+### offending header3

data/test/rule_tests/alternate_top_level_header.md

@@ -0,0 +1,3 @@
+## A level 2 top level header
+
+## Another one {MD025}

data/test/rule_tests/alternate_top_level_header_style.rb

@@ -0,0 +1,4 @@
+all
+rule 'MD002', :level => 2
+rule 'MD025', :level => 2
+rule 'MD041', :level => 2

data/test/rule_tests/headers_surrounding_space_atx.md

@@ -6,4 +6,7 @@ Some text
 Some text
 ## Header 4 {MD022}
 
-## Header 5
+## Header 5
+
+* This shouldn't trigger MD022, but did because of some bug where we tried to
+  #catch headers that kramdown didn't parse correctly.

data/test/rule_tests/headers_with_spaces_at_the_beginning.md

@@ -6,4 +6,15 @@ Some text
  ===================================
 
  Setext style title only indented {MD023}
-=========================================
+=========================================
+
+* Test situations in which MD023 shouldn't be triggered.
+
+  ```rb
+  # This shouldn't trigger MD023 as it is a code comment.
+  foo = "And here is some code"
+  ```
+
+* This is another case where MD023 shouldn't be triggered
+  # Test
+    # Test

data/test/rule_tests/long_lines_code.md

@@ -9,6 +9,13 @@ 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 |

data/test/test_cli.rb

@@ -1,51 +1,9 @@
 require_relative 'setup_tests'
 require 'open3'
 require 'set'
+require 'fileutils'
 
 class TestCli < Minitest::Test
-  def run_cli(args, stdin = "", mdlrc="default_mdlrc")
-    mdl_script = File.expand_path("../../bin/mdl", __FILE__)
-    # Load the mdlrc file from the text/fixtures/ directory
-    mdlrc = File.expand_path("../fixtures/#{mdlrc}", __FILE__)
-    result = {}
-    result[:stdout], result[:stderr], result[:status] = \
-      Open3.capture3(*(%W{bundle exec #{mdl_script} -c #{mdlrc}} + args.split),
-                    :stdin_data => stdin)
-    result[:status] = result[:status].exitstatus
-    result
-  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 test_help_text
     result = run_cli("--help")
     assert_match(/Usage: \S+ \[options\]/, result[:stdout])
@@ -65,12 +23,20 @@ class TestCli < Minitest::Test
   end
 
   def test_show_alias_processing_file
-    result = run_cli("-a -r MD002", "## header2")
+    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)
@@ -94,14 +60,14 @@ class TestCli < Minitest::Test
 
   def test_custom_ruleset_processing_success
     my_ruleset = File.expand_path("../fixtures/my_ruleset.rb", __FILE__)
-    result = run_cli("-du #{my_ruleset}", "Hello World")
+    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("-du #{my_ruleset}", "Goodbye world")
+    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])
@@ -111,7 +77,7 @@ class TestCli < Minitest::Test
     # 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("-dau #{my_ruleset}", "Goodbye world")
+    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])
@@ -157,27 +123,45 @@ class TestCli < Minitest::Test
   end
 
   def test_rule_inclusion_config
-    result = run_cli("-l", "", "mdlrc_enable_rules")
+    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("-l", "", "mdlrc_disable_rules")
-    assert_ran_ok(result)
-    assert_rules_disabled(result, ["MD001", "MD002"])
-    assert_rules_enabled(result, ["MD003", "MD004"])
+    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("-l", "", "mdlrc_enable_tags")
+    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("-l", "", "mdlrc_disable_tags")
+    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"])
@@ -202,4 +186,108 @@ class TestCli < Minitest::Test
     files_with_issues = result[:stdout].split("\n").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")
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdl
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Mark Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-20 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -16,102 +16,102 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: mixlib-config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.9'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -165,11 +165,14 @@ files:
 - test/fixtures/default_mdlrc
 - test/fixtures/dir_with_md_and_markdown/bar.markdown
 - test/fixtures/dir_with_md_and_markdown/foo.md
+- test/fixtures/front_matter/jekyll_post.md
 - test/fixtures/mdlrc_disable_rules
 - test/fixtures/mdlrc_disable_tags
 - test/fixtures/mdlrc_enable_rules
 - test/fixtures/mdlrc_enable_tags
 - test/fixtures/my_ruleset.rb
+- test/rule_tests/alternate_top_level_header.md
+- test/rule_tests/alternate_top_level_header_style.rb
 - test/rule_tests/atx_closed_header_spacing.md
 - test/rule_tests/atx_header_spacing.md
 - test/rule_tests/blockquote_blank_lines.md
@@ -289,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Markdown lint tool
@@ -297,11 +300,14 @@ test_files:
 - test/fixtures/default_mdlrc
 - test/fixtures/dir_with_md_and_markdown/bar.markdown
 - test/fixtures/dir_with_md_and_markdown/foo.md
+- test/fixtures/front_matter/jekyll_post.md
 - test/fixtures/mdlrc_disable_rules
 - test/fixtures/mdlrc_disable_tags
 - test/fixtures/mdlrc_enable_rules
 - test/fixtures/mdlrc_enable_tags
 - test/fixtures/my_ruleset.rb
+- test/rule_tests/alternate_top_level_header.md
+- test/rule_tests/alternate_top_level_header_style.rb
 - test/rule_tests/atx_closed_header_spacing.md
 - test/rule_tests/atx_header_spacing.md
 - test/rule_tests/blockquote_blank_lines.md
@@ -398,4 +404,3 @@ test_files:
 - test/test_cli.rb
 - test/test_ruledocs.rb
 - test/test_rules.rb
-has_rdoc: