@hominis/fireforge 0.54.0 → 0.60.0

package/dist/src/commands/furnace/rename-helpers.js

@@ -1,85 +0,0 @@
-// SPDX-License-Identifier: EUPL-1.2
-import { updateFurnaceState } from '../../core/furnace-config.js';
-import { escapeRegex } from '../../utils/regex.js';
-/**
- * Applies a component rename to scaffold-owned filenames only.
- */
-export function renameComponentFileName(fileName, oldName, newName) {
-    if (fileName === oldName)
-        return newName;
-    if (fileName.startsWith(oldName + '.')) {
-        return newName + fileName.slice(oldName.length);
-    }
-    return fileName;
-}
-/**
- * Rewrites whole-tag mentions of the old name in a component description,
- * so a rename does not carry a description that still names the old tag.
- * Boundary-aware like the source rewrite: `moz-panel` inside
- * `moz-panel-group` is left alone.
- */
-export function renameTagInDescription(description, oldName, newName) {
-    return description.replace(new RegExp(`(?<![\\w-])${escapeRegex(oldName)}(?![\\w-])`, 'g'), newName);
-}
-/**
- * Re-keys a custom component config entry and same-config compose references.
- */
-export function updateConfigForCustomRename(config, oldName, newName) {
-    const oldConfig = config.custom[oldName];
-    if (!oldConfig)
-        return;
-    config.custom[newName] = {
-        ...oldConfig,
-        description: renameTagInDescription(oldConfig.description, oldName, newName),
-        targetPath: oldConfig.targetPath.replace(new RegExp(`(^|/)${oldName}$`), `$1${newName}`),
-    };
-    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete -- idiomatic key removal from config record
-    delete config.custom[oldName];
-    for (const customConfig of Object.values(config.custom)) {
-        if (customConfig.composes) {
-            customConfig.composes = customConfig.composes.map((ref) => (ref === oldName ? newName : ref));
-        }
-    }
-}
-/**
- * Re-keys an override component config entry.
- */
-export function updateConfigForOverrideRename(config, oldName, newName) {
-    const oldConfig = config.overrides[oldName];
-    if (!oldConfig)
-        return;
-    config.overrides[newName] = {
-        ...oldConfig,
-        description: renameTagInDescription(oldConfig.description, oldName, newName),
-    };
-    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete -- idiomatic key removal from config record
-    delete config.overrides[oldName];
-}
-/**
- * Re-keys checksum entries in furnace-state.json from the old component name
- * to the new name so that `doctor` doesn't flag stale entries and the next
- * `apply` can correctly detect whether the renamed component has changed.
- */
-export async function rekeyStateChecksums(projectRoot, componentType, oldName, newName) {
-    const oldPrefix = `${componentType}/${oldName}/`;
-    const newPrefix = `${componentType}/${newName}/`;
-    await updateFurnaceState(projectRoot, (state) => {
-        const result = { ...state };
-        for (const field of ['appliedChecksums', 'engineChecksums']) {
-            const checksums = state[field];
-            if (!checksums)
-                continue;
-            const updated = {};
-            for (const [key, value] of Object.entries(checksums)) {
-                if (key.startsWith(oldPrefix)) {
-                    updated[newPrefix + key.slice(oldPrefix.length)] = value;
-                }
-                else {
-                    updated[key] = value;
-                }
-            }
-            result[field] = updated;
-        }
-        return result;
-    });
-}

package/dist/src/commands/furnace/rename-registrations.d.ts

@@ -1,41 +0,0 @@
-/**
- * Engine registration edits for `furnace rename`: the customElements.js
- * entry (rewritten in place, keeping its marker comments), the
- * toolkit/content/jar.mn widget lines, the deployed `.ftl`, and the locale
- * jar.mn line (re-pointed only when one existed, never for `sharedFtl`).
- */
-import { type RollbackJournal } from '../../core/furnace-rollback.js';
-import type { CustomComponentConfig } from '../../types/furnace.js';
-/**
- * The project marker (`// <MARKER>:`) a registration line written by the
- * rename carries, resolved exactly as `furnace apply` resolves it. An
- * unreadable fireforge.json degrades to no marker rather than failing the
- * rename.
- */
-export declare function loadMarkerComment(projectRoot: string): Promise<string | undefined>;
-/** Inputs for {@link updateEngineRegistrations}. */
-export interface UpdateEngineRegistrationsOptions {
-    /** Absolute path to the engine checkout. */
-    engineDir: string;
-    /** Tag name being renamed away from. */
-    oldName: string;
-    /** Tag name being renamed to. */
-    newName: string;
-    /** Workspace directory holding the renamed component's files. */
-    newDir: string;
-    /** Engine-relative directory localized components deploy their `.ftl` into. */
-    ftlDir: string;
-    /** The renamed component's furnace.json entry (`localized`, `sharedFtl`). */
-    componentConfig: CustomComponentConfig;
-    /** Project marker for a registration line the rename has to add fresh. */
-    markerComment: string | undefined;
-    /** Rollback journal every write is recorded in. */
-    journal: RollbackJournal;
-}
-/**
- * Re-points the engine-side registrations (customElements.js, jar.mn, and
- * the localized `.ftl` entries) from the old tag name to the new one.
- *
- * @param options - See {@link UpdateEngineRegistrationsOptions}
- */
-export declare function updateEngineRegistrations(options: UpdateEngineRegistrationsOptions): Promise<void>;

package/dist/src/commands/furnace/rename-registrations.js

@@ -1,98 +0,0 @@
-// SPDX-License-Identifier: EUPL-1.2
-/**
- * Engine registration edits for `furnace rename`: the customElements.js
- * entry (rewritten in place, keeping its marker comments), the
- * toolkit/content/jar.mn widget lines, the deployed `.ftl`, and the locale
- * jar.mn line (re-pointed only when one existed, never for `sharedFtl`).
- */
-import { readdir } from 'node:fs/promises';
-import { join } from 'node:path';
-import { loadConfig } from '../../core/config.js';
-import { resolveFtlChromeSubPath, resolveFtlLocaleJarMnPath, } from '../../core/furnace-constants.js';
-import { resolveFurnaceMarkerComment } from '../../core/furnace-marker.js';
-import { addCustomElementRegistration, addJarMnEntries, addLocaleFtlJarMnEntry, removeCustomElementRegistration, removeLocaleFtlJarMnEntry, renameCustomElementRegistration, } from '../../core/furnace-registration.js';
-import { renameJarMnEntriesInPlace } from '../../core/furnace-registration-jar-inplace.js';
-import { snapshotFile } from '../../core/furnace-rollback.js';
-import { pathExists, readText, removeFile, writeText } from '../../utils/fs.js';
-import { renameComponentFileName } from './rename-helpers.js';
-/**
- * The project marker (`// <MARKER>:`) a registration line written by the
- * rename carries, resolved exactly as `furnace apply` resolves it. An
- * unreadable fireforge.json degrades to no marker rather than failing the
- * rename.
- */
-export async function loadMarkerComment(projectRoot) {
-    try {
-        return resolveFurnaceMarkerComment(await loadConfig(projectRoot));
-    }
-    catch {
-        return undefined;
-    }
-}
-/**
- * Re-points the engine-side registrations (customElements.js, jar.mn, and
- * the localized `.ftl` entries) from the old tag name to the new one.
- *
- * @param options - See {@link UpdateEngineRegistrationsOptions}
- */
-export async function updateEngineRegistrations(options) {
-    const { engineDir, oldName, newName, newDir, ftlDir, componentConfig, markerComment, journal } = options;
-    const customElementsPath = join(engineDir, 'toolkit/content/customElements.js');
-    const jarMnPath = join(engineDir, 'toolkit/content/jar.mn');
-    if (await pathExists(customElementsPath)) {
-        await snapshotFile(journal, customElementsPath);
-        // Rewrite the existing entry in place: it keeps its position, layout and
-        // trailing `// <MARKER>:` comments. Only when there is no entry to
-        // rewrite is a fresh one added, carrying the project marker like every
-        // line `furnace apply` writes.
-        if (!(await renameCustomElementRegistration(engineDir, oldName, newName))) {
-            await removeCustomElementRegistration(engineDir, oldName);
-            await addCustomElementRegistration(engineDir, newName, `chrome://global/content/elements/${newName}.mjs`, markerComment !== undefined ? { markerComment } : {});
-        }
-    }
-    if (await pathExists(jarMnPath)) {
-        await snapshotFile(journal, jarMnPath);
-        const files = (await readdir(newDir, { withFileTypes: true }))
-            .filter((e) => e.isFile() && (e.name.endsWith('.mjs') || e.name.endsWith('.css')))
-            .map((e) => e.name);
-        // Rewrite the old lines where they stand, like the customElements.js
-        // entry above, so the rename moves no other line of the block; only a
-        // file with no line yet is inserted.
-        await renameJarMnEntriesInPlace(engineDir, oldName, newName, files, (file) => renameComponentFileName(file, oldName, newName));
-        if (files.length > 0) {
-            await addJarMnEntries(engineDir, newName, files);
-        }
-    }
-    // Rename FTL localization files in the engine locale directory
-    const ftlDirPath = join(engineDir, ftlDir);
-    const oldFtlPath = join(ftlDirPath, `${oldName}.ftl`);
-    const newFtlPath = join(ftlDirPath, `${newName}.ftl`);
-    if (await pathExists(oldFtlPath)) {
-        await snapshotFile(journal, oldFtlPath);
-        await snapshotFile(journal, newFtlPath);
-        const ftlContent = await readText(oldFtlPath);
-        await writeText(newFtlPath, ftlContent);
-        await removeFile(oldFtlPath);
-    }
-    // Re-point the locale jar.mn chrome registration when the component is
-    // localized. Renaming the .ftl file on disk alone leaves the locale
-    // jar.mn pointing at `locale/.../${oldName}.ftl`, so `furnace validate`
-    // passes while the engine still carries a stale registration for the
-    // now-missing file. Only an existing line is re-pointed: a `sharedFtl`
-    // component has no per-component .ftl, and adding a line for one names a
-    // file that does not exist (an unmanaged edit `mach build` trips over).
-    if (componentConfig.localized) {
-        const chromeSubPath = resolveFtlChromeSubPath(ftlDir);
-        const localeJarRel = resolveFtlLocaleJarMnPath(ftlDir);
-        if (chromeSubPath !== undefined && localeJarRel !== undefined) {
-            const localeJarAbs = join(engineDir, localeJarRel);
-            if (await pathExists(localeJarAbs)) {
-                await snapshotFile(journal, localeJarAbs);
-                const removed = await removeLocaleFtlJarMnEntry(engineDir, localeJarRel, oldName, chromeSubPath);
-                if (removed && componentConfig.sharedFtl === undefined) {
-                    await addLocaleFtlJarMnEntry(engineDir, localeJarRel, newName, chromeSubPath);
-                }
-            }
-        }
-    }
-}

package/dist/src/commands/furnace/rename-xpcshell.d.ts

@@ -1,32 +0,0 @@
-/**
- * xpcshell scaffold rename helper extracted from `rename.ts`.
- *
- * `furnace create --with-tests --xpcshell` writes a scaffold at
- * `browser/base/content/test/<binary>-xpcshell/<name>/`, which a rename must
- * follow. This helper renames the directory, updates the test filename,
- * rewrites the `xpcshell.toml` section header, and re-writes the test body
- * so word-boundary occurrences of the old tag / underscored name map to the
- * new ones.
- *
- * Extracted to keep `rename.ts` under the per-file LOC budget. It already
- * carries mochikit + browser-mochitest + FTL handling.
- */
-import { type RollbackJournal } from '../../core/furnace-rollback.js';
-/**
- * Renames an xpcshell test scaffold in place. Moves the directory,
- * rewrites the test filename, updates the `[test_name]` section header
- * in `xpcshell.toml`, and word-boundary-rewrites occurrences of the
- * old tag / old underscored name inside the test body.
- *
- * Best-effort: any failure logs a warning through the shared logger
- * but never throws. The component rename itself has already succeeded
- * at this point, and blocking on a test rewrite would leave the
- * operator with a half-renamed component.
- *
- * @param engineDir - Absolute path to the engine directory under the project.
- * @param projectRoot - Absolute path to the project root, used to load the binary name.
- * @param oldName - Pre-rename component tag name.
- * @param newName - Post-rename component tag name.
- * @param journal - Rollback journal that the rename mutation writes to before touching files.
- */
-export declare function renameXpcshellTestFiles(engineDir: string, projectRoot: string, oldName: string, newName: string, journal: RollbackJournal): Promise<void>;

package/dist/src/commands/furnace/rename-xpcshell.js

@@ -1,95 +0,0 @@
-// SPDX-License-Identifier: EUPL-1.2
-/**
- * xpcshell scaffold rename helper extracted from `rename.ts`.
- *
- * `furnace create --with-tests --xpcshell` writes a scaffold at
- * `browser/base/content/test/<binary>-xpcshell/<name>/`, which a rename must
- * follow. This helper renames the directory, updates the test filename,
- * rewrites the `xpcshell.toml` section header, and re-writes the test body
- * so word-boundary occurrences of the old tag / underscored name map to the
- * new ones.
- *
- * Extracted to keep `rename.ts` under the per-file LOC budget. It already
- * carries mochikit + browser-mochitest + FTL handling.
- */
-import { readdir } from 'node:fs/promises';
-import { join } from 'node:path';
-import { loadConfig } from '../../core/config.js';
-import { xpcshellTestParentDir } from '../../core/furnace-constants.js';
-import { recordCreatedDir, snapshotFile, } from '../../core/furnace-rollback.js';
-import { toError } from '../../utils/errors.js';
-import { ensureDir, pathExists, readText, removeDir, removeFile, writeText, } from '../../utils/fs.js';
-import { info, warn } from '../../utils/logger.js';
-import { escapeRegex } from '../../utils/regex.js';
-/**
- * Renames an xpcshell test scaffold in place. Moves the directory,
- * rewrites the test filename, updates the `[test_name]` section header
- * in `xpcshell.toml`, and word-boundary-rewrites occurrences of the
- * old tag / old underscored name inside the test body.
- *
- * Best-effort: any failure logs a warning through the shared logger
- * but never throws. The component rename itself has already succeeded
- * at this point, and blocking on a test rewrite would leave the
- * operator with a half-renamed component.
- *
- * @param engineDir - Absolute path to the engine directory under the project.
- * @param projectRoot - Absolute path to the project root, used to load the binary name.
- * @param oldName - Pre-rename component tag name.
- * @param newName - Post-rename component tag name.
- * @param journal - Rollback journal that the rename mutation writes to before touching files.
- */
-export async function renameXpcshellTestFiles(engineDir, projectRoot, oldName, newName, journal) {
-    let forgeConfig;
-    try {
-        forgeConfig = await loadConfig(projectRoot);
-    }
-    catch {
-        return; // Cannot determine scaffold path without config.
-    }
-    const parentDir = join(engineDir, xpcshellTestParentDir(forgeConfig.binaryName));
-    if (!(await pathExists(parentDir)))
-        return;
-    const oldScaffoldDir = join(parentDir, oldName);
-    const newScaffoldDir = join(parentDir, newName);
-    if (!(await pathExists(oldScaffoldDir)))
-        return;
-    const oldUnderscored = oldName.replace(/-/g, '_');
-    const newUnderscored = newName.replace(/-/g, '_');
-    const oldTestFileName = `test_${oldUnderscored}_packaged.js`;
-    const newTestFileName = `test_${newUnderscored}_packaged.js`;
-    try {
-        // Journal the new scaffold dir + files so rollback (including the
-        // SIGINT path) removes them. Only the old-name files were journaled
-        // before, so a failed rename stranded the new-name scaffold.
-        recordCreatedDir(journal, newScaffoldDir);
-        await ensureDir(newScaffoldDir);
-        const entries = await readdir(oldScaffoldDir, { withFileTypes: true });
-        for (const entry of entries) {
-            if (!entry.isFile())
-                continue;
-            const oldFilePath = join(oldScaffoldDir, entry.name);
-            const renamedFileName = entry.name === oldTestFileName ? newTestFileName : entry.name;
-            const newFilePath = join(newScaffoldDir, renamedFileName);
-            await snapshotFile(journal, oldFilePath);
-            await snapshotFile(journal, newFilePath);
-            const body = await readText(oldFilePath);
-            let updated = body;
-            if (entry.name === 'xpcshell.toml') {
-                updated = updated.replace(new RegExp(`\\[${escapeRegex(`"${oldTestFileName}"`)}\\]`, 'g'), `["${newTestFileName}"]`);
-            }
-            else if (entry.name === oldTestFileName) {
-                const oldTagPattern = new RegExp(`(?<![\\w-])${escapeRegex(oldName)}(?![\\w-])`, 'g');
-                updated = updated.replace(oldTagPattern, newName);
-                const oldUnderscoredPattern = new RegExp(`(?<![\\w])${escapeRegex(oldUnderscored)}(?![\\w])`, 'g');
-                updated = updated.replace(oldUnderscoredPattern, newUnderscored);
-            }
-            await writeText(newFilePath, updated);
-            await removeFile(oldFilePath);
-        }
-        await removeDir(oldScaffoldDir);
-        info(`Renamed xpcshell scaffold directory: ${xpcshellTestParentDir(forgeConfig.binaryName)}/${oldName} → ${xpcshellTestParentDir(forgeConfig.binaryName)}/${newName}`);
-    }
-    catch (error) {
-        warn(`Could not rename xpcshell scaffold — ${toError(error).message}. Rename the scaffold files manually if needed.`);
-    }
-}

package/dist/src/commands/furnace/rename.d.ts

@@ -1,6 +0,0 @@
-import type { FurnaceRenameOptions } from '../../types/commands/index.js';
-/**
- * Renames a custom or override component atomically: updates directory name,
- * file names, file contents, furnace.json, and engine registrations.
- */
-export declare function furnaceRenameCommand(projectRoot: string, oldName: string, newName: string, options?: FurnaceRenameOptions): Promise<void>;