@emulsify/core 3.4.1 → 4.0.0

package/config/vite/plugins/source-file-index.js

@@ -0,0 +1,184 @@
+/**
+ * @file Source file discovery helpers shared by Emulsify Vite copy plugins.
+ *
+ * This module walks resolved source roots once, then exposes filtered views for
+ * component and global files so copy plugins share the same filesystem model.
+ */
+
+import { readdirSync } from 'fs';
+import { join, relative, sep } from 'path';
+
+import { relativeFrom } from '../project-structure.js';
+
+const DEFAULT_SKIP_DIRS = [
+  'node_modules',
+  '.git',
+  '.cache',
+  '.vite',
+  '.out',
+  '.coverage',
+  'dist',
+];
+
+/**
+ * Depth-first walk to list every file under a given root.
+ *
+ * @param {string} rootDir - Directory to traverse.
+ * @param {{
+ *   shouldSkipDir?: (dir: string) => boolean,
+ *   useDefaultSkips?: boolean
+ * }} [options] - Traversal options.
+ * @returns {string[]} Absolute file paths.
+ */
+export function walkFiles(
+  rootDir,
+  { shouldSkipDir = () => false, useDefaultSkips = true } = {},
+) {
+  const files = [];
+  const stack = [rootDir];
+
+  while (stack.length) {
+    const currentDir = stack.pop();
+    if (!currentDir) continue;
+
+    let entryNames = [];
+    try {
+      // eslint-disable-next-line security/detect-non-literal-fs-filename
+      entryNames = readdirSync(currentDir, { withFileTypes: true }).sort(
+        (a, b) => a.name.localeCompare(b.name),
+      );
+    } catch {
+      // Skip unreadable directories and keep walking the remaining stack.
+      continue;
+    }
+
+    for (const entry of entryNames) {
+      const fullPath = join(currentDir, entry.name);
+      if (entry.isDirectory()) {
+        if (shouldSkipDir(fullPath)) continue;
+        if (useDefaultSkips && DEFAULT_SKIP_DIRS.includes(entry.name)) {
+          continue;
+        }
+        stack.push(fullPath);
+      } else if (entry.isFile()) {
+        files.push(fullPath);
+      }
+    }
+  }
+
+  return files;
+}
+
+/**
+ * Determine whether a directory is the same as, or nested inside, another one.
+ *
+ * @param {string} candidateDir - Directory to test.
+ * @param {string} rootDir - Boundary directory.
+ * @returns {boolean} TRUE when candidateDir is the root or inside it.
+ */
+export function isSameOrInsideDir(candidateDir, rootDir) {
+  const rel = relative(rootDir, candidateDir);
+  return !rel || (!rel.startsWith('..') && !rel.includes(`..${sep}`));
+}
+
+/**
+ * Determine whether a file is component metadata copied beside Twig templates.
+ *
+ * @param {string} filePath - Absolute or relative file path.
+ * @returns {boolean} TRUE for component metadata files.
+ */
+export const isComponentMetadataFile = (filePath) =>
+  /\.component\.(yml|yaml|json)$/i.test(filePath);
+
+/**
+ * Determine whether a file should be copied by the static asset pass.
+ *
+ * @param {string} filePath - Absolute or relative file path.
+ * @returns {boolean} TRUE for non-code source assets.
+ */
+export const isStaticSourceAsset = (filePath) =>
+  !/\.(jsx?|scss|twig|map)$/i.test(filePath) &&
+  !isComponentMetadataFile(filePath);
+
+/**
+ * Build the roots that should not be crawled during a global source pass.
+ *
+ * @param {{ directory: string }} globalRoot - Global source root record.
+ * @param {{ directory: string }[]} componentRoots - Component source root records.
+ * @returns {string[]} Directory paths to skip.
+ */
+const globalTraversalSkipRoots = (globalRoot, componentRoots) => {
+  const configuredSkips = [
+    join(globalRoot.directory, 'components'),
+    join(globalRoot.directory, 'util'),
+  ];
+  const nestedComponentRoots = componentRoots
+    .map((root) => root.directory)
+    .filter(
+      (directory) =>
+        directory !== globalRoot.directory &&
+        isSameOrInsideDir(directory, globalRoot.directory),
+    );
+
+  return [...configuredSkips, ...nestedComponentRoots];
+};
+
+/**
+ * Create a lazy, shared index of files under the resolved project source roots.
+ * Accessors return the same array reference between calls for a single index
+ * instance once the file tree has been built.
+ *
+ * @param {object} structure - Resolved project structure.
+ * @returns {{
+ *   all: () => Array<object>,
+ *   componentFiles: () => Array<object>,
+ *   globalFiles: () => Array<object>
+ * }} Indexed file accessors.
+ */
+export function createSourceFileIndex(structure) {
+  let indexedFiles = null;
+  let componentFilesArr = null;
+  let globalFilesArr = null;
+
+  const indexRoot = (root, rootType, options = {}) =>
+    walkFiles(root.directory, options).map((absPath) => ({
+      absPath,
+      relPath: relativeFrom(absPath, root.directory),
+      root,
+      rootType,
+    }));
+
+  const build = () => {
+    if (indexedFiles) return indexedFiles;
+
+    componentFilesArr = structure.componentRootRecords.flatMap((root) =>
+      indexRoot(root, 'component'),
+    );
+    globalFilesArr = structure.globalRootRecords.flatMap((root) => {
+      const skipRoots = globalTraversalSkipRoots(
+        root,
+        structure.componentRootRecords,
+      );
+
+      return indexRoot(root, 'global', {
+        shouldSkipDir: (directory) =>
+          skipRoots.some((skipRoot) => isSameOrInsideDir(directory, skipRoot)),
+      });
+    });
+
+    indexedFiles = [...componentFilesArr, ...globalFilesArr];
+    return indexedFiles;
+  };
+
+  return {
+    all: build,
+    componentFiles: () => {
+      build();
+      return componentFilesArr;
+    },
+    globalFiles: () => {
+      build();
+      return globalFilesArr;
+    },
+  };
+}

package/config/vite/plugins/svg-sprite.js

@@ -0,0 +1,117 @@
+/**
+ * @file SVG sprite file plugin.
+ *
+ * Builds a physical `dist/assets/icons.svg` sprite from configured SVG globs so
+ * Drupal and static consumers can reference a stable emitted spritemap asset.
+ */
+
+import { readFileSync } from 'fs';
+import { basename } from 'path';
+import { globSync } from 'glob';
+
+import { toPosixPath } from '../utils/paths.js';
+import { unique } from '../utils/unique.js';
+
+/**
+ * Builds a single SVG sprite file from a set of icon globs.
+ *
+ * @param {{ include: string|string[], symbolId?: string }} options - Plugin options.
+ * @returns {import('vite').PluginOption} SVG sprite plugin.
+ */
+export function svgSpriteFilePlugin({ include, symbolId = '[name]' }) {
+  const toArray = (x) => (Array.isArray(x) ? x : [x]).filter(Boolean);
+
+  /** @type {string[]} */
+  let patterns = [];
+  /** @type {string[]} */
+  let iconFiles = [];
+  let iconFilesResolved = false;
+
+  const collectIconFiles = () => {
+    if (iconFilesResolved) return iconFiles;
+    iconFiles = unique(
+      patterns.flatMap((p) => globSync(p)).filter(Boolean),
+    ).sort((a, b) => toPosixPath(a).localeCompare(toPosixPath(b)));
+    iconFilesResolved = true;
+    return iconFiles;
+  };
+
+  return {
+    name: 'emulsify-svg-sprite-file',
+    apply: 'build',
+
+    /** Register icons for watch. */
+    buildStart() {
+      patterns = toArray(include).map(toPosixPath);
+      iconFilesResolved = false;
+      for (const f of collectIconFiles()) {
+        try {
+          this.addWatchFile(f);
+        } catch {
+          /* noop */
+        }
+      }
+    },
+
+    /** Concatenate all matched SVGs into a single sprite. */
+    generateBundle() {
+      const files = collectIconFiles();
+
+      if (!files.length) return;
+
+      const used = new Set();
+      const makeId = (abs) => {
+        const stem = basename(abs).replace(/\.svg$/i, '');
+        let id = symbolId
+          .replace('[name]', stem)
+          .toLowerCase()
+          .replace(/[^a-z0-9_-]+/g, '-')
+          .replace(/^-+|-+$/g, '');
+        if (!used.has(id)) {
+          used.add(id);
+          return id;
+        }
+        let i = 2;
+        while (used.has(`${id}-${i}`)) i += 1;
+        id = `${id}-${i}`;
+        used.add(id);
+        return id;
+      };
+
+      const symbols = files
+        .map((abs) => {
+          let content = '';
+          try {
+            // eslint-disable-next-line security/detect-non-literal-fs-filename
+            content = readFileSync(abs, 'utf8');
+          } catch {
+            return '';
+          }
+          const m = content.match(/<svg\b([^>]*)>([\s\S]*?)<\/svg>/i);
+          const inner = (m ? m[2] : content)
+            .replace(/<\/*symbol[^>]*>/gi, '')
+            .replace(/<\/*defs[^>]*>/gi, '')
+            // Drop namespace-prefixed attributes that lose their prefix in the merged sprite.
+            .replace(/\s+[a-zA-Z0-9_-]+:[a-zA-Z0-9_.-]+="[^"]*"/g, '')
+            .trim();
+          const attrs = m ? m[1] : '';
+          const vb = attrs.match(/\bviewBox="([^"]+)"/i);
+          const viewBoxAttr = vb ? ` viewBox="${vb[1]}"` : '';
+          return `<symbol id="${makeId(abs)}"${viewBoxAttr}>${inner}</symbol>`;
+        })
+        .filter(Boolean);
+
+      const sprite = [
+        '<svg xmlns="http://www.w3.org/2000/svg" style="display:none">',
+        ...symbols,
+        '</svg>\n',
+      ].join('\n');
+
+      this.emitFile({
+        type: 'asset',
+        fileName: 'assets/icons.svg',
+        source: sprite,
+      });
+    },
+  };
+}

package/config/vite/plugins/twig-extension-installers.js

@@ -0,0 +1,36 @@
+/**
+ * @file Virtual Twig.js extension installer module for Storybook.
+ */
+
+import { generateTwigExtensionInstallersModule } from '../twig-extensions.js';
+
+export const VIRTUAL_TWIG_EXTENSION_INSTALLERS_ID =
+  'virtual:emulsify-twig-extension-installers';
+
+const resolvedVirtualTwigExtensionInstallersId = `\0${VIRTUAL_TWIG_EXTENSION_INSTALLERS_ID}`;
+
+/**
+ * Provide configured Twig.js extension installers to browser-rendered modules.
+ *
+ * @param {object} [env={}] - Normalized Emulsify environment.
+ * @returns {import('vite').PluginOption} Vite virtual module plugin.
+ */
+export function virtualTwigExtensionInstallersPlugin(env = {}) {
+  return {
+    name: 'emulsify-virtual-twig-extension-installers',
+    resolveId(id) {
+      if (id === VIRTUAL_TWIG_EXTENSION_INSTALLERS_ID) {
+        return resolvedVirtualTwigExtensionInstallersId;
+      }
+
+      return null;
+    },
+    load(id) {
+      if (id === resolvedVirtualTwigExtensionInstallersId) {
+        return generateTwigExtensionInstallersModule(env);
+      }
+
+      return null;
+    },
+  };
+}