mdl 0.0.1

data/lib/mdl/styles/all.rb

@@ -0,0 +1 @@
+all

data/lib/mdl/styles/cirosantilli.rb

@@ -0,0 +1,6 @@
+# Enforce the style guide at http://www.cirosantilli.com/markdown-styleguide
+all
+rule 'MD003', :style => :atx
+rule 'MD004', :style => :dash
+rule 'MD007', :indent => 4
+rule 'MD030', :ul_multi => 3, :ol_multi => 2

data/lib/mdl/styles/default.rb

@@ -0,0 +1 @@
+all

data/lib/mdl/styles/relaxed.rb

@@ -0,0 +1,6 @@
+all
+exclude_tag :whitespace
+exclude_tag :line_length
+
+exclude_rule 'MD006' # Lists at beginning of line
+exclude_rule 'MD007' # List indentation

data/lib/mdl/version.rb

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

data/mdl.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mdl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mdl"
+  spec.version       = MarkdownLint::VERSION
+  spec.authors       = ["Mark Harrison"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.2'
+
+  spec.add_dependency 'kramdown', '~> 1.4', '>= 1.4.0'
+  spec.add_dependency 'mixlib-config', '~> 2.1', '>= 2.1.0'
+  spec.add_dependency 'mixlib-cli', '~> 1.5', '>= 1.5.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 'pry', '~> 0.10'
+end

data/test/rule_tests/atx_closed_header_spacing.md

@@ -0,0 +1,17 @@
+#Header 1 {MD020} #
+
+## Header 2 {MD020}##
+
+##Header 3 {MD020}##
+
+##  Header 4 {MD021} ##
+
+## Header 5 {MD021}  ##
+
+##  Header 6 {MD021}  ##
+
+##   Header 7 {MD021}   ##
+
+## Header 8 \#
+
+## Header 9  \#

data/test/rule_tests/atx_header_spacing.md

@@ -0,0 +1,5 @@
+#Header 1 {MD018}
+
+##  Header 2 {MD019}
+
+##   Header 3 {MD019}

data/test/rule_tests/blockquote_blank_lines.md

@@ -0,0 +1,31 @@
+Some text
+
+> a quote
+> same quote
+
+> blank line above me
+
+
+> two blank lines above me
+ 
+> space above me
+
+* List with embedded blockquote
+
+  > Test
+  > Test
+
+  > Test
+
+* Item 2
+
+  > Test. The blank line below should _not_ trigger MD028 as one blockquote is
+  > inside the list, and the other is outside it.
+
+> Test
+
+Expected errors:
+
+{MD028:5} {MD028:8} {MD028:10} {MD028:17}
+{MD009:10} (trailing space is intentional)
+{MD012:8} (multiple blank lines are intentional)

data/test/rule_tests/blockquote_spaces.md

@@ -0,0 +1,21 @@
+Some text
+
+> Hello world
+>  Foo {MD027}
+>  Bar {MD027}
+
+This tests other things embedded in the blockquote:
+
+> *Hello world*
+>  *foo* {MD027}
+>  **bar** {MD027}
+>   "Baz" {MD027}
+> *foo*
+> **bar**
+> 'baz'
+
+Test the first line being indented too much:
+
+>  Foo {MD027}
+>  Bar {MD027}
+> Baz

data/test/rule_tests/bulleted_list_2_space_indent.md

@@ -0,0 +1,6 @@
+This is a document where the lists are indented by 2 spaces, but the style is
+set to 4 space indents for lists:
+
+* Test X
+  * Test Y {MD007}
+    * Test Z {MD007}

data/test/rule_tests/bulleted_list_2_space_indent_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD007', :indent => 4

data/test/rule_tests/bulleted_list_4_space_indent.md

@@ -0,0 +1,3 @@
+* Test X
+    * Test Y {MD007}
+        * Test Z {MD007}

data/test/rule_tests/bulleted_list_not_at_beginning_of_line.md

@@ -0,0 +1,14 @@
+Some text
+
+  * Item {MD006}
+    * Item
+    * Item
+      * Item
+    * Item
+  * Item
+  * Item
+
+Some more text
+
+  * Item {MD006}
+    * Item

data/test/rule_tests/code_block_dollar.md

@@ -0,0 +1,22 @@
+The following code block shouldn't have $ before the commands:
+
+    $ ls {MD014}
+    $ less foo
+
+    $ cat bar
+
+However the following code block shows output, and $ can be used to
+distinguish between command and output:
+
+    $ ls
+    foo bar
+    $ less foo
+    Hello world
+
+    $ cat bar
+    baz
+
+The following code block uses variable names, and likewise shouldn't fire:
+
+    $foo = 'bar';
+    $baz = 'qux';

data/test/rule_tests/consecutive_blank_lines.md

@@ -0,0 +1,11 @@
+Some text
+
+
+Some text {MD012:3}
+
+    This is a code block
+
+
+    with two blank lines in it
+
+Some more text

data/test/rule_tests/consistent_bullet_styles_asterisk.md

@@ -0,0 +1,3 @@
+* Item
+  * Item
+  * Item

data/test/rule_tests/consistent_bullet_styles_dash.md

@@ -0,0 +1,3 @@
+- Item
+  - Item
+  - Item

data/test/rule_tests/consistent_bullet_styles_plus.md

@@ -0,0 +1,3 @@
++ Item
+  + Item
+  + Item

data/test/rule_tests/fenced_code_blocks.md

@@ -0,0 +1,21 @@
+This is a GFM-style fenced code block:
+
+``` bash
+#!/bin/bash
+
+# Print something to stdout:
+echo "Hello"
+echo "World"
+```
+
+This is a kramdown-style fenced code block:
+
+~~~ bash
+#!/bin/bash
+
+# Print something to stdout:
+echo "Hello"
+echo "World"
+~~~
+
+None of the above should trigger any heading related rules.

data/test/rule_tests/first_header_bad_atx.md

@@ -0,0 +1 @@
+## Header {MD002}

data/test/rule_tests/first_header_bad_setext.md

@@ -0,0 +1,2 @@
+Header {MD002}
+--------------

data/test/rule_tests/first_header_good_atx.md

@@ -0,0 +1 @@
+# Header

data/test/rule_tests/first_header_good_setext.md

@@ -0,0 +1,2 @@
+Header
+======

data/test/rule_tests/header_duplicate_content.md

@@ -0,0 +1,11 @@
+# Header 1
+
+## Header 2
+
+## Header 1
+
+### Header 2
+
+## Header 3
+
+{MD024:5} {MD024:7}

data/test/rule_tests/header_multiple_toplevel.md

@@ -0,0 +1,3 @@
+# Heading 1
+
+# Heading 2 {MD025}

data/test/rule_tests/header_mutliple_h1_no_toplevel.md

@@ -0,0 +1,5 @@
+Some introductory text
+
+# Heading 1
+
+# Heading 2

data/test/rule_tests/header_trailing_punctuation.md

@@ -0,0 +1,11 @@
+# Heading 1 {MD026}.
+
+## Heading 2 {MD026},
+
+## Heading 3 {MD026}!
+
+## Heading 4 {MD026}:
+
+## Heading 5 {MD026};
+
+## Heading 6 {MD026}?

data/test/rule_tests/header_trailing_punctuation_customized.md

@@ -0,0 +1,14 @@
+# Heading 1 {MD026}.
+
+## Heading 2 {MD026},
+
+## Heading 3 {MD026}!
+
+## Heading 4 {MD026}:
+
+## Heading 5 {MD026};
+
+## Heading 6?
+
+The rule has been customized to allow question marks while disallowing
+everything else.

data/test/rule_tests/header_trailing_punctuation_customized_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD026', :punctuation => '.,;:!'

data/test/rule_tests/headers_bad.md

@@ -0,0 +1,7 @@
+# Header
+
+### Header 3 {MD001}
+
+## Header 2
+
+#### Header 4 {MD001}

data/test/rule_tests/headers_good.md

@@ -0,0 +1,5 @@
+# Heading 1
+
+## Heading 2
+
+## Heading 3

data/test/rule_tests/headers_surrounding_space_atx.md

@@ -0,0 +1,9 @@
+# Header 1
+
+## Header 2 {MD022}
+Some text
+## Header 3 {MD022}
+Some text
+## Header 4 {MD022}
+
+## Header 5

data/test/rule_tests/headers_surrounding_space_setext.md

@@ -0,0 +1,15 @@
+Header 1
+========
+
+Header 2 {MD022}
+----------------
+Some text
+Header 3 {MD022}
+================
+Some text
+Header 4 {MD022}
+================
+Some text
+
+Header 5
+--------

data/test/rule_tests/headers_with_spaces_at_the_beginning.md

@@ -0,0 +1,9 @@
+Some text
+
+ # Header 1 {MD023}
+
+ Setext style fully indented {MD023}
+ ===================================
+
+ Setext style title only indented {MD023}
+=========================================

data/test/rule_tests/inconsistent_bullet_indent_same_level.md

@@ -0,0 +1,4 @@
+* Item
+    * Item {MD007}
+  * Item {MD005}
+    * Item

data/test/rule_tests/inconsistent_bullet_styles_asterisk.md

@@ -0,0 +1,3 @@
+* Item
+  + Item {MD004}
+  - Item {MD004}

data/test/rule_tests/inconsistent_bullet_styles_dash.md

@@ -0,0 +1,3 @@
+- Item
+  * Item {MD004}
+  + Item {MD004}

data/test/rule_tests/inconsistent_bullet_styles_plus.md

@@ -0,0 +1,3 @@
++ Item
+  * Item {MD004}
+  - Item {MD004}

data/test/rule_tests/incorrect_bullet_style_asterisk.md

@@ -0,0 +1,3 @@
+* Item
+  - Item {MD004}
+  + Item {MD004}

data/test/rule_tests/incorrect_bullet_style_asterisk_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD004', :style => :asterisk

data/test/rule_tests/incorrect_bullet_style_dash.md

@@ -0,0 +1,3 @@
+* Item {MD004}
+  - Item
+  + Item {MD004}

data/test/rule_tests/incorrect_bullet_style_dash_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD004', :style => :dash

data/test/rule_tests/incorrect_bullet_style_plus.md

@@ -0,0 +1,3 @@
+* Item {MD004}
+  - Item {MD004}
+  + Item

data/test/rule_tests/incorrect_bullet_style_plus_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD004', :style => :plus

data/test/rule_tests/incorrect_header_atx.md

@@ -0,0 +1,6 @@
+# Header 1 {MD003} #
+
+## Header 2
+
+Header 3 {MD003}
+----------------

data/test/rule_tests/incorrect_header_atx_closed.md

@@ -0,0 +1,6 @@
+# Header 1 #
+
+## Header 2 {MD003}
+
+Header 3 {MD003}
+----------------

data/test/rule_tests/incorrect_header_atx_closed_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD003', :style => :atx_closed

data/test/rule_tests/incorrect_header_atx_style.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD003', :style => :atx