[cleanup] Remove unused template validation rule. (#326)

[cleanup] Remove unused rule. Improve documentation. Rename ATTERN-TEMPLATE-RULE-003 to ATTERN-TEMPLATE-RULE-002.

Author: spier

lint/pattern-template.js

@@ -21,38 +21,12 @@ module.exports = [
 },
 {
     names: ["PATTERN-TEMPLATE-RULE-002"],
-    description: "Standard Headlines",
-    tags: ["headings", "headers", "pattern-template"],
-    function: (params, onError) => {
-        var allowedHeadlines = "Title|Patlet|Problem|Story|Context|Forces|Solutions|Resulting Context|Known Instances|Status|Author(s)|Acknowledgements";
-        var re = new RegExp(`^## (${allowedHeadlines.replace(/(?=[\(\)])/g, '\\')})\\s*$`,"m");
-        // console.log(re);
-
-        params.tokens.filter(function filterToken(token) {
-            return token.type === "heading_open";
-        }).forEach(function forToken(token) {
-            if (token.tag === "h2") {
-                if (re.test(token.line)) {
-                    return;
-                }
-                // if (/^## ()$/m.test(token.line)) {
-                //     return;
-                // }
-
-                return onError({
-                    lineNumber: token.lineNumber,
-                    detail: "Allowed types are: " + allowedHeadlines.replace(/\|/g, ', '),
-                    context: token.line
-                });
-            }
-        });
-    }
-},
-{
-    names: ["PATTERN-TEMPLATE-RULE-003"],
     description: "Mandatory template sections",
+    information: new URL("https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md"),
     tags: ["headings", "headers", "pattern-template"],
     function: (params, onError) => {
+        // A list of all mandatory headlines.
+        // headline name (from template): regexp of all permitted headline spellings
         var mandatoryHeadlines = {
           "Title": "Title",
           "Patlet": "Patlet",
@@ -68,8 +42,8 @@ module.exports = [
 
         var collectedHeadlines = ""
 
-        // collect all h2 headlines
-        // (only the headline text itself, removing markdown sytnax and whitespace)
+        // Collect all h2 (##) headlines.
+        // Only the headline text, removing markdown and whitespaces.
         params.tokens.filter(function filterToken(token) {
             return token.type === "heading_open";
         }).forEach(function forToken(token) {
@@ -83,7 +57,7 @@ module.exports = [
             }
         });
 
-        // confirm if all `mandatoryHeadlines` exist exactly once in the `collectedHeadlines`
+        // confirm if all `mandatoryHeadlines` exist and exist exactly once in the `collectedHeadlines`
         var errorsFound = [];
 
         let headline;

lint/pattern-template.yml

@@ -2,5 +2,4 @@ default: false # excludes all default markdownlint rules
 
 # Custom rules:
 PATTERN-TEMPLATE-RULE-001: true
-# PATTERN-TEMPLATE-RULE-002: true # will likely stop using this in favor of rule 003
-PATTERN-TEMPLATE-RULE-003: true
+PATTERN-TEMPLATE-RULE-002: true