mdl 0.5.0 → 0.10.0

data/test/test_ruledocs.rb

@@ -1,52 +0,0 @@
-require_relative 'setup_tests'
-
-# Ensures there is documentation for every rule, and that the
-# descriptions/tags/etc in the rule match those in the documentation
-class TestRuledocs < Minitest::Test
-  @@ruleset = MarkdownLint::RuleSet.new
-  @@ruleset.load_default
-  @@rules = @@ruleset.rules
-
-  def setup
-    @ruledocs = load_ruledocs
-  end
-
-  def load_ruledocs
-    rules = Hash.new({}) # Default to {} if no docs for the rule
-    curr_rule = nil
-    rules_file = File.expand_path('../../docs/RULES.md', __FILE__)
-    File.read(rules_file).split("\n").each do |l|
-      if l.match(/^## (MD\d+) - (.*)$/)
-        rules[$1] = { :description => $2, :params => {} }
-        curr_rule = $1
-      elsif l.match(/^Tags: (.*)$/)
-        rules[curr_rule][:tags] = $1.split(',').map{|i| i.strip.to_sym}
-      elsif l.match(/^Aliases: (.*)$/)
-        rules[curr_rule][:aliases] = $1.split(',').map{|i| i.strip}
-      elsif l.match(/^Parameters: (.*)(\(.*\)?)$/)
-        rules[curr_rule][:params] = $1.split(',').map{|i| i.strip.to_sym}
-      end
-    end
-    rules
-  end
-
-  @@rules.each do |id, r|
-    define_method("test_ruledoc_description_#{id}") do
-      assert_equal r.description, @ruledocs[id][:description]
-    end
-    define_method("test_ruledoc_tags_#{id}") do
-      assert_equal r.tags, @ruledocs[id][:tags]
-    end
-    define_method("test_ruledoc_aliases_#{id}") do
-      assert_equal r.aliases, @ruledocs[id][:aliases]
-    end
-    define_method("test_ruledoc_params_#{id}") do
-      assert_equal r.params.keys.sort, (@ruledocs[id][:params] || []).sort
-    end
-  end
-
-  def test_ruledoc_for_every_rule
-    # (and vice versa)
-    assert_equal @@rules.keys, @ruledocs.keys
-  end
-end

data/test/test_rules.rb

@@ -1,58 +0,0 @@
-require_relative 'setup_tests'
-
-class TestRules < Minitest::Test
-
-  def get_expected_errors(lines)
-    # Looks for lines tagged with {MD123} to signify that a rule is expected to
-    # fire for this line. It also looks for lines tagged with {MD123:1} to
-    # signify that a rule is expected to fire on another line (the line number
-    # after the colon).
-    expected_errors = {}
-    re = /\{(MD\d+)(?::(\d+))?\}/
-    lines.each_with_index do |line, num|
-      m = re.match(line)
-      while m
-        expected_errors[m[1]] ||= []
-        if m[2]
-          expected_line = m[2].to_i
-        else
-          expected_line = num + 1 # 1 indexed lines
-        end
-        expected_errors[m[1]] << expected_line
-        m = re.match(line, m.end(0))
-      end
-    end
-    expected_errors
-  end
-
-  def do_lint(filename)
-    # Check for a test_case_style.rb style file for individual tests
-    style_file = filename.sub(/.md$/, '_style.rb')
-    if ! File.exist?(style_file)
-      style_file = "#{File.dirname(filename)}/default_test_style.rb"
-    end
-
-    ruleset = MarkdownLint::RuleSet.new
-    ruleset.load_default
-    rules = ruleset.rules
-    style = MarkdownLint::Style.load(style_file, rules)
-    rules.select! {|r| style.rules.include?(r)}
-
-    doc = MarkdownLint::Doc.new(File.read(filename))
-    expected_errors = get_expected_errors(doc.lines)
-    actual_errors = {}
-    rules.sort.each do |id, rule|
-      error_lines = rule.check.call(doc)
-      if error_lines and not error_lines.empty?
-        actual_errors[id] = error_lines
-      end
-    end
-    assert_equal expected_errors, actual_errors
-  end
-
-  Dir[File.expand_path("../rule_tests/*.md", __FILE__)].each do |filename|
-    define_method("test_#{File.basename(filename, '.md')}") do
-      do_lint(filename)
-    end
-  end
-end

data/tools/README.md

@@ -1,3 +0,0 @@
-This directory contains a few scripts that, while not part of markdownlint
-directly, can be useful for inspecting markdown documents and debugging
-issues.

data/tools/docker/Dockerfile

@@ -1,13 +0,0 @@
-FROM alpine:3.4
-
-MAINTAINER Mark Harrison <mark@mivok.net>
-
-RUN apk update && \
-    apk add --no-cache ruby && \
-    gem install --no-rdoc --no-ri mdl && \
-    mkdir /data
-
-WORKDIR /data
-
-ENTRYPOINT ["mdl"]
-CMD ["--help"]

data/tools/docker/README.md

@@ -1,19 +0,0 @@
-# Docker container for markdownlint
-
-## Using the docker image
-
-To check a single file:
-
-    docker run --rm -v ${PWD}:/data mivok/markdownlint myfile.md
-
-Or, to check all files in a directory:
-
-    docker run --rm -v ${PWD}:/data mivok/markdownlint .
-
-## Building from a docker file
-
-The following will tag and upload a new release. Replace X.Y.Z as appropriate.
-
-    docker build -t mivok/markdownlint:latest -t mivok/markdownlint:X.Y.Z .
-    docker push mivok/markdownlint:latest
-    docker push mivok/markdownling:X.Y.Z

data/tools/test_location.rb

@@ -1,20 +0,0 @@
-#!/usr/bin/env ruby
-# Script for identifying when markdownlint is receiving an incorrect line
-# number for an element. It checks all headers, then grabs the lines
-# associated with the headers according to markdown and compares the content,
-# printing out any that don't match.
-require 'mdl/doc'
-require 'pry'
-
-text = File.read(ARGV[0])
-unless ARGV[1].nil?
-  # If we provide a second argument, then start the document from line N of
-  # the original file.
-  text = text.split("\n")[ARGV[1].to_i - 1..-1].join("\n")
-end
-doc = MarkdownLint::Doc.new(text)
-headers = doc.find_type(:header)
-bad_headers = headers.select do |e|
-   doc.element_line(e).nil? || ! doc.element_line(e).include?(e[:raw_text])
-end
-pp bad_headers

data/tools/view_markdown.rb

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-# Quick script for viewing getting at kramdown's and markdownlint's view of a
-# markdown file
-require 'mdl/doc'
-require 'pry'
-
-
-doc = MarkdownLint::Doc.new_from_file(ARGV[0])
-children = doc.parsed.root.children
-
-binding.pry