Add MD043 required-headers "Required header structure" (fixes #22).

test/break-all-the-rules.json

@@ -1,4 +1,11 @@
 {
   "default": true,
-  "MD041": true
+  "MD041": true,
+  "MD043": {
+    "headers": [
+      "## Header 1 {MD002} {MD041}",
+      "#### Header 2 {MD001}",
+      "# Broken"
+    ]
+  }
 }

test/break-all-the-rules.md

@@ -2,7 +2,7 @@
 
 #### Header 2 {MD001}
 
-# Header 3 {MD003} #
+# Header 3 {MD003} {MD043} #
 
 * list
  +  list {MD004} {MD006} {MD007} {MD030}

test/markdownlint-test.js

@@ -632,6 +632,44 @@ module.exports.customFrontMatter = function customFrontMatter(test) {
   });
 };
 
+module.exports.readmeHeaders = function readmeHeaders(test) {
+  test.expect(2);
+  markdownlint({
+    "files": "README.md",
+    "config": {
+      "default": false,
+      "MD043": {
+        "headers": [
+          "# markdownlint",
+          "## Install",
+          "## Overview",
+          "### Related",
+          "## Demonstration",
+          "## Rules / Aliases",
+          "## Tags",
+          "## Configuration",
+          "## API",
+          "### options",
+          "#### options.files",
+          "#### options.strings",
+          "#### options.frontMatter",
+          "#### options.config",
+          "### callback",
+          "### result",
+          "## Usage",
+          "## Browser",
+          "## History"
+        ]
+      }
+    }
+  }, function callback(err, result) {
+    test.ifError(err);
+    var expected = { "README.md": {} };
+    test.deepEqual(result, expected, "Unexpected issues.");
+    test.done();
+  });
+};
+
 module.exports.filesArrayNotModified = function filesArrayNotModified(test) {
   test.expect(2);
   var files = [
@@ -733,7 +771,7 @@ module.exports.missingStringValue = function missingStringValue(test) {
 };
 
 module.exports.ruleNamesUpperCase = function ruleNamesUpperCase(test) {
-  test.expect(38);
+  test.expect(39);
   rules.forEach(function forRule(rule) {
     test.equal(rule.name, rule.name.toUpperCase(), "Rule name not upper-case.");
   });
@@ -741,7 +779,7 @@ module.exports.ruleNamesUpperCase = function ruleNamesUpperCase(test) {
 };
 
 module.exports.uniqueAliases = function uniqueAliases(test) {
-  test.expect(76);
+  test.expect(78);
   var tags = [];
   rules.forEach(function forRule(rule) {
     Array.prototype.push.apply(tags, rule.tags);
@@ -758,7 +796,7 @@ module.exports.uniqueAliases = function uniqueAliases(test) {
 };
 
 module.exports.readme = function readme(test) {
-  test.expect(99);
+  test.expect(101);
   var tagToRules = {};
   rules.forEach(function forRule(rule) {
     rule.tags.forEach(function forTag(tag) {
@@ -819,7 +857,7 @@ module.exports.readme = function readme(test) {
 };
 
 module.exports.doc = function doc(test) {
-  test.expect(281);
+  test.expect(289);
   fs.readFile("doc/Rules.md", shared.utf8Encoding,
     function readFile(err, contents) {
       test.ifError(err);

test/required-headers-all-optional.json

@@ -0,0 +1,6 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [ "*" ]
+  }
+}

test/required-headers-all-optional.md

@@ -0,0 +1,11 @@
+# One
+
+## Two
+
+### THREE
+
+#### four
+
+##### Five
+
+###### SiX

test/required-headers-all-present.json

@@ -0,0 +1,13 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [
+      "# One",
+      "## Two",
+      "### Three",
+      "## Four",
+      "## Five",
+      "### Six"
+    ]
+  }
+}

test/required-headers-all-present.md

@@ -0,0 +1,11 @@
+# One
+
+## Two
+
+### THREE
+
+## four
+
+## Five
+
+### SiX

test/required-headers-missing-first.json

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [
+      "# One",
+      "## Two",
+      "### Three"
+    ]
+  }
+}

test/required-headers-missing-first.md

@@ -0,0 +1,5 @@
+text
+
+## Two {MD002} {MD043}
+
+### Three

test/required-headers-missing-last.json

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [
+      "# One",
+      "## Two",
+      "### Three"
+    ]
+  }
+}

test/required-headers-missing-last.md

@@ -0,0 +1,7 @@
+One
+===
+
+Two
+---
+
+{MD043}

test/required-headers-missing-middle.json

@@ -0,0 +1,11 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [
+      "# One",
+      "## Two",
+      "### Three",
+      "#### Four"
+    ]
+  }
+}

test/required-headers-missing-middle.md

@@ -0,0 +1,5 @@
+# One #
+
+### Three {MD001} {MD043} ###
+
+#### Four ####

test/required-headers-none.json

@@ -0,0 +1,6 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": []
+  }
+}

test/required-headers-none.md

@@ -0,0 +1,5 @@
+# One {MD043}
+
+## Two
+
+### Three

test/required-headers-optional-first.json

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [
+      "*",
+      "### Three",
+      "#### Four"
+    ]
+  }
+}

test/required-headers-optional-first.md

@@ -0,0 +1,7 @@
+# One
+
+## Two
+
+### Three
+
+#### Four

test/required-headers-optional-last.json

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [
+      "# One",
+      "## Two",
+      "*"
+    ]
+  }
+}

test/required-headers-optional-last.md

@@ -0,0 +1,7 @@
+# One
+
+## Two
+
+### Three
+
+#### Four

test/required-headers-optional-middle.json

@@ -0,0 +1,12 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [
+      "# One",
+      "*",
+      "### Three",
+      "*",
+      "##### Five"
+    ]
+  }
+}

test/required-headers-optional-middle.md

@@ -0,0 +1,9 @@
+# One #
+
+## Two ##
+
+### Three ###
+
+#### Four ####
+
+##### Five #####

test/required-headers-optional-redundant.json

@@ -0,0 +1,11 @@
+{
+  "default": true,
+  "MD043": {
+    "headers": [
+      "# One",
+      "*",
+      "*",
+      "#### Four"
+    ]
+  }
+}

test/required-headers-optional-redundant.md

@@ -0,0 +1,7 @@
+# One
+
+## Two
+
+### Three
+
+#### Four