erudit 3.0.0-dev.3 → 3.0.0-dev.5

package/server/plugin/build/jobs/nav.ts

@@ -1,210 +1,210 @@
-import { globSync } from 'glob';
-import chalk from 'chalk';
-import { resolvePaths } from 'erudit-cog/kit';
-import { contentTypes, topicParts, type ContentType } from 'erudit-cog/schema';
-
-import { PROJECT_DIR } from '#erudit/globalPaths';
-import { stress } from '@erudit/utils/stress';
-import { debug, logger } from '@server/logger';
-import {
-    createRootNode,
-    isRootNode,
-    type NavNode,
-    type RootNavNode,
-} from '@server/nav/node';
-import { ERUDIT_SERVER } from '../../global';
-
-type Ids = Record<string, string>;
-let ids: Ids;
-
-const contentTargets = ERUDIT_SERVER.CONFIG?.contentTargets || [];
-
-const nodePathRegexp = new RegExp(
-    `(?<pos>\\d+)(?<sep>-|\\+)(?<id>[\\w-]+)\\/(?<type>${contentTypes.join('|')})\\..*`,
-);
-
-export async function buildNav() {
-    debug.start('Building navigation tree...');
-
-    ids = {};
-
-    const rootNode = createRootNode();
-    rootNode.children = (await scanChildNodes(rootNode, false)).children;
-    ERUDIT_SERVER.NAV = rootNode.children ? rootNode : undefined;
-
-    const nodeCount = Object.values(ids).length;
-
-    if (nodeCount === 0) {
-        logger.warn('No content nodes detected! The site will be empty!');
-    } else {
-        if (ERUDIT_SERVER.CONFIG?.debug?.log) debugPrintNav(rootNode);
-
-        logger.success(
-            'Navigation tree built successfully!',
-            chalk.dim(`(${nodeCount})`),
-        );
-    }
-}
-
-async function scanChildNodes(
-    parent: NavNode | RootNavNode,
-    insideBook: boolean,
-): Promise<{ children: NavNode[] | undefined; newIds: Ids }> {
-    const currentFsPath = isRootNode(parent) ? '' : parent.path;
-
-    const nodeFsPaths = globSync(
-        `${PROJECT_DIR}/content/${currentFsPath}/*/{${contentTypes.join(',')}}.{ts,js}`,
-    )
-        .sort()
-        .map((path) => resolvePaths(path));
-
-    let newIds: Ids = {};
-    const children: NavNode[] = [];
-
-    for (const nodeFsPath of nodeFsPaths) {
-        const pathParts:
-            | {
-                  pos: string;
-                  sep: string;
-                  id: string;
-                  type: ContentType;
-              }
-            | undefined = nodeFsPath.match(nodePathRegexp)?.groups as any;
-
-        if (!pathParts) continue; // Wrong path pattern
-
-        const nodePath = nodeFsPath
-            .replace(PROJECT_DIR + '/content/', '')
-            .split('/')
-            .slice(0, -1)
-            .join('/');
-
-        if (pathParts.type === 'book' && insideBook) {
-            logger.warn(
-                'Books inside books are not allowed!\n',
-                `Skipping ${stress(nodePath)} nav node!`,
-            );
-            continue;
-        }
-
-        if (!satisfiesContentTargets(nodePath)) continue; // Not a content target
-
-        const parentId = isRootNode(parent)
-            ? ''
-            : parent.skip
-              ? parent.id.split('/').slice(0, -1).join('/')
-              : parent.id;
-
-        // Regular id might not include parent id part if it is skipped
-        const id = parentId ? `${parentId}/${pathParts.id}` : pathParts.id;
-
-        if (ids[id]) {
-            logger.warn(
-                `Nav node ${stress(id)} ID collision!\n\n`,
-                `This ID belongs to ${stress(ids[id], chalk.greenBright)} nav node.\n`,
-                `Nav node ${stress(nodePath, chalk.redBright)} tries to use the same ID!\n`,
-                'Skipping nav node which causes collision!',
-            );
-            continue;
-        }
-
-        // Full id always includes parent id
-        const fullId = isRootNode(parent)
-            ? pathParts.id
-            : `${parent.fullId}/${pathParts.id}`;
-
-        const skip = pathParts.sep === '+';
-
-        const childNode: NavNode = {
-            parent,
-            type: pathParts.type,
-            path: nodePath,
-            id,
-            fullId,
-            skip,
-        };
-
-        if (!validNode(childNode)) continue;
-
-        ids[id] = nodePath;
-        newIds[id] = nodePath;
-
-        const scanResult = await scanChildNodes(
-            childNode,
-            insideBook || childNode.type === 'book',
-        );
-
-        if (
-            ['book', 'group'].includes(childNode.type) &&
-            !scanResult.children
-        ) {
-            delete ids[id];
-            delete newIds[id];
-            for (const childNewId of Object.keys(scanResult.newIds))
-                delete ids[childNewId];
-            continue;
-        }
-
-        if (childNode.type === 'book') {
-            ERUDIT_SERVER.NAV_BOOKS ||= {};
-            ERUDIT_SERVER.NAV_BOOKS[id] = childNode;
-        }
-
-        childNode.children = scanResult.children;
-        children.push(childNode);
-    }
-
-    return {
-        children: children.length > 0 ? children : undefined,
-        newIds,
-    };
-}
-
-function satisfiesContentTargets(nodePath: string): boolean {
-    if (contentTargets.length === 0) return true;
-
-    for (const target of contentTargets)
-        if (nodePath.startsWith(target) || target.search(nodePath) === 0)
-            return true;
-
-    return false;
-}
-
-function validNode(node: NavNode): boolean {
-    switch (node.type) {
-        case 'topic':
-            const partPaths = globSync(
-                PROJECT_DIR +
-                    `/content/${node.path}` +
-                    `/{${topicParts.join(',')}}.bi`,
-            );
-            if (partPaths.length === 0) return false; // Topic is empty
-            break;
-        case 'book':
-            if (node.skip) {
-                logger.warn(
-                    `Books can't skip their ID part!\n`,
-                    `Skipping ${stress(node.path)} nav node!`,
-                );
-                return false;
-            }
-            break;
-    }
-
-    return true;
-}
-
-function debugPrintNav(node: RootNavNode) {
-    const logNode = (node: NavNode | RootNavNode, indent: number) => {
-        console.log(
-            isRootNode(node)
-                ? chalk.dim('#root')
-                : `${'  '.repeat(indent)}${node.id.split('/').pop()} ${chalk.dim(`[${node.type}${node.skip ? ', ' + chalk.yellow('skip') : ''}]`)}`,
-        );
-
-        if (node.children)
-            for (const child of node.children) logNode(child, indent + 1);
-    };
-
-    logNode(node, 0);
-}
+import { globSync } from 'glob';
+import chalk from 'chalk';
+import { resolvePaths } from 'erudit-cog/kit';
+import { contentTypes, topicParts, type ContentType } from 'erudit-cog/schema';
+
+import { PROJECT_DIR } from '#erudit/globalPaths';
+import { stress } from '@erudit/utils/stress';
+import { debug, logger } from '@server/logger';
+import {
+    createRootNode,
+    isRootNode,
+    type NavNode,
+    type RootNavNode,
+} from '@server/nav/node';
+import { ERUDIT_SERVER } from '../../global';
+
+type Ids = Record<string, string>;
+let ids: Ids;
+
+const contentTargets = ERUDIT_SERVER.CONFIG?.contentTargets || [];
+
+const nodePathRegexp = new RegExp(
+    `(?<pos>\\d+)(?<sep>-|\\+)(?<id>[\\w-]+)\\/(?<type>${contentTypes.join('|')})\\..*`,
+);
+
+export async function buildNav() {
+    debug.start('Building navigation tree...');
+
+    ids = {};
+
+    const rootNode = createRootNode();
+    rootNode.children = (await scanChildNodes(rootNode, false)).children;
+    ERUDIT_SERVER.NAV = rootNode.children ? rootNode : undefined;
+
+    const nodeCount = Object.values(ids).length;
+
+    if (nodeCount === 0) {
+        logger.warn('No content nodes detected! The site will be empty!');
+    } else {
+        if (ERUDIT_SERVER.CONFIG?.debug?.log) debugPrintNav(rootNode);
+
+        logger.success(
+            'Navigation tree built successfully!',
+            chalk.dim(`(${nodeCount})`),
+        );
+    }
+}
+
+async function scanChildNodes(
+    parent: NavNode | RootNavNode,
+    insideBook: boolean,
+): Promise<{ children: NavNode[] | undefined; newIds: Ids }> {
+    const currentFsPath = isRootNode(parent) ? '' : parent.path;
+
+    const nodeFsPaths = globSync(
+        `${PROJECT_DIR}/content/${currentFsPath}/*/{${contentTypes.join(',')}}.{ts,js}`,
+    )
+        .sort()
+        .map((path) => resolvePaths(path));
+
+    let newIds: Ids = {};
+    const children: NavNode[] = [];
+
+    for (const nodeFsPath of nodeFsPaths) {
+        const pathParts:
+            | {
+                  pos: string;
+                  sep: string;
+                  id: string;
+                  type: ContentType;
+              }
+            | undefined = nodeFsPath.match(nodePathRegexp)?.groups as any;
+
+        if (!pathParts) continue; // Wrong path pattern
+
+        const nodePath = nodeFsPath
+            .replace(PROJECT_DIR + '/content/', '')
+            .split('/')
+            .slice(0, -1)
+            .join('/');
+
+        if (pathParts.type === 'book' && insideBook) {
+            logger.warn(
+                'Books inside books are not allowed!\n',
+                `Skipping ${stress(nodePath)} nav node!`,
+            );
+            continue;
+        }
+
+        if (!satisfiesContentTargets(nodePath)) continue; // Not a content target
+
+        const parentId = isRootNode(parent)
+            ? ''
+            : parent.skip
+              ? parent.id.split('/').slice(0, -1).join('/')
+              : parent.id;
+
+        // Regular id might not include parent id part if it is skipped
+        const id = parentId ? `${parentId}/${pathParts.id}` : pathParts.id;
+
+        if (ids[id]) {
+            logger.warn(
+                `Nav node ${stress(id)} ID collision!\n\n`,
+                `This ID belongs to ${stress(ids[id], chalk.greenBright)} nav node.\n`,
+                `Nav node ${stress(nodePath, chalk.redBright)} tries to use the same ID!\n`,
+                'Skipping nav node which causes collision!',
+            );
+            continue;
+        }
+
+        // Full id always includes parent id
+        const fullId = isRootNode(parent)
+            ? pathParts.id
+            : `${parent.fullId}/${pathParts.id}`;
+
+        const skip = pathParts.sep === '+';
+
+        const childNode: NavNode = {
+            parent,
+            type: pathParts.type,
+            path: nodePath,
+            id,
+            fullId,
+            skip,
+        };
+
+        if (!validNode(childNode)) continue;
+
+        ids[id] = nodePath;
+        newIds[id] = nodePath;
+
+        const scanResult = await scanChildNodes(
+            childNode,
+            insideBook || childNode.type === 'book',
+        );
+
+        if (
+            ['book', 'group'].includes(childNode.type) &&
+            !scanResult.children
+        ) {
+            delete ids[id];
+            delete newIds[id];
+            for (const childNewId of Object.keys(scanResult.newIds))
+                delete ids[childNewId];
+            continue;
+        }
+
+        if (childNode.type === 'book') {
+            ERUDIT_SERVER.NAV_BOOKS ||= {};
+            ERUDIT_SERVER.NAV_BOOKS[id] = childNode;
+        }
+
+        childNode.children = scanResult.children;
+        children.push(childNode);
+    }
+
+    return {
+        children: children.length > 0 ? children : undefined,
+        newIds,
+    };
+}
+
+function satisfiesContentTargets(nodePath: string): boolean {
+    if (contentTargets.length === 0) return true;
+
+    for (const target of contentTargets)
+        if (nodePath.startsWith(target) || target.search(nodePath) === 0)
+            return true;
+
+    return false;
+}
+
+function validNode(node: NavNode): boolean {
+    switch (node.type) {
+        case 'topic':
+            const partPaths = globSync(
+                PROJECT_DIR +
+                    `/content/${node.path}` +
+                    `/{${topicParts.join(',')}}.bi`,
+            );
+            if (partPaths.length === 0) return false; // Topic is empty
+            break;
+        case 'book':
+            if (node.skip) {
+                logger.warn(
+                    `Books can't skip their ID part!\n`,
+                    `Skipping ${stress(node.path)} nav node!`,
+                );
+                return false;
+            }
+            break;
+    }
+
+    return true;
+}
+
+function debugPrintNav(node: RootNavNode) {
+    const logNode = (node: NavNode | RootNavNode, indent: number) => {
+        console.log(
+            isRootNode(node)
+                ? chalk.dim('#root')
+                : `${'  '.repeat(indent)}${node.id.split('/').pop()} ${chalk.dim(`[${node.type}${node.skip ? ', ' + chalk.yellow('skip') : ''}]`)}`,
+        );
+
+        if (node.children)
+            for (const child of node.children) logNode(child, indent + 1);
+    };
+
+    logNode(node, 0);
+}

package/server/plugin/build/process.ts

@@ -1,25 +1,25 @@
-import { debug, logger } from '@server/logger';
-
-import { setup } from './setup';
-import { setupLanguage } from './jobs/language';
-import { buildContributors } from './jobs/contributors';
-import { buildNav } from './jobs/nav';
-import { buildContent } from './jobs/content/generic';
-
-let initial = true;
-
-export async function build() {
-    debug.start('Building data...');
-
-    if (initial) {
-        await setup();
-        initial = false;
-    }
-
-    await setupLanguage();
-    await buildContributors();
-    await buildNav();
-    await buildContent();
-
-    logger.success('Build successful!');
-}
+import { debug, logger } from '@server/logger';
+
+import { setup } from './setup';
+import { setupLanguage } from './jobs/language';
+import { buildContributors } from './jobs/contributors';
+import { buildNav } from './jobs/nav';
+import { buildContent } from './jobs/content/generic';
+
+let initial = true;
+
+export async function build() {
+    debug.start('Building data...');
+
+    if (initial) {
+        await setup();
+        initial = false;
+    }
+
+    await setupLanguage();
+    await buildContributors();
+    await buildNav();
+    await buildContent();
+
+    logger.success('Build successful!');
+}

package/server/plugin/build/rebuild.ts

@@ -1,55 +1,55 @@
-import chokidar, { type FSWatcher } from 'chokidar';
-
-import { ERUDIT_DIR, PROJECT_DIR } from '#erudit/globalPaths';
-import { ERUDIT_SERVER } from '@server/global';
-import { logger } from '@server/logger';
-import { build } from '@server/build/process';
-import { stress } from '@erudit/utils/stress';
-
-const watchTargets: string[] = [
-    // Languages
-    ERUDIT_DIR + '/languages',
-    // Content directory
-    PROJECT_DIR + '/content',
-    // Contributors directory
-    PROJECT_DIR + '/contributors',
-];
-
-const ignoreTargets: string[] = [];
-
-const rebuildDelay = 300;
-
-//
-//
-//
-
-let watcher: FSWatcher;
-let rebuildTimeout: any;
-let rebuildRequested = false;
-
-export async function setupRebuildWatcher() {
-    if (watcher) return;
-
-    watcher = chokidar.watch(watchTargets, {
-        ignored: ignoreTargets,
-        ignoreInitial: true,
-    });
-
-    watcher.on('all', (event, path) =>
-        requestServerRebuild(`File change: ${stress(path)}`),
-    );
-}
-
-export async function requestServerRebuild(reason?: string) {
-    if (rebuildRequested) return;
-
-    clearTimeout(rebuildTimeout);
-    rebuildTimeout = setTimeout(async () => {
-        rebuildRequested = true;
-        await ERUDIT_SERVER.BUILD_PROMISE;
-        console.log('\n');
-        logger.info(`Rebuilding server data!${reason ? ` ${reason}` : ''}\n\n`);
-        await build();
-        rebuildRequested = false;
-    }, rebuildDelay);
-}
+import chokidar, { type FSWatcher } from 'chokidar';
+
+import { ERUDIT_DIR, PROJECT_DIR } from '#erudit/globalPaths';
+import { ERUDIT_SERVER } from '@server/global';
+import { logger } from '@server/logger';
+import { build } from '@server/build/process';
+import { stress } from '@erudit/utils/stress';
+
+const watchTargets: string[] = [
+    // Languages
+    ERUDIT_DIR + '/languages',
+    // Content directory
+    PROJECT_DIR + '/content',
+    // Contributors directory
+    PROJECT_DIR + '/contributors',
+];
+
+const ignoreTargets: string[] = [];
+
+const rebuildDelay = 300;
+
+//
+//
+//
+
+let watcher: FSWatcher;
+let rebuildTimeout: any;
+let rebuildRequested = false;
+
+export async function setupRebuildWatcher() {
+    if (watcher) return;
+
+    watcher = chokidar.watch(watchTargets, {
+        ignored: ignoreTargets,
+        ignoreInitial: true,
+    });
+
+    watcher.on('all', (event, path) =>
+        requestServerRebuild(`File change: ${stress(path)}`),
+    );
+}
+
+export async function requestServerRebuild(reason?: string) {
+    if (rebuildRequested) return;
+
+    clearTimeout(rebuildTimeout);
+    rebuildTimeout = setTimeout(async () => {
+        rebuildRequested = true;
+        await ERUDIT_SERVER.BUILD_PROMISE;
+        console.log('\n');
+        logger.info(`Rebuilding server data!${reason ? ` ${reason}` : ''}\n\n`);
+        await build();
+        rebuildRequested = false;
+    }, rebuildDelay);
+}

package/server/plugin/build/setup.ts

@@ -1,21 +1,21 @@
-import eruditConfig from '#erudit/config';
-
-import { registerGlobals } from '@erudit/globals/register';
-import { debug } from '@server/logger';
-import { ERUDIT_SERVER } from '@server/global';
-
-import { setupRebuildWatcher } from './rebuild';
-import { setupDatabase } from '../db/setup';
-import { setupBitranConfig } from '../bitran/setup';
-
-export async function setup() {
-    debug.start('Running initial setup procedures...');
-
-    if (import.meta.dev) await setupRebuildWatcher();
-
-    registerGlobals();
-    ERUDIT_SERVER.CONFIG = eruditConfig;
-
-    await setupBitranConfig();
-    await setupDatabase();
-}
+import eruditConfig from '#erudit/config';
+
+import { registerGlobals } from '@erudit/globals/register';
+import { debug } from '@server/logger';
+import { ERUDIT_SERVER } from '@server/global';
+
+import { setupRebuildWatcher } from './rebuild';
+import { setupDatabase } from '../db/setup';
+import { setupBitranConfig } from '../bitran/setup';
+
+export async function setup() {
+    debug.start('Running initial setup procedures...');
+
+    if (import.meta.dev) await setupRebuildWatcher();
+
+    registerGlobals();
+    ERUDIT_SERVER.CONFIG = eruditConfig;
+
+    await setupBitranConfig();
+    await setupDatabase();
+}