mdl 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b73db54b5ec02a8b079558f3cb444c3f29e7ffd0e9a752483115d5c0a13a93
-  data.tar.gz: 47c88efb0b9aa6ac538c769096d02d36170109ef4a7bc9e4370af8d45143c6d0
+  metadata.gz: 7ccf964a726aadad1ea7bdc7e589852b27172ebe7dc0931915edde1cfe55376c
+  data.tar.gz: 246846b368b1be17d82de807042ac754b6cca2bc9420a97bf9dbcf2115d44384
 SHA512:
-  metadata.gz: 3a9c8c520e4f1e31517bb4b34549e45c505f86ed84daff6548092df02a34b594a7b81a8c4972ea93ba14fd75d4ea8a753e5c8f6f67994857d3e55449fbeb55bf
-  data.tar.gz: a8b3d72b3ff83bd86eb72c3b3911d16a5951ebc26372fa40995662f9372931aa192948517eafb7d7a8ec3eb0ede0d226423754c60c037543d7d55023d55f801f
+  metadata.gz: 15e0c6a011500d284f0418090c3a2c57f53f2d0a5d281dadc87b86ee345d90ac9686513ef2a58aa5f21a47b2e710474a18404216a6658ce7f4f0a76fe4dd6f8e
+  data.tar.gz: a67b0882f1f05600a21466d4f8a11dda875cf46e045f7e6e663a7d2834f44c7ab101ac4328017da85c74f370b914bd9f49ce65183a3174fcece1d2335f886aec

data/.pre-commit-hooks.yaml

@@ -0,0 +1,6 @@
+- id: markdownlint
+  name: Markdownlint
+  description: Run markdownlint on your Markdown files
+  entry: mdl
+  language: ruby
+  files: \.(md|mdown|markdown)$

data/.travis.yml

@@ -1,23 +1,12 @@
-sudo: false
-dist: trusty
+dist: bionic
 language: ruby
 
 notifications:
   email: false
 
-# Temporary disable of jruby testing. There are problems on travis-ci
-# currently with this. See:
-#
-#   https://github.com/travis-ci/travis-ci/issues/9826
-#
-# before_install:
-#  - unset _JAVA_OPTIONS
-
 matrix:
   include:
-    - rvm: 2.3.4
-    - rvm: 2.4.1
-    - rvm: 2.5.1
-#    - rvm: jruby-9.1.9.0
-#      env: JRUBY_OPTS="--dev"
-#    - rvm: jruby-9.2.0.0
+    - rvm: 2.4.6
+    - rvm: 2.5.5
+    - rvm: 2.6.2
+    - rvm: jruby-9.2.8.0

data/CHANGELOG.md

@@ -1,10 +1,29 @@
 # Change Log
 
-## [Unreleased]
+## [v0.6.0] (2019-10-19)
+
+### Added
+
+* There are now CONTRIBUTING.md and MAINTAINERS.md docs
+* There is now a `.pre-commit-hooks.yaml` for those who want to use pre-commit.com
 
 ### Changed
 
-## [v0.5.0]
+* PR #248: Ignore blank line after front matter
+* PR #231: Only import JSON when necessary (#223)
+* PR #265: Use newere mixlib-cli
+* PR #246: Nicer error message when activating nonexistent rule
+* PR #241: Fix documentation on `ignore_front_matter`
+* PR #245: Update docs to use "MY" prefix for custom rule example
+* PR #256: Fix crash in MD039 when the link text is empty
+* PR #229: Reference Node.js markdownlint
+* PR #232: Added table of contents to RULES.md for easier navigation
+* PR #219: Fix typos in MD046 docs
+* PR #222: Fixed MD036 crash
+
+### Removed
+
+## [v0.5.0] (2018-07-01)
 
 ### Added
 
@@ -178,6 +197,8 @@
 * MD030 - Spaces after list markers
 
 [Unreleased]: https://github.com/markdownlint/markdownlint/tree/master
+[v0.6.0]: https://github.com/markdownlint/markdownlint/tree/v0.6.0
+[v0.5.0]: https://github.com/markdownlint/markdownlint/tree/v0.5.0
 [v0.4.0]: https://github.com/markdownlint/markdownlint/tree/v0.4.0
 [v0.3.1]: https://github.com/markdownlint/markdownlint/tree/v0.3.1
 [v0.3.0]: https://github.com/markdownlint/markdownlint/tree/v0.3.0

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it ( <http://github.com/markdownlint/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`)
+1. Create new Pull Request

data/MAINTAINERS.md

@@ -0,0 +1,21 @@
+# Markdownlint
+
+We aim to make sure this project has longevity, and to that end we want to make
+adding new maintainers a simple process.
+
+If you would like to be a maintainer, you need to demonstrate some ongoing
+contributions - either reviews of PRs or PR contributions. They need not be large.
+Then send a PR to add yourself to this list. The existing maintainers will
+have a discussion, and assuming there are no objections, you'll be added.
+
+## Current Maintainers
+
+* [Phil Dibowitz](https://github.com/jaymzh)
+* [Naomi Reeves](https://github.com/NaomiReeves)
+* [Bryan Wann](https://github.com/bwann)
+* [David Anson](https://github.com/DavidAnson)
+
+## Past Maintainers
+
+* [psyomn](https://github.com/psyomn)
+* [Mark Harrison](https://github.com/mivok)

data/README.md

@@ -1,4 +1,3 @@
-[![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/markdownlint/markdownlint.svg)](https://travis-ci.org/markdownlint/markdownlint)
 [![Gem Version](https://badge.fury.io/rb/mdl.svg)](http://badge.fury.io/rb/mdl)
 
@@ -77,10 +76,12 @@ configured in a style file.
 For more information on creating style files, see the
 [creating styles](docs/creating_styles.md) document.
 
+## Related projects
+
+- [markdownlint](https://github.com/DavidAnson/markdownlint) and 
+  [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) for
+  Node.js
+
 ## Contributing
 
-1. Fork it ( <http://github.com/markdownlint/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`)
-1. Create new Pull Request
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

data/docs/RULES.md

@@ -1,3 +1,44 @@
+
+* [Rules](#rules)
+    * [MD001 - Header levels should only increment by one level at a time](#md001---header-levels-should-only-increment-by-one-level-at-a-time)
+    * [MD002 - First header should be a top level header](#md002---first-header-should-be-a-top-level-header)
+    * [MD003 - Header style](#md003---header-style)
+    * [MD004 - Unordered list style](#md004---unordered-list-style)
+    * [MD005 - Inconsistent indentation for list items at the same level](#md005---inconsistent-indentation-for-list-items-at-the-same-level)
+    * [MD006 - Consider starting bulleted lists at the beginning of the line](#md006---consider-starting-bulleted-lists-at-the-beginning-of-the-line)
+    * [MD007 - Unordered list indentation](#md007---unordered-list-indentation)
+    * [MD009 - Trailing spaces](#md009---trailing-spaces)
+    * [MD010 - Hard tabs](#md010---hard-tabs)
+    * [MD011 - Reversed link syntax](#md011---reversed-link-syntax)
+    * [MD012 - Multiple consecutive blank lines](#md012---multiple-consecutive-blank-lines)
+    * [MD013 - Line length](#md013---line-length)
+    * [MD014 - Dollar signs used before commands without showing output](#md014---dollar-signs-used-before-commands-without-showing-output)
+    * [MD018 - No space after hash on atx style header](#md018---no-space-after-hash-on-atx-style-header)
+    * [MD019 - Multiple spaces 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](#md020---no-space-inside-hashes-on-closed-atx-style-header)
+    * [MD021 - Multiple spaces 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](#md022---headers-should-be-surrounded-by-blank-lines)
+    * [MD023 - Headers must start at the beginning of the line](#md023---headers-must-start-at-the-beginning-of-the-line)
+    * [MD024 - Multiple headers with the same content](#md024---multiple-headers-with-the-same-content)
+    * [MD025 - Multiple top level headers in the same document](#md025---multiple-top-level-headers-in-the-same-document)
+    * [MD026 - Trailing punctuation in header](#md026---trailing-punctuation-in-header)
+    * [MD027 - Multiple spaces after blockquote symbol](#md027---multiple-spaces-after-blockquote-symbol)
+    * [MD028 - Blank line inside blockquote](#md028---blank-line-inside-blockquote)
+    * [MD029 - Ordered list item prefix](#md029---ordered-list-item-prefix)
+    * [MD030 - Spaces after list markers](#md030---spaces-after-list-markers)
+    * [MD031 - Fenced code blocks should be surrounded by blank lines](#md031---fenced-code-blocks-should-be-surrounded-by-blank-lines)
+    * [MD032 - Lists should be surrounded by blank lines](#md032---lists-should-be-surrounded-by-blank-lines)
+    * [MD033 - Inline HTML](#md033---inline-html)
+    * [MD034 - Bare URL used](#md034---bare-url-used)
+    * [MD035 - Horizontal rule style](#md035---horizontal-rule-style)
+    * [MD036 - Emphasis used instead of a header](#md036---emphasis-used-instead-of-a-header)
+    * [MD037 - Spaces inside emphasis markers](#md037---spaces-inside-emphasis-markers)
+    * [MD038 - Spaces inside code span elements](#md038---spaces-inside-code-span-elements)
+    * [MD039 - Spaces inside link text](#md039---spaces-inside-link-text)
+    * [MD040 - Fenced code blocks should have a language specified](#md040---fenced-code-blocks-should-have-a-language-specified)
+    * [MD041 - First line in file should be a top level header](#md041---first-line-in-file-should-be-a-top-level-header)
+    * [MD046 - Code block style](#md046---code-block-style)
+
 # Rules
 
 This document contains a description of all rules, what they are checking for,
@@ -1025,8 +1066,9 @@ Aliases: code-block-style
 
 Parameters: style ("fenced", "indented", "consistent", default "fenced")
 
-This rule is truggered what a different code block style is used than the
-configured one. For example, in the default configuration this triggers:
+This rule is triggered when a different code block style is used than the
+configured one. For example, in the default configuration this rule is triggered
+for the following document:
 
     Some text.
 
@@ -1044,4 +1086,4 @@ To fix this, used fenced code blocks:
 
     Some more text.
 
-Or the reverse for the `indented` style.
+The reverse is true if the rule is configured to use the `indented` style.

data/docs/configuration.md

@@ -46,7 +46,7 @@ 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`
+* Config file: `ignore_front_matter true`
 * Default: false
 
 ### Specifying which rules mdl processes

data/docs/creating_rules.md

@@ -3,7 +3,7 @@
 Rules are written in ruby, using a rule DSL for defining rules. A rule looks
 like:
 
-    rule "MD000", "Rule description" do
+    rule "MY000", "Rule description" do
       tags :foo, :bar
       aliases 'rule-name'
       params :style => :foo

data/lib/mdl.rb

@@ -6,7 +6,6 @@ require 'mdl/ruleset'
 require 'mdl/style'
 require 'mdl/version'
 
-require 'json'
 require 'kramdown'
 
 module MarkdownLint
@@ -89,6 +88,7 @@ module MarkdownLint
         error_lines.each do |line|
           line += doc.offset # Correct line numbers for any yaml front matter
           if Config[:json]
+            require 'json'
             results << {
               'filename' => filename,
               'line' => line,

data/lib/mdl/doc.rb

@@ -34,7 +34,7 @@ module MarkdownLint
     # Create a new document given a string containing the markdown source
 
     def initialize(text, ignore_front_matter = false)
-      regex = /^---\n(.*?)---\n/m
+      regex = /^---\n(.*?)---\n\n?/m
       if ignore_front_matter and regex.match(text)
         @offset = regex.match(text).to_s.split("\n").length
         text.sub!(regex,'')

data/lib/mdl/rules.rb

@@ -585,6 +585,7 @@ rule "MD036", "Emphasis used instead of a header" do
       next unless [:em, :strong].include?(p.children[0].type)
       lines = doc.extract_text(p.children[0], "", false)
       next if lines.length > 1
+      next if lines.empty?
       next if lines[0].match(/[#{params[:punctuation]}]$/)
       errors << doc.element_linenumber(p)
     end
@@ -620,10 +621,10 @@ rule "MD039", "Spaces inside link text" do
   aliases 'no-space-in-links'
   check do |doc|
     doc.element_linenumbers(
-      doc.find_type_elements(:a).select{|e|
-      e.children[0].type == :text and (
-        e.children.first.value.start_with?(" ") or
-        e.children.last.value.end_with?(" "))}
+      doc.find_type_elements(:a).reject{|e|e.children.empty?}.select{|e|
+        e.children.first.type == :text && e.children.last.type == :text and (
+          e.children.first.value.start_with?(" ") or
+          e.children.last.value.end_with?(" "))}
     )
   end
 end

data/lib/mdl/style.rb

@@ -25,7 +25,13 @@ module MarkdownLint
     end
 
     def rule(id, params={})
+      if block_given?
+        raise "'rule' does not take a block. Should this definition go in a ruleset instead?"
+      end
       id = @aliases[id] if @aliases[id]
+      unless @all_rules[id]
+        raise "No such rule: #{id}"
+      end
       @rules << id
       @all_rules[id].params(params)
     end

data/lib/mdl/version.rb

@@ -1,3 +1,3 @@
 module MarkdownLint
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/mdl.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
 
   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_dependency 'mixlib-cli', '~> 2.1', '>= 2.1.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'bundler', '>= 1.12', '< 3'
   spec.add_development_dependency 'rake', '~> 11.2'
   spec.add_development_dependency 'minitest', '~> 5.9'
   spec.add_development_dependency 'pry', '~> 0.10'

data/test/rule_tests/emphasis_instead_of_headers.md

@@ -38,3 +38,5 @@ not trigger the rule.
 detected as a header because it's on multiple lines**
 
 **This also shouldn't be detected as a header as it ends in punctuation.**
+
+**[This as well since it is a link](https://example.com)**

data/test/rule_tests/spaces_inside_link_text.md

@@ -1,10 +1,28 @@
+[](http://bar/)
+
 [foo](http://bar/)
 
+["foo"](http:/bar/)
+
+[`foo`](http://bar/)
+
+[*foo*](http://bar/)
+
+[**foo**](http://bar/)
+
+[foo "bar"](http:/baz/)
+
 [foo ](http://bar/) {MD039}
 
 [ foo](http://bar/) {MD039}
 
 [ foo ](http://bar/) {MD039}
 
+[ "foo" ](http://bar/) {MD039}
+
+[ `foo` ](http://bar/) {MD039}
+
+[ *foo* ](http://bar/) {MD039}
+
 The following shouldn't break anything:
 [![Screenshot.png](/images/Screenshot.png)](/images/Screenshot.png)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mark Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-01 00:00:00.000000000 Z
+date: 2019-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -56,34 +56,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 2.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -135,10 +141,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".pre-commit-hooks.yaml"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
+- MAINTAINERS.md
 - README.md
 - Rakefile
 - bin/mdl
@@ -305,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Markdown lint tool