@emulsify/core 3.5.0 → 4.0.0

package/config/webpack/plugins.js

@@ -1,283 +0,0 @@
-import { resolve, dirname, relative } from 'path';
-import webpack from 'webpack';
-import { CleanWebpackPlugin } from 'clean-webpack-plugin';
-import RemoveEmptyScriptsPlugin from 'webpack-remove-empty-scripts';
-import MiniCssExtractPlugin from 'mini-css-extract-plugin';
-import SVGSpritemapPlugin from 'svg-spritemap-webpack-plugin';
-import CopyPlugin from 'copy-webpack-plugin';
-import { sync as globSync } from 'glob';
-import fs from 'fs-extra';
-import emulsifyConfig from '../../../../../project.emulsify.json' with { type: 'json' };
-
-/**
- * Resolve the directory of this file (without fileURLToPath).
- * @type {string}
- */
-let _filename = decodeURIComponent(new URL(import.meta.url).pathname);
-if (process.platform === 'win32' && _filename.startsWith('/')) {
-  _filename = _filename.slice(1);
-}
-const _dirname = dirname(_filename);
-
-/**
- * Project root (five levels up).
- * @type {string}
- */
-const projectDir = resolve(_dirname, '../../../../..');
-
-/**
- * Where source files live.
- * Prefer `<project>/src`; fall back to `<project>/components` (legacy layout).
- * @type {string}
- */
-const srcPath = resolve(projectDir, 'src');
-const isSrcExists = fs.pathExistsSync(srcPath);
-const srcDir = isSrcExists ? srcPath : resolve(projectDir, 'components');
-
-/**
- * Where built assets live.
- * If `src/` exists, use `<project>/dist`; else write into `<project>/components`.
- * @type {string}
- */
-const distPath = isSrcExists
-  ? resolve(projectDir, 'dist')
-  : resolve(projectDir, 'components');
-
-/**
- * Platform switch (affects component output roots).
- * @type {boolean}
- */
-const isDrupal = emulsifyConfig?.project?.platform === 'drupal';
-
-/**
- * Component source root:
- *  - with src/: `<project>/src/components`
- *  - without src/: `<project>/components`
- * @type {string}
- */
-const componentsSrcRoot = isSrcExists ? resolve(srcDir, 'components') : srcDir;
-
-/**
- * Component output root (where compiled component assets go):
- *  - Drupal + src/: `components/…`
- *  - Otherwise:     `dist/components/…`
- * (Relative to `projectDir`; used by CopyPlugins `to:` path.)
- * @type {string}
- */
-const componentsOutRoot =
-  isDrupal && isSrcExists ? 'components' : 'dist/components';
-
-/**
- * Glob pattern for Twig & component meta files. These are copied as-is so
- * Drupal/WordPress themes can consume them alongside compiled assets.
- * @type {string}
- */
-const componentFilesPattern = resolve(
-  srcDir,
-  '**/*.{twig,component.yml,component.json}',
-);
-
-/**
- * Build CopyPlugin patterns from a glob matcher, preserving source structure.
- *
- * @param {string} filesMatcher - Glob for files to mirror.
- * @returns {Array<{from:string,to:string}>} Copy patterns for CopyPlugin.
- */
-function getPatterns(filesMatcher) {
-  return globSync(filesMatcher).map((file) => {
-    const projectPath = file.split('/src/')[0]; // base path before /src/
-    const srcStructure = file.split(`${srcDir}/`)[1];
-    const parentDir = srcStructure.split('/')[0];
-
-    // Consolidate foundation/layout under "components" for Drupal.
-    const consolidateDirs =
-      parentDir === 'layout' || parentDir === 'foundation'
-        ? '/components/'
-        : '/';
-
-    const filePath = file.split(/(foundation\/|components\/|layout\/)/)[2];
-
-    const to = isDrupal
-      ? `${projectPath}${consolidateDirs}${parentDir}/${filePath}`
-      : `${projectPath}/dist/${parentDir}/${filePath}`;
-
-    return { from: file, to };
-  });
-}
-
-/**
- * CopyPlugin instance (only when `src/` exists):
- * copies Twig and component meta files 1:1 into their expected destinations.
- * @type {CopyPlugin|false}
- */
-const CopyTwigPlugin = isSrcExists
-  ? new CopyPlugin({ patterns: getPatterns(componentFilesPattern) })
-  : false;
-
-/* -------------------------------------------------------------------------- */
-/*                          COMPONENT & GLOBAL ASSETS                          */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Asset allow-list (extensions we consider "static assets" to mirror).
- * Extend to suit your project (e.g., add `pdf`, `txt`, `xml`, etc.).
- * NOTE: We purposefully exclude code-like files via the filter below.
- * @type {RegExp}
- */
-const ASSET_EXT_RE =
-  /\.(?:png|jpe?g|gif|svg|webp|avif|ico|bmp|heic|heif|mp4|webm|mp3|ogg|wav|aac|woff2?|ttf|otf|eot|json|webmanifest|manifest|pdf)$/i;
-
-/**
- * Exclude code & tooling files (don’t mirror these).
- * @type {RegExp}
- */
-const EXCLUDE_CODE_RE =
-  /\.(?:jsx?|tsx?|mjs|cjs|vue|svelte|scss|sass|less|styl|css|map|twig|php|yml|yaml|md|markdown|story(?:book)?\.[jt]sx?|stories\.[jt]sx?|test\.[jt]sx?)$/i;
-
-/**
- * Shared filter for CopyPlugin patterns.
- * Decides whether a file should be copied as a "static asset".
- *
- * @param {string} resourcePath - Absolute file path on disk.
- * @param {string} base - The context directory for the pattern.
- * @returns {boolean} True if we should copy the file.
- */
-const assetFilter = (resourcePath, base) => {
-  const rel = relative(base, resourcePath);
-  // Guard: stay inside context
-  if (rel.startsWith('..')) return false;
-  // Exclude typical code/tooling files
-  if (EXCLUDE_CODE_RE.test(rel)) return false;
-  // Include known asset extensions
-  return ASSET_EXT_RE.test(rel);
-};
-
-/**
- * Copy **all static assets inside components**, regardless of folder labels.
- *
- * Examples (all preserved under the component’s output root):
- *   src/components/accordion/assets/dropdown-icon.svg
- *   src/components/accordion/images/icons/chevron.svg
- *   src/components/accordion/icon.svg                 (root-level asset)
- *
- * @type {CopyPlugin}
- */
-const CopyComponentAssetsPlugin = new CopyPlugin({
-  patterns: [
-    {
-      // Start at the components root and evaluate every file
-      from: '**/*',
-      context: componentsSrcRoot,
-      to: resolve(projectDir, componentsOutRoot, '[path][name][ext]'),
-      noErrorOnMissing: true,
-      globOptions: {
-        dot: false,
-        ignore: [
-          '**/.DS_Store',
-          '**/Thumbs.db',
-          '**/node_modules/**',
-          '**/dist/**',
-        ],
-      },
-      // Only copy files that match our asset allow-list and are not code
-      filter: (resourcePath) => assetFilter(resourcePath, componentsSrcRoot),
-    },
-  ],
-});
-
-/**
- * OPTIONAL: Copy **global (non-component) assets** that live under `src/`
- * but outside `src/components/` (e.g. layout/site assets).
- *
- * Mirrors them under `dist/global/…`.
- * Disabled when there is no `src/` directory.
- *
- * @type {CopyPlugin|false}
- */
-const CopyGlobalAssetsPlugin = isSrcExists
-  ? new CopyPlugin({
-      patterns: [
-        {
-          from: '!(components|util)/**/*',
-          context: srcDir,
-          to: resolve(projectDir, 'dist', 'global', '[path][name][ext]'),
-          noErrorOnMissing: true,
-          globOptions: {
-            dot: false,
-            ignore: [
-              '**/.DS_Store',
-              '**/Thumbs.db',
-              '**/node_modules/**',
-              '**/dist/**',
-            ],
-          },
-          filter: (resourcePath) => assetFilter(resourcePath, srcDir),
-        },
-      ],
-    })
-  : false;
-
-/* -------------------------------------------------------------------------- */
-/*                                 OTHER PLUGINS                               */
-/* -------------------------------------------------------------------------- */
-
-/**
- * CleanWebpackPlugin configuration.
- * Wipes out compiled CSS/JS in `distPath` before a build; keeps images.
- */
-const CleanPlugin = new CleanWebpackPlugin({
-  protectWebpackAssets: false,
-  cleanOnceBeforeBuildPatterns: [
-    `${distPath}/**/*.css`,
-    `${distPath}/**/*.js`,
-    `!${distPath}/**/*.png`,
-    `!${distPath}/**/*.jpg`,
-    `!${distPath}/**/*.gif`,
-    `!${distPath}/**/*.svg`,
-  ],
-});
-
-/** Removes empty JS files generated for style-only entries. */
-const RemoveEmptyJS = new RemoveEmptyScriptsPlugin();
-
-/**
- * MiniCssExtractPlugin: emit CSS next to the entry key path (no hard-coded dist/).
- */
-const CssExtractPlugin = new MiniCssExtractPlugin({
-  filename: ({ chunk }) => `${chunk.name}.css`,
-  chunkFilename: ({ chunk }) => `${chunk.name}.css`,
-});
-
-/**
- * Generate a single SVG spritemap at `dist/icons.svg`.
- */
-const SpritePlugin = new SVGSpritemapPlugin(
-  resolve(projectDir, 'assets/icons/**/*.svg'),
-  {
-    output: {
-      filename: 'dist/icons.svg',
-      chunk: { keep: true },
-    },
-    sprite: {
-      prefix: '',
-      generate: { title: false },
-    },
-  },
-);
-
-/** Build progress output. */
-const ProgressPlugin = new webpack.ProgressPlugin();
-
-/**
- * Export plugin instances keyed for easy inclusion in your Webpack config.
- */
-export default {
-  ProgressPlugin,
-  CleanWebpackPlugin: CleanPlugin,
-  RemoveEmptyJS,
-  MiniCssExtractPlugin: CssExtractPlugin,
-  SpritePlugin,
-  CopyTwigPlugin,
-  CopyComponentAssetsPlugin,
-  CopyGlobalAssetsPlugin,
-};

package/config/webpack/resolves.js

@@ -1,157 +0,0 @@
-/**
- * @fileoverview Configures Twig alias resolution for the project.
- * - Builds Twig alias map from files under the source directory
- * - Exposes a Webpack-style `resolve.alias` object for `.twig` files
- */
-
-import {
-  basename,
-  resolve,
-  relative,
-  isAbsolute,
-  join,
-  posix as path,
-} from 'node:path';
-import { sync as globSync } from 'glob';
-import fs from 'fs-extra';
-import emulsifyConfig from '../../../../../project.emulsify.json' with { type: 'json' };
-
-/**
- * Resolve the directory of this file (without fileURLToPath).
- * @type {string}
- */
-let _filename = decodeURIComponent(new URL(import.meta.url).pathname);
-if (process.platform === 'win32' && _filename.startsWith('/')) {
-  _filename = _filename.slice(1);
-}
-const _dirname = path.dirname(_filename);
-
-/** @type {string} Absolute project root (five levels up). */
-const projectDir = resolve(_dirname, '../../../../..');
-
-/** @type {string} Project machine name used to prefix Drupal aliases. */
-const projectName = String(emulsifyConfig?.project?.name || '').trim();
-
-/**
- * Determine the source directory: prefer `<project>/src` if it exists,
- * otherwise use `<project>/components`. If we choose `components` and it
- * does not exist, create it safely inside the project.
- *
- * @returns {string} Absolute path to the source directory.
- */
-function resolveOrCreateSrcDir() {
-  const srcPreferred = resolve(projectDir, 'src');
-  if (fs.pathExistsSync(srcPreferred)) return srcPreferred;
-
-  const componentsFallback = resolve(projectDir, 'components');
-  if (!fs.pathExistsSync(componentsFallback)) {
-    ensureDirSafe(componentsFallback, {
-      base: projectDir,
-      allowedBasenames: new Set(['components']),
-    });
-  }
-  return componentsFallback;
-}
-
-/**
- * Safely create a directory after validating it is a subpath of `base`
- * and its basename is explicitly allowed. This addresses
- * `security/detect-non-literal-fs-filename`.
- *
- * @param {string} dir - Absolute path to create.
- * @param {{ base: string, allowedBasenames: Set<string> }} opts - Safety options.
- * @returns {void}
- * @throws {Error} If the path is outside `base` or not allowed.
- */
-function ensureDirSafe(dir, { base, allowedBasenames }) {
-  const rel = relative(base, dir);
-  const name = basename(dir);
-
-  // Block absolute or escaping paths (outside of base)
-  if (!rel || rel.startsWith('..') || isAbsolute(rel)) {
-    throw new Error(`Refusing to create directory outside project: "${dir}"`);
-  }
-
-  // Only allow known, expected directory names
-  if (!allowedBasenames.has(name)) {
-    throw new Error(`Refusing to create unexpected directory: "${name}"`);
-  }
-
-  // The argument is validated; create the directory.
-  // eslint-disable-next-line security/detect-non-literal-fs-filename
-  fs.mkdirSync(dir, { recursive: true });
-}
-
-/** @type {string} Absolute source directory. */
-const srcDir = resolveOrCreateSrcDir();
-
-/** @type {string} Glob pattern for all non-partial Twig files (skip leading underscores). */
-const aliasPattern = resolve(srcDir, '**/!(_*).twig');
-
-/**
- * Read immediate subdirectories from a source directory.
- *
- * @param {string} source - Absolute directory to scan.
- * @returns {string[]} Array of directory names (basenames only).
- */
-function getDirectories(source) {
-  /* eslint-disable security/detect-non-literal-fs-filename */
-  const entries = fs.readdirSync(source, { withFileTypes: true });
-  /* eslint-enable security/detect-non-literal-fs-filename */
-  return entries.filter((d) => d.isDirectory()).map((d) => d.name);
-}
-
-/**
- * Strip a leading two-digit ordering prefix from a directory name
- * (e.g., "01-components" -> "components").
- *
- * @param {string} dir - Original directory name.
- * @returns {string} Cleaned directory name.
- */
-function cleanDirectoryName(dir) {
-  return /^\d{2}-/.test(dir) ? dir.slice(3) : dir;
-}
-
-/**
- * Build a Twig alias object by:
- *  - Adding per-file aliases for Drupal (e.g., "mytheme/button")
- *  - Adding top-level section aliases (e.g., "@components", "@layout")
- *
- * @param {string} twigGlob - Glob pattern to locate Twig files.
- * @returns {Record<string, string>} Alias map ({ alias: absolutePath }).
- */
-function getAliases(twigGlob) {
-  /** @type {Record<string, string>} */
-  const aliases = {};
-
-  // Per-file aliases for Drupal only: "<projectName>/<filename>"
-  if (emulsifyConfig?.project?.platform === 'drupal' && projectName) {
-    for (const file of globSync(twigGlob)) {
-      const relToSrc = relative(srcDir, file);
-      const fileName = basename(relToSrc).replace(/\.twig$/, '');
-      aliases[`${projectName}/${fileName}`] = file;
-    }
-  }
-
-  // Top-level "@section" aliases for easier imports
-  const topDirs = getDirectories(srcDir);
-  for (const dir of topDirs) {
-    const name = cleanDirectoryName(dir);
-    aliases[`@${name}`] = join(projectDir, basename(srcDir), dir);
-  }
-
-  return aliases;
-}
-
-/**
- * Webpack-style `resolve` config for Twig files.
- * @typedef {{ extensions: string[], alias: Record<string, string> }} TwigResolveConfig
- */
-
-/** @type {TwigResolveConfig} */
-const TwigResolve = {
-  extensions: ['.twig'],
-  alias: getAliases(aliasPattern),
-};
-
-export default { TwigResolve };

package/config/webpack/sdc-loader.js

@@ -1,16 +0,0 @@
-/**
- * A loader function that replaces occurrences of "projectName:" with "projectName/".
- *
- * @param {string} source - The source string to process.
- * @returns {string} The transformed source.
- */
-export default function (source) {
-  const projectName = this.getOptions().projectName || '';
-  /* eslint-disable security/detect-non-literal-regexp */
-  const result = source.replace(
-    new RegExp(`${projectName}:`, 'g'),
-    `${projectName}/`,
-  );
-  /* eslint-enable security/detect-non-literal-regexp */
-  return result;
-}