docs: allow ignoreReadme: true on individual tests to suppress from README (e.g., if just for coverage)

Author: brettz9

src/bin/generateReadme.js

@@ -7,6 +7,10 @@ import Gitdown from 'gitdown';
 import glob from 'glob';
 import _ from 'lodash';
 
+const removeReadmeIgnores = ({ignoreReadme}) => {
+  return !ignoreReadme;
+};
+
 const trimCode = (code) => {
   let lines = code.replace(/^\n/u, '').trimEnd().split('\n');
 
@@ -59,8 +63,8 @@ const getAssertions = () => {
     const codes = require(filePath);
 
     return {
-      invalid: _.map(codes.invalid, formatCodeSnippet),
-      valid: _.map(codes.valid, formatCodeSnippet),
+      invalid: codes.invalid.filter(removeReadmeIgnores).map(formatCodeSnippet),
+      valid: codes.valid.filter(removeReadmeIgnores).map(formatCodeSnippet),
     };
   });
 

test/rules/index.js

@@ -74,12 +74,14 @@ const ruleTester = new RuleTester();
   }
 
   assertions.invalid = assertions.invalid.map((assertion) => {
+    Reflect.deleteProperty(assertion, 'ignoreReadme');
     assertion.parserOptions = _.defaultsDeep(assertion.parserOptions, parserOptions);
 
     return assertion;
   });
 
   assertions.valid = assertions.valid.map((assertion) => {
+    Reflect.deleteProperty(assertion, 'ignoreReadme');
     if (assertion.errors) {
       throw new Error(`Valid assertions for rule ${ruleName} should not have an \`errors\` array.`);
     }