erudit 3.0.0-dev.2 → 3.0.0-dev.20

package/module/config.ts

@@ -1,34 +1,35 @@
-import { addTemplate } from 'nuxt/kit';
-import type { Nuxt } from 'nuxt/schema';
-import type { EruditConfig } from 'erudit-cog/schema';
-
-import { eruditEndNuxtPath, projectPath } from '@erudit/globalPath';
-import { logger } from '@erudit/module/logger';
-
-export async function setupEruditConfig(_nuxt: Nuxt) {
-    let config: Partial<EruditConfig> = {};
-
-    try {
-        const projectConfig = (await import(projectPath('erudit'))).default;
-        if (!projectConfig) throw new Error('Falsy Erudit config!');
-        config = projectConfig;
-    } catch (error) {
-        logger.warn(`Failed to load Erudit config!\n\n${error}`);
-    }
-
-    const templateFilename = '#erudit/config.ts';
-
-    addTemplate({
-        filename: templateFilename,
-        write: true,
-        getContents: () => `
-            import type { EruditConfig } from 'erudit-cog/schema';
-            export default ${JSON.stringify(config, null, '    ')} as Partial<EruditConfig>;
-        `,
-    });
-
-    const alias = (_nuxt.options.alias ||= {});
-    alias['#erudit/config'] = eruditEndNuxtPath(`.nuxt/${templateFilename}`);
-
-    return config;
-}
+import { addTemplate } from 'nuxt/kit';
+import type { Nuxt } from 'nuxt/schema';
+import type { EruditConfig } from '@erudit-js/cog/schema';
+
+import { eruditEndNuxtPath, projectPath } from '@erudit/globalPath';
+import { logger } from '@erudit/module/logger';
+
+export async function setupEruditConfig(_nuxt: Nuxt) {
+    let config: Partial<EruditConfig> = {};
+    const configPath = projectPath('erudit.config');
+
+    try {
+        const projectConfig = (await import(configPath)).default;
+        if (!projectConfig) throw new Error('Falsy Erudit config!');
+        config = projectConfig;
+    } catch (error) {
+        logger.warn(`Failed to load Erudit config!\n\n${error}`);
+    }
+
+    const templateFilename = '#erudit/config.ts';
+
+    addTemplate({
+        filename: templateFilename,
+        write: true,
+        getContents: () => `
+            import type { EruditConfig } from '@erudit-js/cog/schema';
+            export default ${JSON.stringify(config, null, '    ')} as Partial<EruditConfig>;
+        `,
+    });
+
+    const alias = (_nuxt.options.alias ||= {});
+    alias['#erudit/config'] = eruditEndNuxtPath(`.nuxt/${templateFilename}`);
+
+    return config;
+}

package/module/imports.ts

@@ -1,46 +1,67 @@
-import { addImports, addServerImports } from 'nuxt/kit';
-
-import { eruditPath } from '@erudit/globalPath';
-
-export function setupGlobalImports() {
-    addImports([
-        {
-            name: 'defineEruditConfig',
-            from: eruditPath('globals/erudit'),
-        },
-        {
-            name: 'defineContributor',
-            from: eruditPath('globals/contributor'),
-        },
-        {
-            name: 'defineBitranConfig',
-            from: eruditPath('globals/bitran'),
-        },
-        // Content
-        ...(() => {
-            const imports = [
-                'defineBook',
-                'defineGroup',
-                'defineTopic',
-                'defineContentReferences',
-            ];
-            return imports.map((name) => ({
-                name,
-                from: eruditPath(`globals/content`),
-            }));
-        })(),
-        // Helper Asset Path Functions
-        ...(() => {
-            const imports = [
-                'eruditAsset',
-                'contributorAsset',
-                'contentAsset',
-                'publicAsset',
-            ];
-            return imports.map((name) => ({
-                name,
-                from: eruditPath(`shared/asset`),
-            }));
-        })(),
-    ]);
-}
+import { addImports, addServerImports } from 'nuxt/kit';
+
+import { eruditPath } from '@erudit/globalPath';
+
+export function setupGlobalImports() {
+    addImports([
+        {
+            name: 'defineEruditConfig',
+            from: eruditPath('globals/erudit'),
+        },
+        {
+            name: 'defineContributor',
+            from: eruditPath('globals/contributor'),
+        },
+        // Bitran
+        ...(() => {
+            const imports = ['defineAppBitran'];
+            return imports.map((name) => ({
+                name,
+                from: eruditPath(`globals/bitran`),
+            }));
+        })(),
+        // Content
+        ...(() => {
+            const imports = [
+                'defineBook',
+                'defineGroup',
+                'defineTopic',
+                'defineContentReferences',
+                'defineContentSource',
+            ];
+            return imports.map((name) => ({
+                name,
+                from: eruditPath(`globals/content`),
+            }));
+        })(),
+        // Problems Generation
+        {
+            name: 'defineProblemGenerator',
+            from: '@erudit-js/bitran-elements/problem/generator',
+        },
+        // Helper Asset Path Functions
+        ...(() => {
+            const imports = [
+                'eruditAsset',
+                'contributorAsset',
+                'contentAsset',
+                'publicAsset',
+            ];
+            return imports.map((name) => ({
+                name,
+                from: eruditPath(`shared/asset`),
+            }));
+        })(),
+    ]);
+
+    addServerImports([
+        // Bitran
+        ...(() => {
+            const imports = ['defineServerBitran'];
+            return imports.map((name) => ({
+                name,
+                from: eruditPath(`globals/bitran`),
+            }));
+        })(),
+    ]);
+}

package/module/index.ts

@@ -1,47 +1,47 @@
-import { defineNuxtModule, updateTemplates } from 'nuxt/kit';
-
-import { registerGlobals } from '@erudit/globals/register';
-import { setupRestartWatcher } from '@erudit/module/restart';
-import { setupEruditConfig } from '@erudit/module/config';
-import { logger } from '@erudit/module/logger';
-import { setupGlobalImports } from '@erudit/module/imports';
-import { setupBitranConfig } from './bitran';
-import { setupGlobalPaths } from './paths';
-
-export default defineNuxtModule({
-    meta: { name: 'Erudit', configKey: 'erudit' },
-    async setup(_options, _nuxt) {
-        if (_nuxt.options.dev) setupRestartWatcher(_nuxt);
-
-        setupGlobalImports();
-        registerGlobals();
-
-        const eruditConfig = await setupEruditConfig(_nuxt);
-        await setupBitranConfig(_nuxt);
-        setupGlobalPaths(_nuxt);
-
-        if (eruditConfig.site?.baseUrl) {
-            const newBaseUrl = eruditConfig.site.baseUrl;
-            _nuxt.options.app.baseURL = newBaseUrl;
-            _nuxt.options.nitro.runtimeConfig!.app!.baseURL = newBaseUrl;
-            await updateTemplates();
-        }
-
-        {
-            // Handle sub dependencies
-            const subDeps = eruditConfig.subDeps || [];
-
-            const transpile = (_nuxt.options.build.transpile ||= []);
-            const optimizeDeps = _nuxt.options.vite.optimizeDeps || {};
-            const optimizeDepsInclude = (optimizeDeps.include ||= []);
-
-            transpile.push(...subDeps);
-            optimizeDepsInclude.push(...subDeps);
-        }
-
-        // TODO: Watch for contributors folder and create/update template with their IDs
-        // TODO: Create such helpers for other features!
-
-        logger.success('Erudit module setup complete!');
-    },
-});
+import { defineNuxtModule, updateTemplates } from 'nuxt/kit';
+
+import { registerGlobals } from '@erudit/globals/register';
+import { setupRestartWatcher } from '@erudit/module/restart';
+import { setupEruditConfig } from '@erudit/module/config';
+import { logger } from '@erudit/module/logger';
+import { setupGlobalImports } from '@erudit/module/imports';
+import { setupBitranTemplates } from './bitran';
+import { setupGlobalPaths } from './paths';
+
+export default defineNuxtModule({
+    meta: { name: 'Erudit', configKey: 'erudit' },
+    async setup(_options, _nuxt) {
+        if (_nuxt.options.dev) setupRestartWatcher(_nuxt);
+
+        setupGlobalImports();
+        registerGlobals();
+
+        const eruditConfig = await setupEruditConfig(_nuxt);
+        await setupBitranTemplates(_nuxt);
+        setupGlobalPaths(_nuxt);
+
+        if (eruditConfig.site?.baseUrl) {
+            const newBaseUrl = eruditConfig.site.baseUrl;
+            _nuxt.options.app.baseURL = newBaseUrl;
+            _nuxt.options.nitro.runtimeConfig!.app!.baseURL = newBaseUrl;
+            await updateTemplates();
+        }
+
+        {
+            const transpile = (_nuxt.options.build.transpile ||= []);
+            const optimizeDeps = _nuxt.options.vite.optimizeDeps || {};
+            const optimizeDepsInclude = (optimizeDeps.include ||= []);
+
+            const deps = eruditConfig.dependencies || {};
+            for (const [dep, options] of Object.entries(deps)) {
+                if (options?.transpile) transpile.push(dep);
+                if (options?.optimize) optimizeDepsInclude.push(dep);
+            }
+        }
+
+        // TODO: Watch for contributors folder and create/update template with their IDs
+        // TODO: Create such helpers for other features!
+
+        logger.success('Erudit module setup complete!');
+    },
+});

package/module/logger.ts

@@ -1,10 +1,10 @@
-import { createConsola } from 'consola';
-import { brandColorTitle } from 'erudit-cog/utils/brand';
-
-const tag = brandColorTitle + ' Module';
-
-export const logger = createConsola({
-    defaults: {
-        tag,
-    },
-});
+import { createConsola } from 'consola';
+import { brandColorTitle } from '@erudit-js/cog/utils/brandNode';
+
+const tag = brandColorTitle + ' Module';
+
+export const logger = createConsola({
+    defaults: {
+        tag,
+    },
+});

package/module/paths.ts

@@ -1,22 +1,22 @@
-import { addTemplate } from 'nuxt/kit';
-import type { Nuxt } from 'nuxt/schema';
-
-import { ERUDIT_DIR, eruditEndNuxtPath, PROJECT_DIR } from '@erudit/globalPath';
-
-export function setupGlobalPaths(_nuxt: Nuxt) {
-    const templateFilename = '#erudit/globalPaths.ts';
-
-    addTemplate({
-        filename: templateFilename,
-        write: true,
-        getContents: () => `
-            export const ERUDIT_DIR = '${ERUDIT_DIR}';
-            export const PROJECT_DIR = '${PROJECT_DIR}';
-        `,
-    });
-
-    const alias = (_nuxt.options.alias ||= {});
-    alias['#erudit/globalPaths'] = eruditEndNuxtPath(
-        `.nuxt/${templateFilename}`,
-    );
-}
+import { addTemplate } from 'nuxt/kit';
+import type { Nuxt } from 'nuxt/schema';
+
+import { ERUDIT_DIR, eruditEndNuxtPath, PROJECT_DIR } from '@erudit/globalPath';
+
+export function setupGlobalPaths(_nuxt: Nuxt) {
+    const templateFilename = '#erudit/globalPaths.ts';
+
+    addTemplate({
+        filename: templateFilename,
+        write: true,
+        getContents: () => `
+            export const ERUDIT_DIR = '${ERUDIT_DIR}';
+            export const PROJECT_DIR = '${PROJECT_DIR}';
+        `,
+    });
+
+    const alias = (_nuxt.options.alias ||= {});
+    alias['#erudit/globalPaths'] = eruditEndNuxtPath(
+        `.nuxt/${templateFilename}`,
+    );
+}

package/module/restart.ts

@@ -1,61 +1,61 @@
-import { exit } from 'node:process';
-import { globSync } from 'glob';
-import chokidar, { type FSWatcher } from 'chokidar';
-import type { Nuxt } from 'nuxt/schema';
-
-import { eruditPath, projectPath } from '@erudit/globalPath';
-import { logger } from '@erudit/module/logger';
-import { stress } from '@erudit/utils/stress';
-
-const watchTargets: string[] = [
-    // Erudit Nuxt config file
-    eruditPath('nuxt.config.ts'),
-    // Erudit Globals
-    eruditPath('globals'),
-    // Erudit Nuxt module non-runtime files
-    ...globSync(eruditPath('module/**/*')),
-    // Erudit config in project root
-    ...globSync(projectPath('erudit.{js,ts}')),
-    // Erudit Bitran config in project root
-    ...globSync(projectPath('bitran.{js,ts}')),
-];
-
-const ignoreTargets: string[] = [
-    // Erudit Nuxt module runtime files
-    ...globSync(eruditPath('module/runtime/**/*')),
-];
-
-const restartDelay = 300;
-
-//
-//
-//
-
-let watcher: FSWatcher;
-let restartTimeout: any;
-let nuxt: Nuxt;
-
-export function setupRestartWatcher(_nuxt: Nuxt) {
-    nuxt = _nuxt;
-
-    if (watcher) return;
-
-    watcher = chokidar.watch(watchTargets, {
-        ignored: ignoreTargets,
-        ignoreInitial: true,
-    });
-
-    watcher.on('all', (event, path) => {
-        clearTimeout(restartTimeout);
-        restartTimeout = setTimeout(() => {
-            console.log('\n');
-            logger.info(
-                `Restarting due to critical file change: ${stress(path)}\n\n`,
-            );
-            // Nuxt Restart Hook won't work when unhandled Node exception is thrown!
-            // nuxt.callHook('restart', { hard: true, });
-            // So we kill the process and restart it in Erudit CLI instead.
-            exit(1337);
-        }, restartDelay);
-    });
-}
+import { exit } from 'node:process';
+import { globSync } from 'glob';
+import chokidar, { type FSWatcher } from 'chokidar';
+import type { Nuxt } from 'nuxt/schema';
+
+import { eruditPath, projectPath } from '@erudit/globalPath';
+import { logger } from '@erudit/module/logger';
+import { stress } from '@erudit/utils/stress';
+
+const watchTargets: string[] = [
+    // Erudit Nuxt config file
+    eruditPath('nuxt.config.ts'),
+    // Erudit Globals
+    eruditPath('globals'),
+    // Erudit Nuxt module non-runtime files
+    ...globSync(eruditPath('module/**/*')),
+    // Erudit config in project root
+    ...globSync(projectPath('erudit.config.{js,ts}')),
+    // Erudit Bitran config in project root
+    ...globSync(projectPath('bitran.{app,server}.{js,ts}')),
+];
+
+const ignoreTargets: string[] = [
+    // Erudit Nuxt module runtime files
+    ...globSync(eruditPath('module/runtime/**/*')),
+];
+
+const restartDelay = 300;
+
+//
+//
+//
+
+let watcher: FSWatcher;
+let restartTimeout: any;
+let nuxt: Nuxt;
+
+export function setupRestartWatcher(_nuxt: Nuxt) {
+    nuxt = _nuxt;
+
+    if (watcher) return;
+
+    watcher = chokidar.watch(watchTargets, {
+        ignored: ignoreTargets,
+        ignoreInitial: true,
+    });
+
+    watcher.on('all', (event, path) => {
+        clearTimeout(restartTimeout);
+        restartTimeout = setTimeout(() => {
+            console.log('\n');
+            logger.info(
+                `Restarting due to critical file change: ${stress(path)}\n\n`,
+            );
+            // Nuxt Restart Hook won't work when unhandled Node exception is thrown!
+            // nuxt.callHook('restart', { hard: true, });
+            // So we kill the process and restart it in Erudit CLI instead.
+            exit(1337);
+        }, restartDelay);
+    });
+}