mdl 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e214c7494f0a1796f51fea727bc16877f8b9aa82
-  data.tar.gz: 6342d6617202c3512dd2a0d721c321a0a9fa0edd
+  metadata.gz: 9b4aab66e36530dc982328a64e931370dcd484c9
+  data.tar.gz: 69c11c9027df69c408e9f854341a6e54412d2c1c
 SHA512:
-  metadata.gz: bad0ee00e294fc844d26a47964008ec31ecd62ac696daa2cd43b81183063ef5eb647237df26b0f9b455a741b6d77d77a6080ab7d7eb5aa9c9572748b9db75235
-  data.tar.gz: aa8a0269c402be1dd9ef0a0cdcfce900026c3726a73d8d2cc31b34080968c736131976e65386291088ed34ae6601f2958db1f4527ffdad76455b645691fea3c2
+  metadata.gz: 47a151052b1220aedefc36019406ec451a6f03c919c91e500780dcb696637bf2e315204ae08d468937d93536eaca078d2295b5ef013adecc4bb21155c9d8956e
+  data.tar.gz: 36228402d91b627ee1d35e2447dba6fa65457f971fc55a8dbdc94fd262032c7f541a43c7ea69441d987b0591bcf293ace021aa0ec13baf6882ef56ef3265d5e0

data/README.md

@@ -13,7 +13,7 @@ simple to install and use.
 
 To install from rubygems, run:
 
-    gem install markdownlint
+    gem install mdl
 
 To install the latest development version from github:
 
@@ -48,7 +48,8 @@ well as how to correct it:
     README.md:73: MD029 Ordered list item prefix
 
 Markdownlint has many more options you can pass on the command line, run
-`mdl --help` to see what they are.
+`mdl --help` to see what they are, or see the documentation on
+[configuring markdownlint](docs/configuration.md).
 
 ### Styles
 

data/docs/RULES.md

@@ -164,7 +164,7 @@ Corrected Example:
     * List item
       * Nested list item indented by 2 spaces
 
-Rationale (2 space indent): indending by 2 spaces allows the content of a
+Rationale (2 space indent): indenting by 2 spaces allows the content of a
 nested list to be in line with the start of the content of the parent list
 when a single space is used after the list marker.
 
@@ -189,7 +189,7 @@ find the line that is triggered and remove any trailing spaces from the end.
 
 Tags: whitespace, hard_tab
 
-This rule is triggered any any lines that contain hard tab characters instead
+This rule is triggered by any lines that contain hard tab characters instead
 of using spaces for indentation. To fix this, replace any hard tab characters
 with spaces instead.
 
@@ -291,7 +291,7 @@ for more information.
 
 Tags: headers, atx, spaces
 
-This rule is triggered when when spaces are missing after the hash characters
+This rule is triggered when spaces are missing after the hash characters
 in an atx style header:
 
     #Header 1
@@ -309,7 +309,7 @@ space:
 
 Tags: headers, atx, spaces
 
-This rule is triggered when when more than one space is used to separate the
+This rule is triggered when more than one space is used to separate the
 header text from the hash characters in an atx style header:
 
     #  Header 1
@@ -327,7 +327,7 @@ space:
 
 Tags: headers, atx_closed, spaces
 
-This rule is triggered when when spaces are missing inside the hash characters
+This rule is triggered when spaces are missing inside the hash characters
 in a closed atx style header:
 
     #Header 1#
@@ -347,7 +347,7 @@ Note: this rule will fire if either side of the header is missing spaces.
 
 Tags: headers, atx_closed, spaces
 
-This rule is triggered when when more than one space is used to separate the
+This rule is triggered when more than one space is used to separate the
 header text from the hash characters in a closed atx style header:
 
     #  Header 1  #
@@ -388,7 +388,7 @@ To fix this, ensure that all headers have a blank line both before and after
 
     ## Header 2
 
-Rationale: Aside from asthetic reasons, some parsers, including kramdown, will
+Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will
 not parse headers that don't have a blank line before, and will parse them as
 regular text.
 
@@ -607,3 +607,78 @@ inside the list:
 
 To fix this, ensure the correct number of spaces are used after list marker
 for your selected document style.
+
+## MD031 - Fenced code blocks should be surrounded by blank lines
+
+Tags: code, blank_lines
+
+This rule is triggered when fenced code blocks are either not preceded or not
+followed by a blank line:
+
+    Some text
+    ```
+    Code block
+    ```
+
+    ```
+    Another code block
+    ```
+    Some more text
+
+To fix this, ensure that all fenced code blocks have a blank line both before
+and after (except where the block is at the beginning or end of the document):
+
+    Some text
+
+    ```
+    Code block
+    ```
+
+    ```
+    Another code block
+    ```
+
+    Some more text
+
+Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will
+not parse fenced code blocks that don't have blank lines before and after them.
+
+## MD032 - Lists should be surrounded by blank lines
+
+Tags: bullet, ul, ol, blank_lines
+
+This rule is triggered when lists (of any kind) are either not preceded or not
+followed by a blank line:
+
+    Some text
+    * Some
+    * List
+
+    1. Some
+    2. List
+    Some text
+
+To fix this, ensure that all lists have a blank line both before and after
+(except where the block is at the beginning or end of the document):
+
+    Some text
+
+    * Some
+    * List
+
+    1. Some
+    2. List
+
+    Some text
+
+Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will
+not parse lists that don't have blank lines before and after them.
+
+Note: List items without hanging indents are a violation of this rule; list
+items with hanging indents are okay:
+
+    * This is
+    not okay
+
+    * This is
+      okay

data/docs/configuration.md

@@ -0,0 +1,70 @@
+# Mdl configuration
+
+Markdownlint has several options you can configure both on the command line,
+or in markdownlint's configuration file: `.mdlrc` in your home directory.
+While markdownlint will work perfectly well out of the box, this page
+documents some of the options you can change to suit your needs.
+
+In general, anything you pass on the command line can also be put into
+`~/.mdlrc` with the same option. For example, if you pass `--style foo` on the
+command line, you can make this the default by putting `style "foo"` into your
+`~/.mdlrc` file.
+
+## Configuration options
+
+### General options
+
+Verbose - Print additional information about what markdownlint is doing.
+
+* Command line: `-v`, `--verbose`
+* Config file: `verbose true`
+* Default: false
+
+Show warnings - Kramdown will generate warnings of its own for some issues
+found with documents during parsing, and markdownlint can print these out in
+addition to using the built in rules. This option enables/disables that
+behavior.
+
+* Command line: `-w`, `--warnings`
+* Config file: `show_kramdown_warnings true`
+* Default: true
+
+Recurse using files known to git - When mdl is given a directory name on the
+command line, it will recurse into that directory looking for markdown files
+to process. If this option is enabled, it will use git to look for files
+instead, and ignore any files git doesn't know about.
+
+* Command line: `-g`, `--git-recurse`
+* Config file: `git_recurse true`
+* Default: false
+
+### Specifying which rules mdl processes
+
+Tags - Limit the rules mdl enables to those containing the provided tags.
+
+* Command line: `-t tag1,tag2`, `--tags 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`
+* Config file: `rules "MD001", "MD002"`
+* Default: process all rules (no rule limit)
+
+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.
+
+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
+example, one style might enforce a line length of 80 characters, while another
+might choose 72 characters, and another might have no line length limit at all
+(rule MD013).
+
+* Command line: `-s style_name`, `--style style_name`
+* Config file: `style "style_name"`
+* Default: Use the style called 'default'
+
+Note: the value for `style_name` must either end with `.rb` or have `/` in it
+in order to tell `mdl` to look for a custom style, and not a built-in style.

data/docs/rolling_a_release.md

@@ -0,0 +1,18 @@
+# Rolling a new release
+
+Bump the version. Markdownlint uses semantic versioning. From
+<http://semver.org/>:
+
+* Major version for backwards-incompatible changes
+* Minor version functionality added in a backwards-compatible manner
+* Patch version for backwards-compatible bug fixes
+* Exception: Versions < 1.0 may introduce backwards-incompatible changes in a
+  minor version.
+
+To bump the version, edit `lib/mdl/version.rb` and commit to the master
+branch.
+
+Next, run `rake release`. This will:
+
+* Tag vX.Y.Z in git and push it.
+* Upload the new gem to rubygems.org

data/lib/mdl/doc.rb

@@ -28,14 +28,6 @@ module MarkdownLint
     # Create a new document given a string containing the markdown source
 
     def initialize(text)
-      # Workaround for the following two issues:
-      #   https://github.com/mivok/markdownlint/issues/52
-      #   https://github.com/gettalong/kramdown/issues/158
-      # Unfortunately this forces all input text back into ascii, which may
-      # be problematic for any rules that make use of non-ascii characters, so
-      # we should remove this if it no longer becomes necessary to do so.
-      text.encode!("ASCII", invalid: :replace, undef: :replace, replace: '')
-
       @lines = text.split("\n")
       @parsed = Kramdown::Document.new(text, :input => 'MarkdownLint')
       @elements = @parsed.root.children
@@ -159,15 +151,15 @@ module MarkdownLint
         raise "list_style called with non-list element"
       end
       line = element_line(item).strip
-      if line.start_with?("*")
+      if line.start_with?('*')
         :asterisk
-      elsif line.start_with?("+")
+      elsif line.start_with?('+')
         :plus
-      elsif line.start_with?("-")
+      elsif line.start_with?('-')
         :dash
-      elsif line.match("[0-9]+\.")
+      elsif line.match('[0-9]+\.')
         :ordered
-      elsif line.match("[0-9]+\)")
+      elsif line.match('[0-9]+\)')
         :ordered_paren
       else
         :unknown

data/lib/mdl/kramdown_parser.rb

@@ -14,14 +14,6 @@ module Kramdown
         @block_parsers.insert(i, :codeblock_fenced_gfm)
       end
 
-      # Add location information to text elements
-      def add_text(text, tree = @tree, type = @text_type)
-        super
-        if tree.children.last
-          tree.children.last.options[:location] = @src.current_line_number
-        end
-      end
-
       # Regular kramdown parser, but with GFM style fenced code blocks
       FENCED_CODEBLOCK_MATCH = Kramdown::Parser::GFM::FENCED_CODEBLOCK_MATCH
     end

data/lib/mdl/rules.rb

@@ -161,7 +161,8 @@ rule "MD014", "Dollar signs used before commands without showing output" do
   tags :code
   check do |doc|
     doc.find_type_elements(:codeblock).select{
-      |e| not e.value.split(/\n+/).map{|l| l.match(/^\$\s/)}.include?(nil)
+      |e| not e.value.empty? and
+      not e.value.split(/\n+/).map{|l| l.match(/^\$\s/)}.include?(nil)
     }.map{|e| doc.element_linenumber(e)}
   end
 end
@@ -391,3 +392,53 @@ rule "MD030", "Spaces after list markers" do
     errors
   end
 end
+
+rule "MD031", "Fenced code blocks should be surrounded by blank lines" do
+  tags :code, :blank_lines
+  check do |doc|
+    errors = []
+    # Some parsers (including kramdown) have trouble detecting fenced code
+    # blocks without surrounding whitespace, so examine the lines directly.
+    in_code = false
+    lines = [ "" ] + doc.lines + [ "" ]
+    lines.each_with_index do |line, linenum|
+      if line.strip.match(/^(```|~~~)/)
+        in_code = !in_code
+        if (in_code and not lines[linenum - 1].empty?) or
+           (not in_code and not lines[linenum + 1].empty?)
+          errors << linenum
+        end
+      end
+    end
+    errors
+  end
+end
+
+rule "MD032", "Lists should be surrounded by blank lines" do
+  tags :bullet, :ul, :ol, :blank_lines
+  check do |doc|
+    errors = []
+    # Some parsers (including kramdown) have trouble detecting lists
+    # without surrounding whitespace, so examine the lines directly.
+    in_list = false
+    in_code = false
+    prev_line = ""
+    doc.lines.each_with_index do |line, linenum|
+      if not in_code
+        list_marker = line.strip.match(/^([\*\+\-]|(\d+\.))\s/)
+        if list_marker and not in_list and not prev_line.match(/^($|\s)/)
+          errors << linenum + 1
+        elsif not list_marker and in_list and not line.match(/^($|\s)/)
+          errors << linenum
+        end
+        in_list = list_marker
+      end
+      if line.strip.match(/^(```|~~~)/)
+        in_code = !in_code
+        in_list = false
+      end
+      prev_line = line
+    end
+    errors.uniq
+  end
+end

data/lib/mdl/version.rb

@@ -1,3 +1,3 @@
 module MarkdownLint
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/mdl.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.2'
 
-  spec.add_dependency 'kramdown', '~> 1.4', '>= 1.4.0'
+  spec.add_dependency 'kramdown', '~> 1.5', '>= 1.5.0'
   spec.add_dependency 'mixlib-config', '~> 2.1', '>= 2.1.0'
   spec.add_dependency 'mixlib-cli', '~> 1.5', '>= 1.5.0'
 

data/test/rule_tests/code_block_dollar.md

@@ -20,3 +20,14 @@ The following code block uses variable names, and likewise shouldn't fire:
 
     $foo = 'bar';
     $baz = 'qux';
+
+The following code block doesn't have any dollar signs, and shouldn't fire:
+
+    ls foo
+    cat bar
+
+The following (fenced) code block doesn't have any content at all, and
+shouldn't fire:
+
+```
+```

data/test/rule_tests/fenced_code_without_blank_lines.md

@@ -0,0 +1,42 @@
+```
+code at start of file
+```
+
+text
+
+```ruby
+code
+```
+
+text
+``` {MD031}
+code
+``` {MD031}
+text
+
+```
+code
+``` {MD031}
+text
+
+text
+``` {MD031}
+code
+```
+
+text
+
+```js
+code
+code
+code
+```
+
+```html
+```
+
+text
+
+```
+code at end of file without newline
+```

data/test/rule_tests/lists_without_blank_lines.md

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mark Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-07 00:00:00.000000000 Z
+date: 2015-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: mixlib-config
   requirement: !ruby/object:Gem::Requirement
@@ -142,8 +142,10 @@ files:
 - Rakefile
 - bin/mdl
 - docs/RULES.md
+- docs/configuration.md
 - docs/creating_rules.md
 - docs/creating_styles.md
+- docs/rolling_a_release.md
 - example/markdown_spec.md
 - lib/mdl.rb
 - lib/mdl/cli.rb
@@ -174,6 +176,7 @@ files:
 - test/rule_tests/consistent_bullet_styles_plus.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/first_header_bad_atx.md
 - test/rule_tests/first_header_bad_setext.md
 - test/rule_tests/first_header_good_atx.md
@@ -205,6 +208,7 @@ 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/lists_without_blank_lines.md
 - test/rule_tests/long_lines.md
 - test/rule_tests/long_lines_100.md
 - test/rule_tests/long_lines_100_style.rb
@@ -244,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Markdown lint tool
@@ -264,6 +268,7 @@ test_files:
 - test/rule_tests/consistent_bullet_styles_plus.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/first_header_bad_atx.md
 - test/rule_tests/first_header_bad_setext.md
 - test/rule_tests/first_header_good_atx.md
@@ -295,6 +300,7 @@ 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/lists_without_blank_lines.md
 - test/rule_tests/long_lines.md
 - test/rule_tests/long_lines_100.md
 - test/rule_tests/long_lines_100_style.rb
@@ -311,4 +317,3 @@ test_files:
 - test/setup_tests.rb
 - test/test_ruledocs.rb
 - test/test_rules.rb
-has_rdoc: