bug: fixed bug in the publishing pipeline.

Author: PaulJPhilp

content/published/safely-bracket-resource-usage.mdx

@@ -1,7 +1,7 @@
 ---
 
 title: "Safely Bracket Resource Usage with `acquireRelease`"
-id: "acquire-release-bracket"
+id: "safely-bracket-resource-usage"
 skillLevel: "beginner"
 useCase: ["Resource Management", "File Handling", "Database Connections", "Network Requests"]
 summary: "Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur."

scripts/frontmatter-validator.ts

@@ -0,0 +1,105 @@
+#!/usr/bin/env tsx
+
+import fs from 'fs/promises';
+import path from 'path';
+import { Command } from 'commander';
+import matter from 'gray-matter';
+
+// Define command line options
+const program = new Command();
+program
+  .requiredOption('--indir <directory>', 'Input directory containing MDX files')
+  .option('--count <number>', 'Number of files to process', parseInt)
+  .parse(process.argv);
+
+const options = program.opts();
+
+// Validate required options
+if (!options.indir) {
+  console.error('❌ Error: --indir is required');
+  process.exit(1);
+}
+
+const inputDir = path.resolve(options.indir);
+const count = options.count;
+
+const main = async () => {
+  try {
+    // Ensure directory exists
+    await fs.access(inputDir);
+
+    console.log(`Validating frontmatter in MDX files in ${inputDir}`);
+
+    // Get all MDX files from input directory
+    const files = await fs.readdir(inputDir);
+    const mdxFiles = files.filter(file => file.endsWith('.mdx') && file !== 'index.mdx');
+
+    console.log(`Found ${mdxFiles.length} MDX files`);
+
+    // Limit the number of files to process if count is specified
+    const filesToProcess = count ? mdxFiles.slice(0, count) : mdxFiles;
+    console.log(`Processing ${filesToProcess.length} files from ${inputDir}`);
+
+    let hasErrors = false;
+    let errorCount = 0;
+
+    for (const mdxFile of filesToProcess) {
+      const baseName = path.basename(mdxFile, '.mdx');
+      const mdxFilePath = path.join(inputDir, mdxFile);
+
+      try {
+        // Read MDX file content
+        const mdxContent = await fs.readFile(mdxFilePath, 'utf-8');
+        
+        // Parse frontmatter
+        const { data } = matter(mdxContent);
+        
+        // Validate frontmatter has required fields
+        if (!data.id) {
+          console.error(`❌ Error: No 'id' field in frontmatter of ${mdxFile}`);
+          hasErrors = true;
+          errorCount++;
+          continue;
+        }
+
+        // Check if frontmatter id matches filename
+        if (data.id !== baseName) {
+          console.error(`❌ Error: Frontmatter id "${data.id}" does not match filename "${baseName}" in ${mdxFile}`);
+          hasErrors = true;
+          errorCount++;
+          continue;
+        }
+
+        // Verify the file exists
+        const mdxExists = await fs.access(mdxFilePath)
+          .then(() => true)
+          .catch(() => false);
+
+        if (!mdxExists) {
+          console.error(`❌ Error: MDX file ${mdxFile} does not exist but is referenced in frontmatter`);
+          hasErrors = true;
+          errorCount++;
+          continue;
+        }
+
+        console.log(`✅ Validated frontmatter for ${mdxFile}`);
+      } catch (error: any) {
+        console.error(`❌ Error processing ${mdxFile}: ${error?.message || String(error)}`);
+        hasErrors = true;
+        errorCount++;
+      }
+    }
+
+    if (hasErrors) {
+      console.error(`❌ Fatal error: Found ${errorCount} validation errors`);
+      process.exit(1);
+    } else {
+      console.log(`✨ Validation complete! All ${filesToProcess.length} files have valid frontmatter.`);
+    }
+  } catch (error: any) {
+    console.error(`❌ Fatal error: ${error?.message || String(error)}`);
+    process.exit(1);
+  }
+};
+
+main();

scripts/validate_and_generate.ts

@@ -15,20 +15,26 @@ const SRC_DIR = path.join(process.cwd(), "content/src");
 console.log("Starting validation and README generation process...");
 
 try {
-  // Step 1: Run the pattern validator to ensure all TypeScript code blocks match source files
+  // Step 1: Validate frontmatter ids match filenames
+  console.log("\n🔍 Validating frontmatter in MDX files...");
+  execSync(`npx tsx ${path.join(SCRIPTS_DIR, "frontmatter-validator.ts")} --indir ${PUBLISHED_DIR}`, {
+    stdio: "inherit",
+  });
+
+  // Step 2: Run the pattern validator to ensure all TypeScript code blocks match source files
   console.log("\n🔍 Validating that all TypeScript code blocks match source files...");
   execSync(`npx tsx ${path.join(SCRIPTS_DIR, "pattern-validator.ts")} --indir ${PUBLISHED_DIR} --srcdir ${SRC_DIR}`, {
     stdio: "inherit",
   });
 
-  // Step 2: Generate the README.md
+  // Step 3: Generate the README.md
   console.log("\n📝 Generating README.md...");
   execSync(`npx tsx ${path.join(SCRIPTS_DIR, "generate_readme.ts")}`, {
     stdio: "inherit",
   });
 
   console.log("\n✅ Validation and README generation completed successfully!");
-  console.log("All TypeScript code blocks in MDX files match their source files.");
+  console.log("All MDX files have valid frontmatter and TypeScript code blocks match source files.");
   console.log("README.md has been generated with links to all validated patterns.");
 
 } catch (error) {