fix: Don't fail doc parsing on new docs

getappmap · Mar 17, 2022 · 58761f6 · 58761f6
1 parent 93d57c5
commit 58761f6
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/rules/lib/parseRuleDescription.ts b/src/rules/lib/parseRuleDescription.ts
@@ -1,13 +1,14 @@
 import fs from 'fs';
-import { ValidationError } from '../../errors';
 import { join } from 'path';
 
 export default function parseRuleDescription(id: string): string {
   const content = fs.readFileSync(join(__dirname, `../../../doc/rules/${id}.md`), 'utf-8');
-  const propertiesContent = content.match(/---\n((?:.*\n)+)---\n((?:.*\n)+?)###/);
+  const propertiesContent = content.match(/---\n((?:.*\n)+)---\n((?:.*\n)+?)##?#?/);
 
   if (!propertiesContent) {
-    throw new ValidationError(`Unable to read description for rule "${id}".`);
+    // This is probably a new doc that doesn't have front matter yet.
+    // It's all description.
+    return content;
   }
 
   return propertiesContent[2].replace(/\n/g, ' ').trim();