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

package/modules/erudit/globals/public.ts

@@ -1,18 +1,18 @@
-import { slasher } from '../../../shared/utils/slasher';
-
-export const PUBLIC_PROJECT_BASE_URL = '/public/project/';
-export const PUBLIC_ERUDIT_BASE_URL = '/public/erudit/';
-
-/**
- * Target static files located in `<project_dir>/public` folder.
- */
-export function projectPublic(path: string) {
-    return slasher(`${PUBLIC_PROJECT_BASE_URL}${path}`);
-}
-
-/**
- * Target static files located in `<erudit_package>/public` folder.
- */
-export function eruditPublic(path: string) {
-    return slasher(`${PUBLIC_ERUDIT_BASE_URL}${path}`);
-}
+import { sn } from 'unslash';
+
+export const PUBLIC_PROJECT_BASE_URL = '/public/project/';
+export const PUBLIC_ERUDIT_BASE_URL = '/public/erudit/';
+
+/**
+ * Target static files located in `<project_dir>/public` folder.
+ */
+export function projectPublic(path: string) {
+  return sn(PUBLIC_PROJECT_BASE_URL, path);
+}
+
+/**
+ * Target static files located in `<erudit_package>/public` folder.
+ */
+export function eruditPublic(path: string) {
+  return sn(PUBLIC_ERUDIT_BASE_URL, path);
+}

package/modules/erudit/index.ts

@@ -1,60 +1,50 @@
-import { defineNuxtModule } from 'nuxt/kit';
-
-import { version } from '../../package.json';
-import { moduleLogger } from './logger';
-import { setupWatchers } from './watcher';
-
-// Setup procedures
-import { setupEruditRuntimeConfig } from './setup/runtimeConfig';
-import { setupEruditFullRestart } from './setup/fullRestart';
-import { setupEruditAliases } from './setup/aliases';
-import { addEruditProjectConfigToRuntime } from './setup/projectConfig';
-import { setupEruditPublicAssets } from './setup/publicAssets';
-import { setupEruditCustomBaseUrl } from './setup/baseUrl';
-import { setupEruditNuxtConfig } from './setup/nuxtConfig';
-import {
-    registerAppGlobals,
-    registerGlobalContentTypes,
-    registerModuleGlobals,
-    registerServerGlobals,
-} from './setup/globals';
-import { setupProseElements } from './setup/elements/setup';
-
-export default defineNuxtModule({
-    meta: { name: 'Erudit', configKey: 'erudit', version },
-    async setup(_, nuxt) {
-        moduleLogger.start('Setting up Erudit module...');
-
-        const { eruditRuntimeConfig, eruditPublicRuntimeConfig } =
-            await setupEruditRuntimeConfig(nuxt);
-
-        await setupWatchers(nuxt, eruditRuntimeConfig);
-        await setupEruditFullRestart(nuxt, eruditRuntimeConfig);
-        await setupEruditAliases(nuxt, eruditRuntimeConfig);
-        await registerModuleGlobals();
-        await registerAppGlobals(eruditRuntimeConfig);
-        await registerServerGlobals(eruditRuntimeConfig);
-        await registerGlobalContentTypes(eruditRuntimeConfig);
-        const nuxtAugmentations = await addEruditProjectConfigToRuntime(
-            nuxt,
-            eruditRuntimeConfig,
-            eruditPublicRuntimeConfig,
-        );
-        await setupEruditPublicAssets(nuxt, eruditRuntimeConfig);
-        await setupEruditCustomBaseUrl(nuxt, eruditPublicRuntimeConfig);
-        await setupProseElements(nuxt, eruditRuntimeConfig);
-        await setupEruditNuxtConfig(
-            nuxt,
-            eruditRuntimeConfig,
-            eruditPublicRuntimeConfig,
-        );
-
-        if (nuxtAugmentations) {
-            for (const augment of nuxtAugmentations) {
-                await augment(nuxt);
-            }
-        }
-
-        moduleLogger.success('Erudit module setup complete!');
-    },
-});
+import { defineNuxtModule } from 'nuxt/kit';
+
+import { version } from '../../package.json';
+import { moduleLogger } from './logger';
+import { setupWatchers } from './watcher';
+import { ERUDIT_PATH, PROJECT_PATH } from './env';
+
+// Setup procedures
+import { setupEruditRuntimeConfig } from './setup/runtimeConfig';
+import { setupEruditFullRestart } from './setup/fullRestart';
+import { setupEruditPublicAssets } from './setup/publicAssets';
+import {
+  registerAppGlobals,
+  registerGlobalContentTypes,
+  registerModuleGlobals,
+  registerServerGlobals,
+} from './setup/globals';
+import { setupProseElements } from './setup/elements/setup';
+
+export default defineNuxtModule({
+  meta: { name: 'Erudit', configKey: 'erudit', version },
+  async setup(_, nuxt) {
+    moduleLogger.start('Setting up Erudit module...');
+
+    await registerModuleGlobals();
+    await registerAppGlobals();
+    await registerServerGlobals();
+    await registerGlobalContentTypes();
+
+    const { eruditRuntimeConfig, nuxtAugmentations } =
+      await setupEruditRuntimeConfig(nuxt);
+    await setupWatchers(nuxt);
+    await setupEruditFullRestart(nuxt);
+    await setupEruditPublicAssets(nuxt);
+    await setupProseElements(nuxt, eruditRuntimeConfig);
+
+    if (nuxtAugmentations) {
+      for (const augment of nuxtAugmentations) {
+        await augment({
+          nuxt,
+          nitro: nuxt.options.nitro,
+          projectPath: PROJECT_PATH,
+          eruditPath: ERUDIT_PATH,
+        });
+      }
+    }
+
+    moduleLogger.success('Erudit module setup complete!');
+  },
+});

package/modules/erudit/logger.ts

@@ -1,10 +1,10 @@
-import { createConsola } from 'consola';
-import { brandColorTitle } from '@erudit-js/core/brandTerminal';
-
-const tag = brandColorTitle + ' Module';
-
-export const moduleLogger = createConsola({
-    defaults: {
-        tag,
-    },
-});
+import { createConsola } from 'consola';
+import { brandColorTitle } from '@erudit-js/core/brandTerminal';
+
+const tag = brandColorTitle + ' Module';
+
+export const moduleLogger = createConsola({
+  defaults: {
+    tag,
+  },
+});

package/modules/erudit/setup/elements/appTemplate.ts

@@ -1,45 +1,44 @@
-import type { Nuxt } from 'nuxt/schema';
-import { addTemplate } from 'nuxt/kit';
-
-import type { ElementData } from './shared';
-
-export function createAppTemplate(nuxt: Nuxt, elementsData: ElementData[]) {
-    const defaultImportName = (elementName: string) => `app_${elementName}`;
-
-    const apps: Record<string, string> = {};
-
-    for (const elementData of elementsData) {
-        if (elementData.absAppPath) {
-            apps[defaultImportName(elementData.name)] = elementData.absAppPath;
-        }
-    }
-
-    const template = `
-import type { AppElement } from '@erudit-js/prose/app';
-
-${Object.entries(apps)
-    .map(
-        ([importName, importPath]) =>
-            `import ${importName} from '${importPath.replace(/\.(ts|js)$/, '')}';`,
-    )
-    .join('\n')}
-
-export const appElementsArray: AppElement[] = [
-    ${Object.keys(apps).join(',\n    ')}
-].flatMap(element => (Array.isArray(element) ? element : [element]) as any);
-
-export const appElements = Object.fromEntries(
-    appElementsArray.map(element => [element.schema.name, element])
-);
-    `.trim();
-
-    addTemplate({
-        write: true,
-        filename: '#erudit/prose/app.ts',
-        getContents: () => template,
-    });
-
-    const alias = (nuxt.options.alias ||= {});
-    alias['#erudit/prose/app'] =
-        nuxt.options.buildDir + '/#erudit/prose/app.ts';
-}
+import type { Nuxt } from 'nuxt/schema';
+import { addTemplate } from 'nuxt/kit';
+
+import type { ElementData } from './shared';
+
+export function createAppTemplate(nuxt: Nuxt, elementsData: ElementData[]) {
+  const defaultImportName = (elementName: string) => `app_${elementName}`;
+
+  const apps: Record<string, string> = {};
+
+  for (const elementData of elementsData) {
+    if (elementData.absAppPath) {
+      apps[defaultImportName(elementData.name)] = elementData.absAppPath;
+    }
+  }
+
+  const template = `
+import type { AppElement } from '@erudit-js/prose/app';
+
+${Object.entries(apps)
+  .map(
+    ([importName, importPath]) =>
+      `import ${importName} from '${importPath.replace(/\.(ts|js)$/, '')}';`,
+  )
+  .join('\n')}
+
+export const appElementsArray: AppElement[] = [
+    ${Object.keys(apps).join(',\n    ')}
+].flatMap(element => (Array.isArray(element) ? element : [element]) as any);
+
+export const appElements = Object.fromEntries(
+    appElementsArray.map(element => [element.schema.name, element])
+);
+    `.trim();
+
+  addTemplate({
+    write: true,
+    filename: '#erudit/prose/app.ts',
+    getContents: () => template,
+  });
+
+  const alias = (nuxt.options.alias ||= {});
+  alias['#erudit/prose/app'] = nuxt.options.buildDir + '/#erudit/prose/app.ts';
+}

package/modules/erudit/setup/elements/globalTemplate.ts

@@ -1,82 +1,82 @@
-import { existsSync } from 'node:fs';
-import type { Nuxt } from 'nuxt/schema';
-import { addTemplate } from 'nuxt/kit';
-
-import type { ElementData } from './shared';
-
-export function createGlobalTemplate(nuxt: Nuxt, elementsData: ElementData[]) {
-    const defaultImportName = (type: 'core' | 'global', elementName: string) =>
-        `${type}_${elementName}`;
-
-    const cores: Record<string, string> = {};
-    const globals: Record<string, string> = {};
-
-    for (const elementData of elementsData) {
-        cores[defaultImportName('core', elementData.name)] =
-            elementData.absCorePath;
-
-        if (existsSync(elementData.absDirectory + '/_global.ts')) {
-            globals[defaultImportName('global', elementData.name)] =
-                elementData.absDirectory + '/_global.ts';
-        }
-    }
-
-    const template = `
-import { PROSE_REGISTRY } from '@jsprose/core';
-import { jsx, jsxs, Fragment } from '@jsprose/core/jsx-runtime';
-import type { EruditProseCoreElement } from '@erudit-js/prose';
-import { defineProblemScript } from '@erudit-js/prose/elements/problem/problemScript';
-
-${Object.entries(cores)
-    .map(
-        ([importName, importPath]) =>
-            `import ${importName} from '${importPath.replace(/\.(ts|js)$/, '')}';`,
-    )
-    .join('\n')}
-
-${Object.entries(globals)
-    .map(
-        ([importName, importPath]) =>
-            `import ${importName} from '${importPath.replace(/\.(ts|js)$/, '')}';`,
-    )
-    .join('\n')}
-
-const coreElements: EruditProseCoreElement[] = [
-    ${Object.keys(cores).join(',\n    ')}
-].flatMap(element => (Array.isArray(element) ? element : [element]) as any);
-
-const elementsGlobals = {
-    ${Object.keys(globals)
-        .map((key) => `...${key}`)
-        .join(',\n    ')}
-}
-
-export function registerProseGlobals() {
-    for (const element of coreElements) {
-        PROSE_REGISTRY.addItem(element.registryItem);
-        Object.assign(globalThis, element.registryItem.tags || {});
-    }
-
-    Object.assign(globalThis, {
-        // Make jsx runtime globally available (for prose generation in isolated modules like problem scripts)
-        jsx,
-        jsxs,
-        Fragment,
-        // Problem globals
-        defineProblemScript,
-        // Elements globals
-        ...elementsGlobals
-    });
-}
-    `.trim();
-
-    addTemplate({
-        write: true,
-        filename: '#erudit/prose/global.ts',
-        getContents: () => template,
-    });
-
-    const alias = (nuxt.options.alias ||= {});
-    alias['#erudit/prose/global'] =
-        nuxt.options.buildDir + `/#erudit/prose/global.ts`;
-}
+import { existsSync } from 'node:fs';
+import type { Nuxt } from 'nuxt/schema';
+import { addTemplate } from 'nuxt/kit';
+
+import type { ElementData } from './shared';
+
+export function createGlobalTemplate(nuxt: Nuxt, elementsData: ElementData[]) {
+  const defaultImportName = (type: 'core' | 'global', elementName: string) =>
+    `${type}_${elementName}`;
+
+  const cores: Record<string, string> = {};
+  const globals: Record<string, string> = {};
+
+  for (const elementData of elementsData) {
+    cores[defaultImportName('core', elementData.name)] =
+      elementData.absCorePath;
+
+    if (existsSync(elementData.absDirectory + '/_global.ts')) {
+      globals[defaultImportName('global', elementData.name)] =
+        elementData.absDirectory + '/_global.ts';
+    }
+  }
+
+  const template = `
+import { PROSE_REGISTRY } from '@jsprose/core';
+import { jsx, jsxs, Fragment } from '@jsprose/core/jsx-runtime';
+import type { EruditProseCoreElement } from '@erudit-js/prose';
+import { defineProblemScript } from '@erudit-js/prose/elements/problem/problemScript';
+
+${Object.entries(cores)
+  .map(
+    ([importName, importPath]) =>
+      `import ${importName} from '${importPath.replace(/\.(ts|js)$/, '')}';`,
+  )
+  .join('\n')}
+
+${Object.entries(globals)
+  .map(
+    ([importName, importPath]) =>
+      `import ${importName} from '${importPath.replace(/\.(ts|js)$/, '')}';`,
+  )
+  .join('\n')}
+
+const coreElements: EruditProseCoreElement[] = [
+    ${Object.keys(cores).join(',\n    ')}
+].flatMap(element => (Array.isArray(element) ? element : [element]) as any);
+
+const elementsGlobals = {
+    ${Object.keys(globals)
+      .map((key) => `...${key}`)
+      .join(',\n    ')}
+}
+
+export function registerProseGlobals() {
+    for (const element of coreElements) {
+        PROSE_REGISTRY.addItem(element.registryItem);
+        Object.assign(globalThis, element.registryItem.tags || {});
+    }
+
+    Object.assign(globalThis, {
+        // Make jsx runtime globally available (for prose generation in isolated modules like problem scripts)
+        jsx,
+        jsxs,
+        Fragment,
+        // Problem globals
+        defineProblemScript,
+        // Elements globals
+        ...elementsGlobals
+    });
+}
+    `.trim();
+
+  addTemplate({
+    write: true,
+    filename: '#erudit/prose/global.ts',
+    getContents: () => template,
+  });
+
+  const alias = (nuxt.options.alias ||= {});
+  alias['#erudit/prose/global'] =
+    nuxt.options.buildDir + `/#erudit/prose/global.ts`;
+}