erudit 4.0.0-dev.4 → 4.0.0

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

@@ -1,167 +1,163 @@
-import chalk from 'chalk';
-import type { Nuxt } from 'nuxt/schema';
-import { findPath } from 'nuxt/kit';
-import type { EruditProseCoreElement } from '@erudit-js/prose';
-
-import type { EruditRuntimeConfig } from '../../../../shared/types/runtimeConfig';
-import { moduleLogger } from '../../logger';
-import type { ElementData } from './shared';
-import { createTagsTable } from './tagsTable';
-import { createGlobalTypes } from './globalTypes';
-import { createGlobalTemplate } from './globalTemplate';
-import { createAppTemplate } from './appTemplate';
-
-const BUILTIN_ELEMENT_PATHS = [
-    '@erudit-js/prose/elements/callout',
-    '@erudit-js/prose/elements/caption',
-    '@erudit-js/prose/elements/details',
-    '@erudit-js/prose/elements/emphasis',
-    '@erudit-js/prose/elements/flex',
-    '@erudit-js/prose/elements/gallery',
-    '@erudit-js/prose/elements/heading',
-    '@erudit-js/prose/elements/horizontalLine',
-    '@erudit-js/prose/elements/image',
-    '@erudit-js/prose/elements/lineBreak',
-    '@erudit-js/prose/elements/link/dependency',
-    '@erudit-js/prose/elements/link/reference',
-    '@erudit-js/prose/elements/list',
-    '@erudit-js/prose/elements/paragraph',
-    '@erudit-js/prose/elements/problem',
-    '@erudit-js/prose/elements/table',
-    '@erudit-js/prose/elements/video',
-];
-
-export async function setupProseElements(
-    nuxt: Nuxt,
-    runtimeConfig: EruditRuntimeConfig,
-) {
-    const elementsData: ElementData[] = [];
-
-    const seenElements = new Set<string>();
-    const seenSchemas = new Set<string>();
-    const seenTags = new Set<string>();
-
-    const elementPaths: string[] = [
-        ...BUILTIN_ELEMENT_PATHS,
-        ...runtimeConfig.project.elements,
-    ];
-
-    for (const elementPath of elementPaths) {
-        const pathParts = elementPath.split('/');
-        let elementName = pathParts[pathParts.length - 1]!;
-        let uniqueElementName = elementName;
-        let counter = 1;
-        while (seenElements.has(uniqueElementName)) {
-            uniqueElementName = `${elementName}_${counter}`;
-            counter++;
-        }
-        seenElements.add(uniqueElementName);
-
-        const elementData: ElementData = {
-            name: uniqueElementName,
-            registryItems: [],
-            absDirectory: '',
-            absCorePath: '',
-            absAppPath: undefined,
-        };
-
-        const corePath = elementPath + '/core';
-        const coreAbsPath = await findPath(corePath, {
-            cwd: runtimeConfig.paths.project,
-            extensions: ['.ts', '.js'],
-        });
-
-        if (!coreAbsPath) {
-            throw new Error(
-                `Failed to detect "core" part of prose element "${elementPath}"!`,
-            );
-        }
-
-        elementData.absCorePath = coreAbsPath;
-        elementData.absDirectory = coreAbsPath.replace(
-            /\/core\.(?:ts|js)$/,
-            '',
-        );
-
-        const appPath = elementPath + '/app';
-        const appAbsPath = await findPath(appPath, {
-            cwd: runtimeConfig.paths.project,
-            extensions: ['.ts', '.js'],
-        });
-
-        if (appAbsPath) {
-            elementData.absAppPath = appAbsPath;
-        }
-
-        const coreDefault: EruditProseCoreElement | EruditProseCoreElement[] = (
-            await import(coreAbsPath)
-        ).default;
-
-        const coreElements = Array.isArray(coreDefault)
-            ? coreDefault
-            : [coreDefault];
-
-        for (const coreElement of coreElements) {
-            const schemaName = coreElement.registryItem.schema.name;
-
-            if (seenSchemas.has(schemaName)) {
-                throw new Error(
-                    `Prose element schema name "${schemaName}" is already registered by another element!`,
-                );
-            }
-
-            seenSchemas.add(schemaName);
-            elementData.registryItems.push({
-                schemaName,
-                tagNames: [],
-            });
-
-            if (coreElement.registryItem.tags) {
-                for (const tagName of Object.keys(
-                    coreElement.registryItem.tags,
-                )) {
-                    if (seenTags.has(tagName)) {
-                        throw new Error(
-                            `Prose element tag name "<${tagName}>" is already registered by another element!`,
-                        );
-                    }
-
-                    seenTags.add(tagName);
-                    elementData.registryItems[
-                        elementData.registryItems.length - 1
-                    ]!.tagNames.push(tagName);
-                }
-            }
-
-            const transpile = (nuxt.options.build.transpile ||= []);
-            const optimizeDeps = nuxt.options.vite.optimizeDeps || {};
-            const optimizeDepsInclude = (optimizeDeps.include ||= []);
-
-            for (const [name, options] of Object.entries(
-                coreElement.dependencies ?? {},
-            )) {
-                if (options?.transpile) transpile.push(name);
-                if (options?.optimize) optimizeDepsInclude.push(name);
-            }
-        }
-
-        elementsData.push(elementData);
-    }
-
-    createGlobalTypes(runtimeConfig, elementsData);
-    createGlobalTemplate(nuxt, elementsData);
-    createAppTemplate(nuxt, elementsData);
-
-    const elementsNumber = elementsData.length;
-    const schemasNumber = seenSchemas.size;
-    const tagsNumber = seenTags.size;
-
-    moduleLogger.success(
-        `
-Registered ${elementsNumber} prose elements: ${schemasNumber} schema(s) and ${tagsNumber} tag(s)!
-        `.trim(),
-    );
-
-    const tagsTable = createTagsTable(elementsData);
-    console.log(chalk.gray(tagsTable));
-}
+import chalk from 'chalk';
+import type { Nuxt } from 'nuxt/schema';
+import { findPath } from 'nuxt/kit';
+import type { EruditProseCoreElement } from '@erudit-js/prose';
+
+import type { EruditRuntimeConfig } from '../../../../shared/types/runtimeConfig';
+import { moduleLogger } from '../../logger';
+import type { ElementData } from './shared';
+import { createTagsTable } from './tagsTable';
+import { createGlobalTypes } from './globalTypes';
+import { createGlobalTemplate } from './globalTemplate';
+import { createAppTemplate } from './appTemplate';
+import { PROJECT_PATH } from '../../env';
+
+const BUILTIN_ELEMENT_PATHS = [
+  '@erudit-js/prose/elements/callout',
+  '@erudit-js/prose/elements/caption',
+  '@erudit-js/prose/elements/details',
+  '@erudit-js/prose/elements/emphasis',
+  '@erudit-js/prose/elements/flex',
+  '@erudit-js/prose/elements/gallery',
+  '@erudit-js/prose/elements/heading',
+  '@erudit-js/prose/elements/horizontalLine',
+  '@erudit-js/prose/elements/image',
+  '@erudit-js/prose/elements/lineBreak',
+  '@erudit-js/prose/elements/link/dependency',
+  '@erudit-js/prose/elements/link/reference',
+  '@erudit-js/prose/elements/list',
+  '@erudit-js/prose/elements/paragraph',
+  '@erudit-js/prose/elements/problem',
+  '@erudit-js/prose/elements/table',
+  '@erudit-js/prose/elements/video',
+];
+
+export async function setupProseElements(
+  nuxt: Nuxt,
+  runtimeConfig: EruditRuntimeConfig,
+) {
+  const elementsData: ElementData[] = [];
+
+  const seenElements = new Set<string>();
+  const seenSchemas = new Set<string>();
+  const seenTags = new Set<string>();
+
+  const elementPaths: string[] = [
+    ...BUILTIN_ELEMENT_PATHS,
+    ...runtimeConfig.elements,
+  ];
+
+  for (const elementPath of elementPaths) {
+    const pathParts = elementPath.split('/');
+    let elementName = pathParts[pathParts.length - 1]!;
+    let uniqueElementName = elementName;
+    let counter = 1;
+    while (seenElements.has(uniqueElementName)) {
+      uniqueElementName = `${elementName}_${counter}`;
+      counter++;
+    }
+    seenElements.add(uniqueElementName);
+
+    const elementData: ElementData = {
+      name: uniqueElementName,
+      registryItems: [],
+      absDirectory: '',
+      absCorePath: '',
+      absAppPath: undefined,
+    };
+
+    const corePath = elementPath + '/core';
+    const coreAbsPath = await findPath(corePath, {
+      cwd: PROJECT_PATH,
+      extensions: ['.ts', '.js'],
+    });
+
+    if (!coreAbsPath) {
+      throw new Error(
+        `Failed to detect "core" part of prose element "${elementPath}"!`,
+      );
+    }
+
+    elementData.absCorePath = coreAbsPath;
+    elementData.absDirectory = coreAbsPath.replace(/\/core\.(?:ts|js)$/, '');
+
+    const appPath = elementPath + '/app';
+    const appAbsPath = await findPath(appPath, {
+      cwd: PROJECT_PATH,
+      extensions: ['.ts', '.js'],
+    });
+
+    if (appAbsPath) {
+      elementData.absAppPath = appAbsPath;
+    }
+
+    const coreDefault: EruditProseCoreElement | EruditProseCoreElement[] = (
+      await import(coreAbsPath)
+    ).default;
+
+    const coreElements = Array.isArray(coreDefault)
+      ? coreDefault
+      : [coreDefault];
+
+    for (const coreElement of coreElements) {
+      const schemaName = coreElement.registryItem.schema.name;
+
+      if (seenSchemas.has(schemaName)) {
+        throw new Error(
+          `Prose element schema name "${schemaName}" is already registered by another element!`,
+        );
+      }
+
+      seenSchemas.add(schemaName);
+      elementData.registryItems.push({
+        schemaName,
+        tagNames: [],
+      });
+
+      if (coreElement.registryItem.tags) {
+        for (const tagName of Object.keys(coreElement.registryItem.tags)) {
+          if (seenTags.has(tagName)) {
+            throw new Error(
+              `Prose element tag name "<${tagName}>" is already registered by another element!`,
+            );
+          }
+
+          seenTags.add(tagName);
+          elementData.registryItems[
+            elementData.registryItems.length - 1
+          ]!.tagNames.push(tagName);
+        }
+      }
+
+      const transpile = (nuxt.options.build.transpile ||= []);
+      const optimizeDeps = nuxt.options.vite.optimizeDeps || {};
+      const optimizeDepsInclude = (optimizeDeps.include ||= []);
+
+      for (const [name, options] of Object.entries(
+        coreElement.dependencies ?? {},
+      )) {
+        if (options?.transpile) transpile.push(name);
+        if (options?.optimize) optimizeDepsInclude.push(name);
+      }
+    }
+
+    elementsData.push(elementData);
+  }
+
+  createGlobalTypes(elementsData);
+  createGlobalTemplate(nuxt, elementsData);
+  createAppTemplate(nuxt, elementsData);
+
+  const elementsNumber = elementsData.length;
+  const schemasNumber = seenSchemas.size;
+  const tagsNumber = seenTags.size;
+
+  moduleLogger.success(
+    `
+Registered ${elementsNumber} prose elements: ${schemasNumber} schema(s) and ${tagsNumber} tag(s)!
+        `.trim(),
+  );
+
+  const tagsTable = createTagsTable(elementsData);
+  console.log(chalk.gray(tagsTable));
+}

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

@@ -1,10 +1,10 @@
-export interface ElementData {
-    name: string;
-    registryItems: {
-        schemaName: string;
-        tagNames: string[];
-    }[];
-    absDirectory: string;
-    absCorePath: string;
-    absAppPath: string | undefined;
-}
+export interface ElementData {
+  name: string;
+  registryItems: {
+    schemaName: string;
+    tagNames: string[];
+  }[];
+  absDirectory: string;
+  absCorePath: string;
+  absAppPath: string | undefined;
+}

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

@@ -1,28 +1,28 @@
-import type { ElementData } from './shared';
-
-export function createTagsTable(elementsData: ElementData[], columns = 4) {
-    const tagNames = elementsData.flatMap((data) =>
-        data.registryItems.flatMap((item) => item.tagNames),
-    );
-
-    if (tagNames.length === 0) return '';
-
-    const cols = Math.max(1, columns);
-    const formatted = tagNames.map((t) => `<${t}>`);
-    const maxLen = Math.max(...formatted.map((s) => s.length));
-    const colWidth = maxLen + 2; // padding between columns
-
-    const rows = Math.ceil(formatted.length / cols);
-    const lines: string[] = [];
-
-    for (let r = 0; r < rows; r++) {
-        const start = r * cols;
-        const rowItems = formatted.slice(start, start + cols);
-        const padded = rowItems.map((s) => s.padEnd(colWidth, ' '));
-        lines.push(padded.join('').replace(/\s+$/u, '')); // trim trailing spaces on the row
-    }
-
-    const tagTable = lines.join('\n');
-
-    return tagTable;
-}
+import type { ElementData } from './shared';
+
+export function createTagsTable(elementsData: ElementData[], columns = 4) {
+  const tagNames = elementsData.flatMap((data) =>
+    data.registryItems.flatMap((item) => item.tagNames),
+  );
+
+  if (tagNames.length === 0) return '';
+
+  const cols = Math.max(1, columns);
+  const formatted = tagNames.map((t) => `<${t}>`);
+  const maxLen = Math.max(...formatted.map((s) => s.length));
+  const colWidth = maxLen + 2; // padding between columns
+
+  const rows = Math.ceil(formatted.length / cols);
+  const lines: string[] = [];
+
+  for (let r = 0; r < rows; r++) {
+    const start = r * cols;
+    const rowItems = formatted.slice(start, start + cols);
+    const padded = rowItems.map((s) => s.padEnd(colWidth, ' '));
+    lines.push(padded.join('').replace(/\s+$/u, '')); // trim trailing spaces on the row
+  }
+
+  const tagTable = lines.join('\n');
+
+  return tagTable;
+}

package/modules/erudit/setup/fullRestart.ts

@@ -1,71 +1,61 @@
-import type { Nuxt } from '@nuxt/schema';
-import { debounce } from 'perfect-debounce';
-import { globSync } from 'glob';
-import chalk from 'chalk';
-import slash from 'slash';
-
-import { ERUDIT_PACKAGE_WATCHER, ERUDIT_PROJECT_WATCHER } from '../watcher';
-import { moduleLogger } from '../logger';
-import type { EruditRuntimeConfig } from '../../../shared/types/runtimeConfig';
-
-export async function setupEruditFullRestart(
-    nuxt: Nuxt,
-    runtimeConfig: EruditRuntimeConfig,
-) {
-    const paths = runtimeConfig.paths;
-    const changedPaths = new Set<string>();
-
-    const tryRestartNuxt = debounce(async () => {
-        const files = Array.from(changedPaths);
-        changedPaths.clear();
-
-        moduleLogger.warn(
-            `${chalk.yellow('Full restart due to critical file change(s):')}\n\n` +
-                files
-                    .map((p, i) => chalk.gray(`${i + 1} -`) + ` "${p}"`)
-                    .join('\n'),
-        );
-
-        await nuxt.callHook('close', nuxt);
-        process.exit(1337);
-    }, 300);
-
-    const isTargetFile = (path: string): boolean => {
-        // Check if it's in the module directory
-        if (path.startsWith(paths.module)) {
-            return true;
-        }
-
-        // Check if it's in package/shared
-        if (path.startsWith(paths.package + '/shared')) {
-            return true;
-        }
-
-        // Check if it's nuxt.config.ts in package
-        if (path === paths.package + '/nuxt.config.ts') {
-            return true;
-        }
-
-        // Check if it's erudit.config.{js,ts} in project
-        const configFiles = globSync(
-            paths.project + '/erudit.config.{js,ts}',
-        ).map((p) => slash(p));
-        if (configFiles.includes(path)) {
-            return true;
-        }
-
-        return false;
-    };
-
-    const handleFileChange = (_event: string, path: string) => {
-        path = slash(path);
-
-        if (path.trim() && isTargetFile(path)) {
-            changedPaths.add(String(path));
-            tryRestartNuxt();
-        }
-    };
-
-    ERUDIT_PACKAGE_WATCHER?.on('all', handleFileChange);
-    ERUDIT_PROJECT_WATCHER?.on('all', handleFileChange);
-}
+import type { Nuxt } from '@nuxt/schema';
+import { debounce } from 'perfect-debounce';
+import chalk from 'chalk';
+import { sn } from 'unslash';
+
+import { ERUDIT_PACKAGE_WATCHER, ERUDIT_PROJECT_WATCHER } from '../watcher';
+import { moduleLogger } from '../logger';
+import { ERUDIT_PATH, PROJECT_PATH } from '../env';
+
+export async function setupEruditFullRestart(nuxt: Nuxt) {
+  const changedPaths = new Set<string>();
+
+  const tryRestartNuxt = debounce(async () => {
+    const files = Array.from(changedPaths);
+    changedPaths.clear();
+
+    moduleLogger.warn(
+      `${chalk.yellow('Full restart due to critical file change(s):')}\n\n` +
+        files.map((p, i) => chalk.gray(`${i + 1} -`) + ` "${p}"`).join('\n'),
+    );
+
+    await nuxt.callHook('close', nuxt);
+    process.exit(1337);
+  }, 300);
+
+  const isTargetFile = (path: string): boolean => {
+    // Check if it is in Erudit Nuxt Layer "modules" directory
+    if (path.startsWith(sn(ERUDIT_PATH, 'modules'))) {
+      return true;
+    }
+
+    // Check if it is in Erudit Nuxt Layer "shared" directory
+    if (path.startsWith(sn(ERUDIT_PATH, 'shared'))) {
+      return true;
+    }
+
+    // Check if it is Erudit Nuxt Layer "nuxt.config.ts" file
+    if (path === sn(ERUDIT_PATH, 'nuxt.config.ts')) {
+      return true;
+    }
+
+    // Check if it is project "erudit.config.ts" file
+    if (path === sn(PROJECT_PATH, 'erudit.config.ts')) {
+      return true;
+    }
+
+    return false;
+  };
+
+  const handleFileChange = (_event: string, path: string) => {
+    path = sn(path);
+
+    if (path.trim() && isTargetFile(path)) {
+      changedPaths.add(String(path));
+      tryRestartNuxt();
+    }
+  };
+
+  ERUDIT_PACKAGE_WATCHER?.on('all', handleFileChange);
+  ERUDIT_PROJECT_WATCHER?.on('all', handleFileChange);
+}