chore: update scripts

Author: Rel1cx

scripts/update-website.ts

@@ -3,33 +3,61 @@ import path from "node:path";
 
 import { glob } from "./lib/glob";
 
+/**
+ * Build script for processing and copying documentation to the website
+ *
+ * This script:
+ * 1. Collects rule documentation from ESLint plugins
+ * 2. Copies them to the website with proper naming
+ * 3. Processes the changelog
+ * 4. Sets up dependencies for the website build
+ */
+
+// Find all rule documentation markdown files from the various plugins
 const docs = glob(["packages/plugins/eslint-plugin-react-*/src/rules/*.md"]);
 
 // TODO: Generate the meta.json file as well
+// Process each documentation file:
+// - Extract plugin name and rule name
+// - Format destination path and rule title
+// - Build arrays of file paths and rule metadata
 const [
   files,
-  // rules,
+  // rules, // Currently commented out but would contain rule metadata
 ] = Array.from(docs).reduce<readonly [[string, string][], [string, string][]]>(
   ([files, rules], doc) => {
     const catename = /^packages\/plugins\/eslint-plugin-react-([^/]+)/u.exec(doc)?.[1] ?? "";
     const basename = path.parse(path.basename(doc)).name;
+
+    // Special handling for "react-x" plugin (the core plugin)
     const isPluginX = catename === "x";
+
+    // Format the rule name differently based on which plugin it belongs to
     const name = isPluginX
-      ? basename
-      : `${catename}-${basename}`;
+      ? basename // For react-x plugin: just use the rule name
+      : `${catename}-${basename}`; // For other plugins: prefix with category
+
+    // Format the rule title for display purposes
     const title = isPluginX
-      ? basename
-      : `${catename}/${basename}`;
+      ? basename // For react-x plugin: just use the rule name
+      : `${catename}/${basename}`; // For other plugins: use category/rule format
+
+    // Define destination path in the website content directory
     const dest = path.join("apps", "website", "content", "docs", "rules", `${name}.mdx`);
+
+    // Add to our accumulator arrays
     return [[...files, [doc, dest]], [...rules, [name, title]]] as const;
   },
   [[], []],
 );
 
+// Copy all documentation files to their respective destinations in parallel
 await Promise.all(files.map(([src, dest]) => fs.copyFile(src, dest)));
 
+// Write rule metadata to a JSON file for the website
 // fs.writeFileSync(path.join("apps", "website", "content", "docs", "rules", "data.json"), JSON.stringify(rules, null, 2));
 
+// Process the changelog file by adding frontmatter for the documentation system
 const changelog = await fs.readFile("CHANGELOG.md", "utf-8");
 
 const changelogWithFrontmatter = [
@@ -40,9 +68,13 @@ const changelogWithFrontmatter = [
   changelog,
 ].join("\n");
 
+// Write the processed changelog to the website content directory
 await fs.writeFile(path.join("apps", "website", "content", "docs", "changelog.md"), changelogWithFrontmatter);
 
-// workaround for @tailwindcss/postcss plugin not working with symlinked node_modules
+// Workaround for @tailwindcss/postcss plugin not working with symlinked node_modules:
+// 1. Find the actual (real) path of the symlinked fumadocs-ui
+// 2. Copy the entire directory to a non-symlinked location in the website deps
+// 3. This ensures Tailwind can properly process the CSS in these files
 const linkPath = path.join("apps", "website", "node_modules", "fumadocs-ui", "dist");
 const realPath = await fs.realpath(linkPath);
 const distPath = path.join("apps", "website", "deps", "fumadocs-ui");
@@ -51,10 +83,11 @@ await fs.rm(distPath, { force: true, recursive: true });
 await fs.cp(
   realPath,
   distPath,
-  { dereference: true, recursive: true },
+  { dereference: true, recursive: true }, // dereference ensures we copy actual files, not symlinks
 );
 
-// generate tailwindcss sources
+// Commented out: Generate tailwindcss source mapping configuration
+// This would tell Tailwind which directories to scan for CSS classes
 // const sourcePath = path.join("apps", "website", "app", "sources.css");
 // const sourceCode = [
 //   `@source "../deps/fumadocs-ui/**/*.js";`,