feat(nx-dev): update workspace conformance rule to check md files in general

juristr · juristr · commit d428eec060b5 · 2025-03-04T16:58:14.000+01:00
diff --git a/nx.json b/nx.json
@@ -253,7 +253,7 @@
         "rule": "@nx/workspace-plugin/conformance-rules/blog-description",
         "projects": ["docs"],
         "options": {
-          "mdGlobPattern": "blog/**/*.md"
+          "mdGlobPattern": "{blog,shared}/**/*.md"
         }
       },
       {
diff --git a/tools/workspace-plugin/src/conformance-rules/blog-description/index.ts b/tools/workspace-plugin/src/conformance-rules/blog-description/index.ts
@@ -12,7 +12,7 @@ export default createConformanceRule<{ mdGlobPattern: string }>({
   name: 'blog-description',
   category: 'consistency',
   description:
-    'Ensures that blog posts have a description in their frontmatter',
+    'Ensures that markdown documentation files have a description in their frontmatter',
   reporter: 'project-files-reporter',
   implementation: async ({ projectGraph, ruleOptions }) => {
     const violations: ProjectFilesViolation[] = [];
@@ -43,26 +43,32 @@ export default createConformanceRule<{ mdGlobPattern: string }>({
       const content = readFileSync(file, 'utf-8');
       const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
 
-      // Only check files with frontmatter
-      if (frontmatterMatch) {
-        try {
-          const frontmatter = yamlLoad(frontmatterMatch[1]) as Record<
-            string,
-            unknown
-          >;
+      if (!frontmatterMatch) {
+        violations.push({
+          message: 'Markdown documentation files must have frontmatter',
+          sourceProject: docsProject.name,
+          file: file,
+        });
+        continue;
+      }
+
+      try {
+        const frontmatter = yamlLoad(frontmatterMatch[1]) as Record<
+          string,
+          unknown
+        >;
 
-          if (!frontmatter.description) {
-            violations.push({
-              message:
-                'Blog posts with frontmatter must have a description field',
-              sourceProject: docsProject.name,
-              file: file,
-            });
-          }
-        } catch (e) {
-          // If YAML parsing fails, we skip the file
-          continue;
+        if (!frontmatter.description) {
+          violations.push({
+            message:
+              'Markdown documentation files must have a description field in their frontmatter',
+            sourceProject: docsProject.name,
+            file: file,
+          });
         }
+      } catch (e) {
+        // If YAML parsing fails, we skip the file
+        continue;
       }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,7 @@`
`253`	`253`	`"rule": "@nx/workspace-plugin/conformance-rules/blog-description",`
`254`	`254`	`"projects": ["docs"],`
`255`	`255`	`"options": {`
`256`		`- "mdGlobPattern": "blog/*/.md"`
	`256`	`+ "mdGlobPattern": "{blog,shared}/*/.md"`
`257`	`257`	`}`
`258`	`258`	`},`
`259`	`259`	`{`