Make linter and checker happy, change operation slugs, handle types

src/content/reference/config.ts

@@ -14,20 +14,22 @@ const returnSchema = z.object({
 
 const exampleSchema = z.string();
 
+export const referenceSchema = z.object({
+  title: z.string(),
+  module: z.string(),
+  submodule: z.string(),
+  file: z.string(),
+  description: z.string(),
+  line: z.number(),
+  params: z.array(paramSchema).optional(),
+  itemtype: z.string().optional(),
+  class: z.string().optional(),
+  chainable: z.boolean().optional(),
+  return: returnSchema.optional(),
+  example: z.array(exampleSchema).optional(),
+});
+
 export const referenceCollection = defineCollection({
   type: "content",
-  schema: z.object({
-    title: z.string(),
-    module: z.string(),
-    submodule: z.string(),
-    file: z.string(),
-    description: z.string(),
-    line: z.number(),
-    params: z.array(paramSchema).optional(),
-    itemtype: z.string().optional(),
-    class: z.string().optional(),
-    chainable: z.boolean().optional(),
-    return: returnSchema.optional(),
-    example: z.array(exampleSchema).optional(),
-  }),
+  schema: referenceSchema,
 });

src/content/types.ts

@@ -1,15 +1,15 @@
-import { referenceCollection } from "./reference/config";
+import type { z } from "astro/zod";
+import { referenceSchema } from "./reference/config";
 
 type AstroBaseContentType = {
   id: string;
   slug: string;
   body: string;
-  render: function;
   collection: string;
 };
 
 type WithAstroBase<T> = T & AstroBaseContentType;
 
 export type ReferenceDocContentItem = WithAstroBase<
-  z.infer<typeof referenceCollection>
+  z.infer<typeof referenceSchema>
 >;

src/pages/reference/[...id].astro

@@ -18,8 +18,12 @@ export async function getStaticPaths() {
 const { id } = Astro.params;
 const referenceEntries = await getCollection("reference");
 
-const entriesById = referenceEntries.reduce((acc, entry) => {
-  acc[entry.id.replace(/\.mdx$/, "")] = entry;
+// TODO: Find correct way to handle Zod -> TS type inference
+const entriesById: Record<string, any> = referenceEntries.reduce<
+  Record<string, any>
+>((acc, entry) => {
+  const id = entry.id.replace(/\.mdx$/, "");
+  acc[id] = entry;
   return acc;
 }, {});
 

src/pages/reference/index.astro

@@ -1,12 +1,11 @@
 ---
 import { getCollection } from "astro:content";
-import type { ReferenceDocContentItem } from "../../content/types";
 const referenceEntries = await getCollection("reference");
 ---
 
 <ul>
   {
-    referenceEntries.map((refEntry: ReferenceDocContentItem) => (
+    referenceEntries.map((refEntry) => (
       <li>
         <a href={`/reference/${refEntry.id.replace(/\.mdx$/, "")}`}>
           {refEntry.data.title}

src/scripts/builders/reference.ts

@@ -14,6 +14,7 @@ import type {
   ReferenceMDXDoc,
   ReferenceModulePathTree,
 } from "../../../types/builders.interface";
+import { sanitizeName } from "../utils";
 
 /* Base path for the content directory */
 const prefix = "./src/content/reference/en/";
@@ -126,10 +127,6 @@ const convertToMDX = async (
 ) => {
   if (!doc || !doc.name || !doc.file) return;
 
-  // Some names contain characters that need to be sanitized for MDX
-  const sanitizeName = (name: string) =>
-    name.replace(/</g, "&lt;").replace(/>/g, "&gt;");
-
   let frontMatterArgs = {
     title: sanitizeName(doc.name),
     module: doc.module,
@@ -231,17 +228,18 @@ const getClassFrontmatter = (doc: ReferenceClassDefinition) => {
   };
 };
 
+// TODO: Add back in when the pathing issue is resolved
 /* Adds class method previews to the class docs */
-const addMemberMethodPreviewsToClassDocs = (doc: ReferenceClassItemMethod) => {
-  if (!memberMethodPreviews[doc.class]) {
-    memberMethodPreviews[doc.class] = {};
-  }
-  const classMethodPath = `../${modulePathTree.classes[doc.class][doc.name]}`;
-  memberMethodPreviews[doc.class][doc.name] = {
-    description: doc.description,
-    path: classMethodPath,
-  };
-};
+// const addMemberMethodPreviewsToClassDocs = (doc: ReferenceClassItemMethod) => {
+//   if (!memberMethodPreviews[doc.class]) {
+//     memberMethodPreviews[doc.class] = {};
+//   }
+//   const classMethodPath = `../${modulePathTree.classes[doc.class][doc.name]}`;
+//   memberMethodPreviews[doc.class][doc.name] = {
+//     description: doc.description,
+//     path: classMethodPath,
+//   };
+// };
 
 /* Converts all docs to MDX */
 const convertDocsToMDX = async (
@@ -277,8 +275,24 @@ const saveMDX = async (mdxDocs: ReferenceMDXDoc[]) => {
   console.log("Saving MDX...");
   for (const { mdx, savePath, name } of mdxDocs) {
     try {
+      let fileName = sanitizeName(name);
+      // TODO: Place elsewhere
+      if (fileName[0] === "&") {
+        // Need special cases for >, >=, <, <=, and ===
+        if (fileName === "&gt;") {
+          fileName = "gt";
+        } else if (fileName === "&gt;=") {
+          fileName = "gte";
+        } else if (fileName === "&lt;") {
+          fileName = "lt";
+        } else if (fileName === "&lt;=") {
+          fileName = "lte";
+        } else if (fileName === "&equals;") {
+          fileName = "equals";
+        }
+      }
       await fs.mkdir(savePath, { recursive: true });
-      await fs.writeFile(`${savePath}/${name}.mdx`, mdx.toString());
+      await fs.writeFile(`${savePath}/${fileName}.mdx`, mdx.toString());
     } catch (err) {
       console.error(`Error saving MDX: ${err}`);
     }

src/scripts/parsers/reference.ts

@@ -1,4 +1,4 @@
-import { cloneLibraryRepo, readFile } from "./utils";
+import { cloneLibraryRepo, readFile } from "../utils";
 import { exec } from "child_process";
 import path from "path";
 import { fileURLToPath } from "url";

src/scripts/parsers/utils.ts → src/scripts/utils.ts

@@ -141,3 +141,7 @@ export const fixAbsolutePathInPreprocessor = async (localSavePath: string) => {
     return false;
   }
 };
+
+/* Some names contain characters that need to be sanitized for pathing, MDX, etc. */
+export const sanitizeName = (name: string) =>
+  name.replace(/</g, "&lt;").replace(/>/g, "&gt;");