mdl 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bbddcf751f5ec8a6e7a2d184820c2ba747baa0c
-  data.tar.gz: 6a40d8e63ef5829c7177d5998dbd0363abae8eaa
+  metadata.gz: 63d2a62f680a2090a8fdd92a69b01953781e153c
+  data.tar.gz: 89d7e3211a085c922f6622fc43920cf424945445
 SHA512:
-  metadata.gz: 4cb2592afd5b65dbe4bce8aa980ebfca2b9bb76c2d6d9deff09220375d53305706963a9ceb0d4582ac138dcb4bf2a380d792272cf704152a054c76f5859ad082
-  data.tar.gz: 82b4dd7b7b81e1ed956e3c39a6ee3a9e6e09deaeb96eeae6278860a69625d53c7ec269944d5db21cadbd7b639a8295cfde4f8540e4eff171cb03d6658f7d3212
+  metadata.gz: c0d2dde537e878235680efccb4133a18d25e9f8bce41a926376794d71de4ae2630f4f1f1b0c11574a350b0e672595c7c90f690e5fc01ae3b0279b5c68ee82ff5
+  data.tar.gz: 4228d4d9b6387d2d161cab1f5d1ce49dc9d1e6443da0353a4c630f6720cd6359650e50f08d21d40655821a89201308b8592aeb2bd0f6724b0090a815ec4f8c57

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
   - "1.9.2"
-  - "1.9.3"
   - "2.1.0"
-  - "2.1.1"
+  - "2.1.6"
+  - "2.3.0"
   - jruby-19mode # JRuby in 1.9 mode

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Change Log
 
+## [v0.3.0](https://github.com/mivok/markdownlint/tree/v0.3.0) (2016-03-19)
+
+[Full Changelog](https://github.com/mivok/markdownlint/compare/v0.2.1...v0.3.0)
+
+### Rules added/changed
+
+* 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
+
+* 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)
+  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
+  'ul-style' instead of 'MD004'. See RULES.md for a list of the rule aliases.
+  You can pass the `-a` option to display rule aliases instead of MDxxx rule
+  IDs.
+
+### Bugs fixed
+
+* 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
+  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)
+* [Add missing word to description of MD035 in RULES.md - David
+  Anson](https://github.com/mivok/markdownlint/pull/86)
+* [Probe for .mdlrc in current and parent directories - Loic
+  Nageleisen](https://github.com/mivok/markdownlint/pull/111)
+* [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)

data/README.md

@@ -1,5 +1,6 @@
 [![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)
+[![Gem Version](https://badge.fury.io/rb/mdl.svg)](http://badge.fury.io/rb/mdl)
 
 # Markdown lint tool
 

data/docs/RULES.md

@@ -8,6 +8,8 @@ versions of the examples.
 
 Tags: headers
 
+Aliases: header-increment
+
 This rule is triggered when you skip header levels in a markdown document, for
 example:
 
@@ -37,6 +39,8 @@ level at a time:
 
 Tags: headers
 
+Aliases: first-header-h1
+
 This rule is triggered when the first header in the document isn't a h1 header:
 
     ## This isn't a H1 header
@@ -53,7 +57,9 @@ The first header in the document should be a h1 header:
 
 Tags: headers
 
-Parameters: style ("consistent", "atx", "atx_closed", "setext"; default "consistent")
+Aliases: header-style
+
+Parameters: style ("consistent", "atx", "atx_closed", "setext", "setext_with_atx"; default "consistent")
 
 This rule is triggered when different header styles (atx, setext, and 'closed'
 atx) are used in the same document:
@@ -71,14 +77,27 @@ Be consistent with the style of header used in a document:
 
     ## ATX style H2
 
+The setext_with_atx doc style allows atx-style headers of level 3 or more in
+documents with setext style headers:
+
+    Setext style H1
+    ===============
+
+    Setext style H2
+    ---------------
+
+    ### ATX style H3
+
 Note: the configured header style can be a specific style to use (atx,
-atx_closed, setext), or simply require that the usage be consistent within the
-document.
+atx_closed, setext, setext_with_atx), or simply require that the usage be
+consistent within the document.
 
 ## MD004 - Unordered list style
 
 Tags: bullet, ul
 
+Aliases: ul-style
+
 Parameters: style ("consistent", "asterisk", "plus", "dash"; default "consistent")
 
 This rule is triggered when the symbols used in the document for unordered
@@ -103,6 +122,8 @@ document.
 
 Tags: bullet, ul, indentation
 
+Aliases: list-indent
+
 This rule is triggered when list items are parsed as being at the same level,
 but don't have the same indentation:
 
@@ -123,6 +144,8 @@ for the list to fix it:
 
 Tags: bullet, ul, indentation
 
+Aliases: ul-start-left
+
 This rule is triggered when top level lists don't start at the beginning of a
 line:
 
@@ -149,6 +172,8 @@ characters if you use 4 space tabs, or 1 character if you use 2 space tabs).
 
 Tags: bullet, ul, indentation
 
+Aliases: ul-indent
+
 Parameters: indent (number; default 2)
 
 This rule is triggered when list items are not indented by the configured
@@ -182,6 +207,8 @@ for a description of the problem.
 
 Tags: whitespace
 
+Aliases: no-trailing-spaces
+
 Parameters: br_spaces (number; default: 0)
 
 This rule is triggered on any lines that end with whitespace. To fix this,
@@ -200,6 +227,8 @@ set to the default of 0.
 
 Tags: whitespace, hard_tab
 
+Aliases: no-hard-tabs
+
 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.
@@ -220,6 +249,8 @@ Corrected example:
 
 Tags: links
 
+Aliases: no-reversed-links
+
 This rule is triggered when text that appears to be a link is encountered, but
 where the syntax appears to have been reversed (the `[]` and `()` are
 reversed):
@@ -234,6 +265,8 @@ To fix this, swap the `[]` and `()` around:
 
 Tags: whitespace, blank_lines
 
+Aliases: no-multiple-blanks
+
 This rule is triggered when there are multiple consecutive blank lines in the
 document:
 
@@ -255,7 +288,8 @@ lines inside code blocks.
 
 Tags: line_length
 
-Parameters: line_length (number; default 80)
+Aliases: line-length
+Parameters: line_length, code_blocks, tables (number; default 80, boolean; default true)
 
 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
@@ -265,10 +299,19 @@ This rule has an exception where there is no whitespace beyond the configured
 line length. This allows you to still include items such as long URLs without
 being forced to break them in the middle.
 
+You also have the option to exclude this rule for code blocks and tables. To
+do this, set the `code_blocks` and/or `tables` parameters to false.
+
+Code blocks are included in this rule by default since it is often a
+requirement for document readability, and tentatively compatible with code
+rules. Still, some languages do not lend themselves to short lines.
+
 ## MD014 - Dollar signs used before commands without showing output
 
 Tags: code
 
+Aliases: commands-show-output
+
 This rule is triggered when there are code blocks showing shell commands to be
 typed, and the shell commands are preceded by dollar signs ($):
 
@@ -302,6 +345,8 @@ for more information.
 
 Tags: headers, atx, spaces
 
+Aliases: no-missing-space-atx
+
 This rule is triggered when spaces are missing after the hash characters
 in an atx style header:
 
@@ -320,6 +365,8 @@ space:
 
 Tags: headers, atx, spaces
 
+Aliases: no-multiple-space-atx
+
 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:
 
@@ -338,6 +385,8 @@ space:
 
 Tags: headers, atx_closed, spaces
 
+Aliases: no-missing-space-closed-atx
+
 This rule is triggered when spaces are missing inside the hash characters
 in a closed atx style header:
 
@@ -358,6 +407,8 @@ Note: this rule will fire if either side of the header is missing spaces.
 
 Tags: headers, atx_closed, spaces
 
+Aliases: no-multiple-space-closed-atx
+
 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:
 
@@ -379,6 +430,8 @@ spaces.
 
 Tags: headers, blank_lines
 
+Aliases: blanks-around-headers
+
 This rule is triggered when headers (any style) are either not preceded or not
 followed by a blank line:
 
@@ -407,6 +460,8 @@ regular text.
 
 Tags: headers, spaces
 
+Aliases: header-start-left
+
 This rule is triggered when a header is indented by one or more spaces:
 
     Some text
@@ -426,6 +481,8 @@ parsed as headers, and will instead appear as regular text.
 
 Tags: headers
 
+Aliases: no-duplicate-header
+
 This rule is triggered if there are multiple headers in the document that have
 the same text:
 
@@ -447,6 +504,8 @@ this.
 
 Tags: headers
 
+Aliases: single-h1
+
 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:
@@ -474,6 +533,8 @@ should be contained within this header.
 
 Tags: headers
 
+Aliases: no-trailing-punctuation
+
 Parameters: punctuation (string; default ".,;:!?")
 
 This rule is triggered on any header that has a punctuation character as the
@@ -494,6 +555,8 @@ in an FAQ.
 
 Tags: blockquote, whitespace, indentation
 
+Aliases: no-multiple-space-blockquote
+
 This rule is triggered when blockquotes have more than one space after the
 blockquote (`>`) symbol:
 
@@ -509,6 +572,8 @@ To fix, remove any extraneous space:
 
 Tags: blockquote, whitespace
 
+Aliases: no-blanks-blockquote
+
 This rule is triggered when two blockquote blocks are separated by nothing
 except for a blank line:
 
@@ -542,6 +607,8 @@ separate blockquotes.
 
 Tags: ol
 
+Aliases: ol-prefix
+
 Parameters: style ("one", "ordered"; default "one")
 
 This rule is triggered on ordered lists that do not either start with '1.' or
@@ -564,6 +631,8 @@ Example valid list if the style is configured as 'ordered':
 
 Tags: ol, ul, whitespace
 
+Aliases: list-marker-space
+
 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. '`-`',
@@ -623,6 +692,8 @@ for your selected document style.
 
 Tags: code, blank_lines
 
+Aliases: blanks-around-fences
+
 This rule is triggered when fenced code blocks are either not preceded or not
 followed by a blank line:
 
@@ -658,6 +729,8 @@ not parse fenced code blocks that don't have blank lines before and after them.
 
 Tags: bullet, ul, ol, blank_lines
 
+Aliases: blanks-around-lists
+
 This rule is triggered when lists (of any kind) are either not preceded or not
 followed by a blank line:
 
@@ -698,6 +771,8 @@ items with hanging indents are okay:
 
 Tags: html
 
+Aliases: no-inline-html
+
 This rule is triggered whenever raw HTML is used in a markdown document:
 
     <h1>Inline HTML header</h1>
@@ -714,6 +789,8 @@ who are rendering markdown documents in something other than HTML.
 
 Tags: links, url
 
+Aliases: no-bare-urls
+
 This rule is triggered whenever a URL is given that isn't surrounded by angle
 brackets:
 
@@ -736,11 +813,13 @@ converted:
 
 Tags: hr
 
+Aliases: hr-style
+
 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:
+This rule is triggered when inconsistent styles of horizontal rules are used
+in the document:
 
     ---
 
@@ -770,6 +849,8 @@ is allowed.
 
 Tags: headers, emphasis
 
+Aliases: no-emphasis-as-header
+
 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:
 
@@ -799,6 +880,8 @@ It won't fire on emphasis used within regular text.
 
 Tags: whitespace, emphasis
 
+Aliases: no-space-in-emphasis
+
 This rule is triggered when emphasis markers (bold, italic) are used, but they
 have spaces between the markers and the text:
 
@@ -829,6 +912,8 @@ intended by the author.
 
 Tags: whitespace, code
 
+Aliases: no-space-in-code
+
 This rule is triggered on code span elements that have spaces right inside the
 backticks:
 
@@ -846,6 +931,8 @@ To fix this, remove the spaces inside the codespan markers:
 
 Tags: whitespace, links
 
+Aliases: no-space-in-links
+
 This rule is triggered on links that have spaces surrounding the link text:
 
     [ a link ](http://www.example.com/)
@@ -858,6 +945,8 @@ To fix this, remove the spaces surrounding the link text:
 
 Tags: code, language
 
+Aliases: fenced-code-language
+
 This rule is triggered when fenced code blocks are used, but a language isn't
 specified:
 
@@ -872,3 +961,24 @@ To fix this, add a language specifier to the code block:
     #!/bin/bash
     echo Hello world
     ```
+
+## MD041 - First line in file should be a top level header
+
+Tags: headers
+
+Aliases: first-line-h1
+
+This rule is triggered when the first line in the file isn't a top level (h1)
+header:
+
+    ```
+    This is a file without a header
+    ```
+
+To fix this, add a header to the top of your file:
+
+    ```
+    # File with header
+
+    This is a file with a top level header
+    ```