erudit 4.0.0-dev.3 → 4.0.0-dev.5

package/server/erudit/content/global/build.ts

@@ -1,297 +1,300 @@
-import { readFileSync, writeFileSync } from 'node:fs';
-import { topicParts, type TopicPart } from '@erudit-js/core/content/topic';
-import { $CONTENT } from './singleton';
-
-// Call singleton to trigger initialization
-$CONTENT;
-
-let initialBuild = true;
-
-const contentRoot = () => `${ERUDIT.config.paths.project}/content`;
-
-export async function buildGlobalContent() {
-    ERUDIT.log.debug.start('Building global content...');
-
-    const isInitial = initialBuild;
-    initialBuild = false;
-
-    if (!isInitial && !hasContentChanges()) {
-        ERUDIT.log.info('Skipping global content — nothing changed.');
-        return;
-    }
-
-    const linkObject = await buildLinkObject();
-
-    const linkTypes = linkObjectToTypes(linkObject);
-    writeFileSync(
-        ERUDIT.config.paths.build + '/types/content.d.ts',
-        linkTypes,
-        'utf-8',
-    );
-
-    ERUDIT.log.success(
-        isInitial
-            ? 'Global content build complete!'
-            : 'Global content updated!',
-    );
-}
-
-function hasContentChanges() {
-    for (const file of (ERUDIT.changedFiles || new Set<string>()).values()) {
-        if (file.startsWith(`${contentRoot()}/`)) {
-            return true;
-        }
-    }
-
-    return false;
-}
-
-function linkObjectToTypes(linkObject: any): string {
-    const indent = (level: number) => '    '.repeat(level);
-
-    function toCamelCase(str: string): string {
-        return str.replace(/[-_](.)/g, (_, char) => char.toUpperCase());
-    }
-
-    function processObject(obj: any, level: number): string {
-        const lines: string[] = [];
-
-        for (const [key, value] of Object.entries(obj) as [string, any][]) {
-            if (key === '__jsdoc' || key === '__typeguard') continue;
-
-            const camelKey = toCamelCase(key);
-
-            // Add JSDoc comment if present
-            if (value && typeof value === 'object' && value.__jsdoc) {
-                const jsdocLines = value.__jsdoc.split('\n');
-                jsdocLines.forEach((line: string) => {
-                    lines.push(indent(level) + line);
-                });
-            }
-
-            // Determine if value has nested properties (excluding __jsdoc and __typeguard)
-            const hasNestedProps =
-                value &&
-                typeof value === 'object' &&
-                Object.keys(value).some(
-                    (k) => k !== '__jsdoc' && k !== '__typeguard',
-                );
-
-            // Get the typeguard from the object, default to GlobalContentItemTypeguard
-            const typeguard =
-                value?.__typeguard || 'GlobalContentItemTypeguard';
-
-            if (hasNestedProps) {
-                lines.push(indent(level) + `${camelKey}: ${typeguard} & {`);
-                lines.push(processObject(value, level + 1));
-                lines.push(indent(level) + `}`);
-            } else {
-                lines.push(indent(level) + `${camelKey}: ${typeguard} & {}`);
-            }
-        }
-
-        return lines.join('\n');
-    }
-
-    const body = processObject(linkObject, 2);
-
-    return `import type {
-    GlobalContentItemTypeguard,
-    GlobalContentTopicPartTypeguard,
-    GlobalContentUniqueTypeguard,
-} from '@erudit-js/core/content/global';
-
-export {};
-
-declare global {
-    const $CONTENT: {
-${body}
-    }
-}`;
-}
-
-/**
- * Loop through the content navigation tree and build a nested object representing the link structure:
- */
-async function buildLinkObject() {
-    const linkTree: any = {};
-
-    await ERUDIT.contentNav.walk((navItem) => {
-        // Navigate to the correct position in the tree based on the full path
-        let cursor = linkTree;
-        const pathParts = navItem.fullId.split('/');
-
-        // Navigate through parent parts
-        for (let i = 0; i < pathParts.length - 1; i++) {
-            cursor = cursor[pathParts[i]];
-        }
-
-        //
-        //
-        //
-
-        if (navItem.type === 'page') {
-            const pathToFile = `${ERUDIT.config.paths.project}/content/${navItem.contentRelPath}/${navItem.type}.tsx`;
-            const moduleContent = readFileSync(pathToFile, 'utf-8');
-            const title = tryGetTitle(moduleContent);
-
-            const jsdoc = jsdocLines([
-                title ? `Title: ${title}` : undefined,
-                `Type: ${navItem.type}`,
-                `Location: [${navItem.contentRelPath}](file:///${pathToFile})`,
-            ]);
-
-            cursor[navItem.idPart] = {
-                __typeguard: 'GlobalContentItemTypeguard',
-                __jsdoc: `
-/**
-${jsdoc}
- */
-                `.trim(),
-                ...tryGetUniquesObject(
-                    moduleContent,
-                    pathToFile,
-                    navItem.contentRelPath,
-                ),
-            };
-        } else if (navItem.type === 'topic') {
-            const pathToTopicFile = `${ERUDIT.config.paths.project}/content/${navItem.contentRelPath}/topic.ts`;
-            const topicModuleContent = readFileSync(pathToTopicFile, 'utf-8');
-            const title = tryGetTitle(topicModuleContent);
-
-            const jsdoc = jsdocLines([
-                title ? `Title: ${title}` : undefined,
-                `Type: topic`,
-                `Location: [${navItem.contentRelPath}](file:///${pathToTopicFile})`,
-            ]);
-
-            cursor[navItem.idPart] = {
-                __typeguard: 'GlobalContentItemTypeguard',
-                __jsdoc: `
-/**
-${jsdoc}
- */
-                `.trim(),
-            };
-
-            for (const part of topicParts) {
-                try {
-                    const pathToFile = `${ERUDIT.config.paths.project}/content/${navItem.contentRelPath}/${part}.tsx`;
-                    const partContent = readFileSync(pathToFile, 'utf-8');
-
-                    const jsdoc = jsdocLines([
-                        title ? `Title: ${title}` : undefined,
-                        `Type: topic`,
-                        `Part: ${part}`,
-                        `Location: [${navItem.contentRelPath}](file:///${pathToFile})`,
-                    ]);
-
-                    cursor[navItem.idPart][part as TopicPart] = {
-                        __typeguard: 'GlobalContentTopicPartTypeguard',
-                        __jsdoc: `
-/**
-${jsdoc}
- */
-                        `.trim(),
-                        ...tryGetUniquesObject(
-                            partContent,
-                            pathToFile,
-                            navItem.contentRelPath,
-                        ),
-                    };
-                } catch {}
-            }
-        } else {
-            const pathToFile = `${ERUDIT.config.paths.project}/content/${navItem.contentRelPath}/${navItem.type}.ts`;
-            const moduleContent = readFileSync(pathToFile, 'utf-8');
-            const title = tryGetTitle(moduleContent);
-
-            const jsdoc = jsdocLines([
-                title ? `Title: ${title}` : undefined,
-                `Type: ${navItem.type}`,
-                `Location: [${navItem.contentRelPath}](file:///${pathToFile})`,
-            ]);
-
-            cursor[navItem.idPart] = {
-                __typeguard: 'GlobalContentItemTypeguard',
-                __jsdoc: `
-/**
-${jsdoc}
- */
-                `.trim(),
-            };
-        }
-    });
-
-    return linkTree;
-}
-
-function tryGetTitle(moduleContent: string) {
-    const titleMatch = moduleContent.match(/title:\s*['"`](.*?)['"`]/);
-
-    if (titleMatch) {
-        return titleMatch[1].trim();
-    }
-}
-
-function jsdocLines(lines: any[]) {
-    return lines
-        .filter(Boolean)
-        .map((line) => ` * * ${line}`)
-        .join('\n');
-}
-
-function tryGetUniquesObject(
-    moduleContent: string,
-    pathToFile: string,
-    pathInContent: string,
-) {
-    // Match uniques: { ... } object (single or multiline)
-    const uniquesMatch = moduleContent.match(/uniques:\s*\{([^}]*)\}/s);
-
-    if (!uniquesMatch) {
-        return {};
-    }
-
-    const uniquesContent = uniquesMatch[1];
-
-    // Parse key-value pairs from uniques object
-    const lines = uniquesContent.split('\n');
-    const result: any = {};
-
-    for (const line of lines) {
-        // Skip commented out lines
-        if (line.trim().startsWith('//')) {
-            continue;
-        }
-
-        // Skip uniques starting with underscore
-        if (line.trim().startsWith('_')) {
-            continue;
-        }
-
-        const pairMatch = line.match(/(\w+):\s*(\w+)/);
-        if (!pairMatch) {
-            continue;
-        }
-
-        const [, uniqueName, tagName] = pairMatch;
-
-        const jsdoc = jsdocLines([
-            'Unique',
-            `Tag: \`<${tagName}>\``,
-            `Location: [${pathInContent}](file:///${pathToFile})`,
-        ]);
-
-        result[`$${uniqueName}`] = {
-            __typeguard: 'GlobalContentUniqueTypeguard',
-            __jsdoc: `
-/**
-${jsdoc}
- */
-            `.trim(),
-        };
-    }
-
-    return result;
-}
+import { readFileSync, writeFileSync } from 'node:fs';
+import { topicParts, type TopicPart } from '@erudit-js/core/content/topic';
+import { $CONTENT } from './singleton';
+
+// Call singleton to trigger initialization
+$CONTENT;
+
+let initialBuild = true;
+
+const contentRoot = () => ERUDIT.paths.project('content');
+
+export async function buildGlobalContent() {
+  ERUDIT.log.debug.start('Building global content...');
+
+  const isInitial = initialBuild;
+  initialBuild = false;
+
+  if (!isInitial && !hasContentChanges()) {
+    ERUDIT.log.info('Skipping global content — nothing changed.');
+    return;
+  }
+
+  const linkObject = await buildLinkObject();
+
+  const linkTypes = linkObjectToTypes(linkObject);
+  writeFileSync(
+    ERUDIT.paths.project('.erudit/types/content.d.ts'),
+    linkTypes,
+    'utf-8',
+  );
+
+  ERUDIT.log.success(
+    isInitial ? 'Global content build complete!' : 'Global content updated!',
+  );
+}
+
+function hasContentChanges() {
+  for (const file of (ERUDIT.changedFiles || new Set<string>()).values()) {
+    if (file.startsWith(`${contentRoot()}/`)) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+function linkObjectToTypes(linkObject: any): string {
+  const indent = (level: number) => '    '.repeat(level);
+
+  function toCamelCase(str: string): string {
+    return str.replace(/[-_](.)/g, (_, char) => char.toUpperCase());
+  }
+
+  function processObject(obj: any, level: number): string {
+    const lines: string[] = [];
+
+    for (const [key, value] of Object.entries(obj) as [string, any][]) {
+      if (key === '__jsdoc' || key === '__typeguard') continue;
+
+      const camelKey = toCamelCase(key);
+
+      // Add JSDoc comment if present
+      if (value && typeof value === 'object' && value.__jsdoc) {
+        const jsdocLines = value.__jsdoc.split('\n');
+        jsdocLines.forEach((line: string) => {
+          lines.push(indent(level) + line);
+        });
+      }
+
+      // Determine if value has nested properties (excluding __jsdoc and __typeguard)
+      const hasNestedProps =
+        value &&
+        typeof value === 'object' &&
+        Object.keys(value).some((k) => k !== '__jsdoc' && k !== '__typeguard');
+
+      // Get the typeguard from the object, default to GlobalContentItemTypeguard
+      const typeguard = value?.__typeguard || 'GlobalContentItemTypeguard';
+
+      if (hasNestedProps) {
+        lines.push(indent(level) + `${camelKey}: ${typeguard} & {`);
+        lines.push(processObject(value, level + 1));
+        lines.push(indent(level) + `}`);
+      } else {
+        lines.push(indent(level) + `${camelKey}: ${typeguard} & {}`);
+      }
+    }
+
+    return lines.join('\n');
+  }
+
+  const body = processObject(linkObject, 2);
+
+  return `import type {
+    GlobalContentItemTypeguard,
+    GlobalContentTopicPartTypeguard,
+    GlobalContentUniqueTypeguard,
+} from '@erudit-js/core/content/global';
+
+export {};
+
+declare global {
+    const $CONTENT: {
+${body}
+    }
+}`;
+}
+
+/**
+ * Loop through the content navigation tree and build a nested object representing the link structure:
+ */
+async function buildLinkObject() {
+  const linkTree: any = {};
+
+  await ERUDIT.contentNav.walk((navItem) => {
+    // Navigate to the correct position in the tree based on the full path
+    let cursor = linkTree;
+    const pathParts = navItem.fullId.split('/');
+
+    // Navigate through parent parts
+    for (let i = 0; i < pathParts.length - 1; i++) {
+      cursor = cursor[pathParts[i]];
+    }
+
+    //
+    //
+    //
+
+    if (navItem.type === 'page') {
+      const pathToFile = ERUDIT.paths.project(
+        `content/${navItem.contentRelPath}/${navItem.type}.tsx`,
+      );
+      const moduleContent = readFileSync(pathToFile, 'utf-8');
+      const title = tryGetTitle(moduleContent);
+
+      const jsdoc = jsdocLines([
+        title ? `Title: ${title}` : undefined,
+        `Type: ${navItem.type}`,
+        `Location: [${navItem.contentRelPath}](file:///${pathToFile})`,
+      ]);
+
+      cursor[navItem.idPart] = {
+        __typeguard: 'GlobalContentItemTypeguard',
+        __jsdoc: `
+/**
+${jsdoc}
+ */
+                `.trim(),
+        ...tryGetUniquesObject(
+          moduleContent,
+          pathToFile,
+          navItem.contentRelPath,
+        ),
+      };
+    } else if (navItem.type === 'topic') {
+      const pathToTopicFile = ERUDIT.paths.project(
+        `content/${navItem.contentRelPath}/topic.ts`,
+      );
+      const topicModuleContent = readFileSync(pathToTopicFile, 'utf-8');
+      const title = tryGetTitle(topicModuleContent);
+
+      const jsdoc = jsdocLines([
+        title ? `Title: ${title}` : undefined,
+        `Type: topic`,
+        `Location: [${navItem.contentRelPath}](file:///${pathToTopicFile})`,
+      ]);
+
+      cursor[navItem.idPart] = {
+        __typeguard: 'GlobalContentItemTypeguard',
+        __jsdoc: `
+/**
+${jsdoc}
+ */
+                `.trim(),
+      };
+
+      for (const part of topicParts) {
+        try {
+          const pathToFile = ERUDIT.paths.project(
+            `content/${navItem.contentRelPath}/${part}.tsx`,
+          );
+          const partContent = readFileSync(pathToFile, 'utf-8');
+
+          const jsdoc = jsdocLines([
+            title ? `Title: ${title}` : undefined,
+            `Type: topic`,
+            `Part: ${part}`,
+            `Location: [${navItem.contentRelPath}](file:///${pathToFile})`,
+          ]);
+
+          cursor[navItem.idPart][part as TopicPart] = {
+            __typeguard: 'GlobalContentTopicPartTypeguard',
+            __jsdoc: `
+/**
+${jsdoc}
+ */
+                        `.trim(),
+            ...tryGetUniquesObject(
+              partContent,
+              pathToFile,
+              navItem.contentRelPath,
+            ),
+          };
+        } catch {}
+      }
+    } else {
+      const pathToFile = ERUDIT.paths.project(
+        `content/${navItem.contentRelPath}/${navItem.type}.ts`,
+      );
+      const moduleContent = readFileSync(pathToFile, 'utf-8');
+      const title = tryGetTitle(moduleContent);
+
+      const jsdoc = jsdocLines([
+        title ? `Title: ${title}` : undefined,
+        `Type: ${navItem.type}`,
+        `Location: [${navItem.contentRelPath}](file:///${pathToFile})`,
+      ]);
+
+      cursor[navItem.idPart] = {
+        __typeguard: 'GlobalContentItemTypeguard',
+        __jsdoc: `
+/**
+${jsdoc}
+ */
+                `.trim(),
+      };
+    }
+  });
+
+  return linkTree;
+}
+
+function tryGetTitle(moduleContent: string) {
+  const titleMatch = moduleContent.match(/title:\s*['"`](.*?)['"`]/);
+
+  if (titleMatch) {
+    return titleMatch[1].trim();
+  }
+}
+
+function jsdocLines(lines: any[]) {
+  return lines
+    .filter(Boolean)
+    .map((line) => ` * * ${line}`)
+    .join('\n');
+}
+
+function tryGetUniquesObject(
+  moduleContent: string,
+  pathToFile: string,
+  pathInContent: string,
+) {
+  // Match uniques: { ... } object (single or multiline)
+  const uniquesMatch = moduleContent.match(/uniques:\s*\{([^}]*)\}/s);
+
+  if (!uniquesMatch) {
+    return {};
+  }
+
+  const uniquesContent = uniquesMatch[1];
+
+  // Parse key-value pairs from uniques object
+  const lines = uniquesContent.split('\n');
+  const result: any = {};
+
+  for (const line of lines) {
+    // Skip commented out lines
+    if (line.trim().startsWith('//')) {
+      continue;
+    }
+
+    // Skip uniques starting with underscore
+    if (line.trim().startsWith('_')) {
+      continue;
+    }
+
+    const pairMatch = line.match(/(\w+):\s*(\w+)/);
+    if (!pairMatch) {
+      continue;
+    }
+
+    const [, uniqueName, tagName] = pairMatch;
+
+    const jsdoc = jsdocLines([
+      'Unique',
+      `Tag: \`<${tagName}>\``,
+      `Location: [${pathInContent}](file:///${pathToFile})`,
+    ]);
+
+    result[`$${uniqueName}`] = {
+      __typeguard: 'GlobalContentUniqueTypeguard',
+      __jsdoc: `
+/**
+${jsdoc}
+ */
+            `.trim(),
+    };
+  }
+
+  return result;
+}

package/server/erudit/content/global/singleton.ts

@@ -1,5 +1,5 @@
-import { createGlobalContentProxy } from '@erudit-js/core/content/global';
-
-export const $CONTENT = createGlobalContentProxy();
-
-(globalThis as any).$CONTENT = $CONTENT;
+import { createGlobalContentProxy } from '@erudit-js/core/content/global';
+
+export const $CONTENT = createGlobalContentProxy();
+
+(globalThis as any).$CONTENT = $CONTENT;