@emulsify/core 3.5.0 → 4.0.1

package/config/webpack/webpack.common.js

@@ -1,272 +0,0 @@
-/**
- * @fileoverview Build Webpack entries and export the configuration.
- * - Discovers JS/SCSS assets (base + component) via glob patterns
- * - Shapes output paths based on platform and SDC (singleDirectoryComponents)
- * - Wires up loaders, plugins, and optimizations
- */
-
-import { posix as path } from 'node:path';
-import { sync as globSync } from 'glob';
-import fs from 'fs-extra';
-
-import loaders from './loaders.js';
-import plugins from './plugins.js';
-import resolves from './resolves.js';
-import optimizers from './optimizers.js';
-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 from this file). */
-const projectDir = path.resolve(_dirname, '../../../../..');
-
-/** @type {boolean} True when a "src/" directory exists (WP layout). */
-const hasSrc = fs.pathExistsSync(path.resolve(projectDir, 'src'));
-
-/** @type {string} The canonical source directory ("src" if present, else "components"). */
-const srcDir = hasSrc
-  ? path.resolve(projectDir, 'src')
-  : path.resolve(projectDir, 'components');
-
-/** @type {boolean} True when platform is Drupal (affects component output root). */
-const isDrupal = emulsifyConfig?.project?.platform === 'drupal';
-
-/** @type {boolean} Respect SDC (single-directory-components) layout if explicitly true. */
-const SDC = Boolean(emulsifyConfig?.project?.singleDirectoryComponents);
-
-/** @type {string} Output base for "global" assets. */
-const globalOutBase = hasSrc ? 'dist/global' : 'dist';
-
-/**
- * Create a path under the component output root.
- * - In Drupal + src layout, components resolve to "components/…"
- * - Otherwise, they resolve to "dist/components/…"
- * @param {string} subpath - Component-local subpath (no extension).
- * @returns {string} Component output path segment.
- */
-const componentOutPath = (subpath) =>
-  (isDrupal && hasSrc ? 'components' : 'dist/components') + '/' + subpath;
-
-/**
- * Join segments with POSIX semantics (forward slashes), trimming empties.
- * @param {...string} segs - Path segments.
- * @returns {string} POSIX-joined path.
- */
-const pj = (...segs) => path.join(...segs.filter(Boolean));
-
-/**
- * Compute the “dist subpath” for a non-component asset.
- * Inserts a type folder ("js" or "css") when SDC = false.
- * Drops the original file extension.
- * @param {string} absFile - Absolute file path.
- * @param {'js'|'css'} type - Asset type.
- * @returns {string} Subpath under the global output base (no extension).
- */
-const distSubpathForBase = (absFile, type) => {
-  const rel = path.relative(srcDir, absFile);
-  const dir = path.dirname(rel);
-  const ext = path.extname(rel);
-  const name = path.basename(rel, ext);
-  const outTypeDir = type === 'css' ? 'css' : 'js';
-  return SDC ? pj(dir, name) : pj(dir, outTypeDir, name);
-};
-
-/**
- * Compute the “dist subpath” for a component asset located under "…/components".
- * Inserts a type folder ("js" or "css") when SDC = false.
- * Drops the original file extension.
- * @param {string} absFile - Absolute file path.
- * @param {'js'|'scss'} type - Source type (scss maps to 'css').
- * @returns {string} Component-local subpath (no extension).
- */
-const distSubpathForComponent = (absFile, type) => {
-  const relFromComponents = path.relative(pj(srcDir, 'components'), absFile);
-  const dir = path.dirname(relFromComponents);
-  const isStyle = type === 'scss';
-  const outTypeDir = isStyle ? 'css' : 'js';
-  const ext = isStyle ? '.scss' : '.js';
-  const name = path.basename(relFromComponents, ext);
-  return SDC ? pj(dir, name) : pj(dir, outTypeDir, name);
-};
-
-/**
- * Sanitize a file path by removing unwanted characters.
- *
- * @param {string} inputPath - The file path to sanitize.
- * @returns {string} The sanitized file path.
- */
-const sanitizePath = (inputPath) => inputPath.replace(/[^a-zA-Z0-9/_-]/g, '');
-
-/**
- * Reject keys that could touch object internals even after sanitization.
- * @param {string} k
- * @returns {boolean}
- */
-const isDangerousKey = (k) =>
-  k.includes('__proto__') || k.includes('prototype') || k === 'constructor';
-
-/**
- * Add a file under an entry key; if the key exists, merge to an array.
- * Keeps JS before SCSS for deterministic order.
- *
- * @param {Map<string, string | string[]>} map
- * @param {string} key
- * @param {string} file
- * @returns {void}
- */
-const addEntry = (map, key, file) => {
-  const safeKey = sanitizePath(String(key));
-  if (!safeKey || isDangerousKey(safeKey)) return;
-
-  const current = map.get(safeKey);
-
-  if (!current) {
-    map.set(safeKey, file);
-    return;
-  }
-
-  const arr = Array.isArray(current) ? current : [current];
-  if (!arr.includes(file)) arr.push(file);
-
-  // Optional: ensure JS comes before SCSS
-  arr.sort((a, b) => {
-    const ax = a.endsWith('.js') ? 0 : 1;
-    const bx = b.endsWith('.js') ? 0 : 1;
-    return ax - bx || a.localeCompare(b);
-  });
-
-  map.set(safeKey, arr);
-};
-
-/**
- * Safe glob wrapper: returns [] if the pattern is falsy.
- * @param {string} pattern - Glob pattern.
- * @returns {string[]} Matching file paths.
- */
-const glob = (pattern) => (pattern ? globSync(pattern) : []);
-
-/* -------------------------------------------------------------------------- */
-/*                                   GLOBS                                    */
-/* -------------------------------------------------------------------------- */
-
-const BaseScssPattern = hasSrc
-  ? pj(srcDir, '!(components|util)/**/!(_*|cl-*|sb-*).scss')
-  : '';
-
-const ComponentScssPattern = hasSrc
-  ? pj(srcDir, 'components/**/!(_*|cl-*|sb-*).scss')
-  : pj(srcDir, '**/!(_*|cl-*|sb-*).scss');
-
-const ComponentLibraryScssPattern = pj(srcDir, '**/*{cl-*,sb-*}.scss');
-
-const BaseJsPattern = hasSrc
-  ? pj(srcDir, '!(components|util)/**/!(*.stories|*.component|*.min|*.test).js')
-  : '';
-
-const ComponentJsPattern = hasSrc
-  ? pj(srcDir, 'components/**/!(*.stories|*.component|*.min|*.test).js')
-  : pj(srcDir, '**/!(*.stories|*.component|*.min|*.test).js');
-
-/* -------------------------------------------------------------------------- */
-/*                                 ENTRY BUILD                                */
-/* -------------------------------------------------------------------------- */
-
-/**
- * Build the complete Webpack entries map.
- * @returns {Record<string,string>} Webpack entries.
- */
-const buildEntries = () => {
-  /** @type {Map<string, string | string[]>} */
-  const entries = new Map();
-
-  /* ----------------------------- Base / Global JS ----------------------------- */
-  for (const file of glob(BaseJsPattern)) {
-    const sub = distSubpathForBase(file, 'js');
-    // If no "src/", legacy layout puts global JS directly under "dist/js".
-    const outRoot = hasSrc ? pj(globalOutBase) : pj('dist', 'js');
-    addEntry(entries, pj(outRoot, sub), file);
-  }
-
-  /* --------------------------- Component JS (no dist) -------------------------- */
-  for (const file of glob(ComponentJsPattern)) {
-    if (file.includes('/dist/')) continue; // guard against accidental recursion
-    const sub = distSubpathForComponent(file, 'js');
-    addEntry(entries, componentOutPath(sub), file);
-  }
-
-  /* ------------------------------ Base / Global CSS --------------------------- */
-  for (const file of glob(BaseScssPattern)) {
-    const sub = distSubpathForBase(file, 'css');
-    // If no "src/", legacy layout puts global CSS directly under "dist/css".
-    const outRoot = hasSrc ? pj(globalOutBase) : pj('dist', 'css');
-    addEntry(entries, pj(outRoot, sub), file);
-  }
-
-  /* ---------------------------- Component CSS (SCSS) --------------------------- */
-  for (const file of glob(ComponentScssPattern)) {
-    const sub = distSubpathForComponent(file, 'scss'); // maps to css
-    addEntry(entries, componentOutPath(sub), file);
-  }
-
-  /* -------------------------- Component Library (Storybook) -------------------- */
-  for (const file of glob(ComponentLibraryScssPattern)) {
-    const rel = path.relative(srcDir, file).replace(/\.scss$/, '');
-    addEntry(entries, pj('dist', 'storybook', rel), file);
-  }
-
-  return Object.fromEntries(entries);
-};
-
-/* -------------------------------------------------------------------------- */
-/*                              WEBPACK CONFIG EXPORT                          */
-/* -------------------------------------------------------------------------- */
-
-export default {
-  target: 'web',
-  stats: { errorDetails: true },
-  externals: {
-    drupal: 'Drupal',
-    drupalSettings: 'drupalSettings',
-  },
-  entry: buildEntries(),
-  module: {
-    rules: [
-      loaders.CSSLoader,
-      loaders.SVGSpriteLoader,
-      loaders.ImageLoader,
-      loaders.JSLoader,
-      loaders.TwigLoader,
-    ],
-  },
-  plugins: [
-    plugins.RemoveEmptyJS,
-    plugins.MiniCssExtractPlugin,
-    plugins.ImageminPlugin,
-    plugins.SpritePlugin,
-    plugins.ProgressPlugin,
-    plugins.CopyTwigPlugin,
-    plugins.CopyComponentAssetsPlugin,
-    ...(plugins.CopyGlobalAssetsPlugin ? [plugins.CopyGlobalAssetsPlugin] : []),
-    plugins.CleanWebpackPlugin,
-  ],
-  output: {
-    path: projectDir,
-    filename: '[name].js',
-  },
-  resolve: resolves.TwigResolve,
-  optimization: optimizers,
-  // Quiet deprecation noise from Sass @import warnings
-  ignoreWarnings: [
-    (warning) =>
-      Boolean(warning?.message) &&
-      /Sass @import rules are deprecated/.test(warning.message),
-  ],
-};

package/config/webpack/webpack.dev.js

@@ -1,41 +0,0 @@
-import fs from 'fs-extra';
-import { resolve, dirname } from 'path';
-import { merge } from 'webpack-merge';
-import common from './webpack.common.js';
-
-// JSON import syntax may vary; adjust if you need `assert { type: 'json' }` instead
-import emulsifyConfig from '../../../../../project.emulsify.json' with { type: 'json' };
-
-// Create __filename from import.meta.url without fileURLToPath
-let _filename = decodeURIComponent(new URL(import.meta.url).pathname);
-
-// On Windows, remove the leading slash (e.g. "/C:/path" -> "C:/path")
-if (process.platform === 'win32' && _filename.startsWith('/')) {
-  _filename = _filename.slice(1);
-}
-
-const _dirname = dirname(_filename);
-
-// Get directories for file contexts.
-const projectDir = resolve(_dirname, '../../../../..');
-
-const srcPath = resolve(projectDir, 'src');
-const srcExists = fs.pathExistsSync(srcPath);
-const isDrupal = emulsifyConfig.project.platform === 'drupal';
-
-// Always ignore dist
-const ignored = ['**/dist/**'];
-
-// If it’s Drupal and there is no src/, also ignore components
-if (isDrupal && !srcExists) {
-  ignored.push('**/components/**');
-}
-
-export default merge(common, {
-  mode: 'development',
-  devtool: 'source-map',
-  watch: true,
-  watchOptions: {
-    ignored,
-  },
-});

package/config/webpack/webpack.prod.js

@@ -1,6 +0,0 @@
-import { merge } from 'webpack-merge';
-import common from './webpack.common.js';
-
-export default merge(common, {
-  mode: 'production',
-});

package/release.config.cjs

@@ -1,30 +0,0 @@
-// release.config.cjs
-module.exports = {
-  branches: ['main'],
-  repositoryUrl: 'git@github.com:emulsify-ds/emulsify-core.git',
-  plugins: [
-    [
-      '@semantic-release/commit-analyzer',
-      {
-        preset: 'angular',
-        parserOpts: {
-          noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING']
-        }
-      }
-    ],
-    [
-      '@semantic-release/release-notes-generator',
-      {
-        preset: 'angular',
-        parserOpts: {
-          noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING']
-        },
-        writerOpts: {
-          commitsSort: ['subject', 'scope']
-        }
-      }
-    ],
-    ['@semantic-release/npm', { npmPublish: true }],
-    '@semantic-release/github'
-  ]
-}

package/scripts/a11y.test.js

@@ -1,172 +0,0 @@
-import 'regenerator-runtime/runtime';
-
-const mockExit = jest
-  .spyOn(global.process, 'exit')
-  .mockImplementation(() => {});
-jest.mock('pa11y', () => jest.fn());
-jest.spyOn(global.console, 'log').mockImplementation(() => {});
-const pa11y = require('pa11y');
-const path = require('path');
-const {
-  severityToColor,
-  issueIsValid,
-  logIssue,
-  logReport,
-  lintComponent,
-  lintReportAndExit,
-} = require('./a11y');
-const {
-  ignore,
-  storybookBuildDir,
-  pa11y: pa11yConfig,
-} = require('../config/a11y.config');
-
-const STORYBOOK_BUILD_DIR = path.resolve(__dirname, '../', storybookBuildDir);
-const STORYBOOK_IFRAME = path.join(STORYBOOK_BUILD_DIR, 'iframe.html');
-
-pa11y.mockResolvedValue('very official report');
-
-describe('a11y', () => {
-  beforeEach(() => {
-    global.console.log.mockClear();
-    global.process.exit.mockClear();
-  });
-
-  it('maps axe issue severity to a label', () => {
-    // (Name no longer mentions "chalk")
-    expect.assertions(3);
-    expect(severityToColor('error')).toBe('red');
-    expect(severityToColor('warning')).toBe('yellow');
-    expect(severityToColor('notice')).toBe('blue');
-  });
-
-  it('identifies invalid issues based on the code or the description', () => {
-    expect.assertions(3);
-    expect(
-      issueIsValid({
-        code: ignore.codes[0],
-        runnerExtras: {},
-      }),
-    ).toBe(false);
-    expect(
-      issueIsValid({
-        runnerExtras: {
-          description: ignore.descriptions[0],
-        },
-      }),
-    ).toBe(false);
-    expect(issueIsValid({ code: 'chicken', runnerExtras: {} })).toBe(true);
-  });
-
-  it('logs a single issue without color codes', () => {
-    expect.assertions(1);
-    logIssue({
-      type: 'error',
-      message: 'this chicken is not fried enough.',
-      context: 'https://example.com',
-      selector: 'kfc > popeyes > .chicken',
-    });
-    expect(global.console.log.mock.calls[0][0]).toMatchInlineSnapshot(`
-"
-severity: error
-message: this chicken is not fried enough.
-context: https://example.com
-selector: kfc > popeyes > .chicken
-"
-`);
-  });
-
-  it('logs a whole report without color codes', () => {
-    const report = {
-      issues: [
-        {
-          type: 'error',
-          message: 'this pizza is too soggy',
-          context: 'https://example.com',
-          selector: 'pizza > .hut',
-          runnerExtras: {},
-        },
-        {
-          type: 'error',
-          message: 'this pasta is undercooked',
-          context: 'https://example.com',
-          selector: 'olive > .garden',
-          runnerExtras: {},
-        },
-      ],
-      pageUrl: 'https://example/component.html',
-    };
-    expect(logReport(report)).toBe(true);
-    expect(global.console.log.mock.calls).toMatchInlineSnapshot(`
-Array [
-  Array [
-    "Issues found in component: https://example/component.html",
-  ],
-  Array [
-    "
-severity: error
-message: this pizza is too soggy
-context: https://example.com
-selector: pizza > .hut
-",
-  ],
-  Array [
-    "
-severity: error
-message: this pasta is undercooked
-context: https://example.com
-selector: olive > .garden
-",
-  ],
-]
-`);
-  });
-
-  it('logs that a component has no issues when a report is empty', () => {
-    expect(logReport({ issues: [], pageUrl: 'papa-johns' })).toBe(false);
-    expect(global.console.log.mock.calls[0][0]).toMatchInlineSnapshot(
-      `"No issues found in component: papa-johns"`,
-    );
-  });
-
-  it('calls pa11y with the full path to a component', async () => {
-    expect.assertions(3);
-    await expect(lintComponent('chicken-strips')).resolves.toBe(
-      'very official report',
-    );
-
-    // First arg: URL
-    expect(pa11y.mock.calls[0][0]).toBe(
-      `${STORYBOOK_IFRAME}?id=chicken-strips`,
-    );
-
-    // Second arg: options merged with defaults in a11y.js
-    expect(pa11y.mock.calls[0][1]).toEqual(
-      expect.objectContaining({
-        includeNotices: true,
-        includeWarnings: true,
-        runners: ['axe'],
-        ...pa11yConfig,
-      }),
-    );
-  });
-
-  it('runs linter, reports on issues, and exits with code "1" if valid issues are found', async () => {
-    expect.assertions(1);
-    pa11y.mockResolvedValueOnce({
-      issues: [
-        {
-          type: 'error',
-          message: 'these 7 layer supreme burritos do not taste that good',
-          context: 'https://example.com',
-          selector: 'taco > bell > .burrito',
-          runnerExtras: {},
-        },
-      ],
-      pageUrl: '/path/to/taco-bell',
-    });
-
-    await lintReportAndExit(['taco-bell']);
-    expect(global.process.exit).toHaveBeenCalledWith(1);
-  });
-});

package/scripts/loadYaml.test.js

@@ -1,30 +0,0 @@
-import fs from 'fs';
-import yaml from 'yaml';
-import loadYaml from './loadYaml';
-
-jest
-  .spyOn(fs, 'readFileSync')
-  .mockImplementation(() => 'yaml spaghetti and meatballs');
-
-jest.spyOn(yaml, 'parse').mockImplementation(() => ({
-  the: 'yaml spaghetti and meatballs',
-}));
-
-describe('loadYaml', () => {
-  beforeEach(() => {
-    fs.readFileSync.mockClear();
-    yaml.parse.mockClear();
-  });
-
-  it('can load a yaml file, parse it, and return it', () => {
-    expect.assertions(3);
-    expect(loadYaml('./big-phat-burger.yml')).toEqual({
-      the: 'yaml spaghetti and meatballs',
-    });
-    expect(fs.readFileSync).toHaveBeenCalledWith(
-      `${__dirname}/big-phat-burger.yml`,
-      'utf8',
-    );
-    expect(yaml.parse).toHaveBeenCalledWith('yaml spaghetti and meatballs');
-  });
-});