@flarum/cli 2.0.0-beta.13 → 2.0.0-beta.16

package/lib/boilersmith/io.js

@@ -15,7 +15,7 @@ class PromptsIO {
         this.noInteraction = noInteraction;
         this.onCancel = onCancel;
     }
-    async getParam(paramDef) {
+    async getParam(paramDef, noCache = false) {
         var _a, _b, _c;
         const paramName = paramDef.name;
         if (this.cache.has(paramName)) {
@@ -42,7 +42,9 @@ class PromptsIO {
             }));
             resValue = res[paramName];
         }
-        this.cache.set(paramName, resValue);
+        if (!noCache) {
+            this.cache.set(paramName, resValue);
+        }
         this.prev = {
             val: resValue,
             prompt: paramDef,

package/lib/boilersmith/paths.d.ts

@@ -3,7 +3,7 @@ export interface Paths {
     package(...path: string[]): string;
     requestedDir(...path: string[]): string | null;
     monorepo(...path: string[]): string | null;
-    onMonorepoSub(packagePath: string): Paths;
+    onMonorepoSub(packagePath: string, monorepoPath?: string): Paths;
 }
 declare type InternalPaths = {
     package: string;
@@ -17,6 +17,6 @@ export declare class NodePaths implements Paths {
     package(...path: string[]): string;
     requestedDir(...path: string[]): string | null;
     monorepo(...path: string[]): string | null;
-    onMonorepoSub(packagePath: string): NodePaths;
+    onMonorepoSub(packagePath: string, monorepoPath?: string): NodePaths;
 }
 export {};

package/lib/boilersmith/paths.js

@@ -1,29 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodePaths = void 0;
-const node_path_1 = require("node:path");
+const path_1 = require("path");
 class NodePaths {
     constructor(paths) {
         this.paths = paths;
     }
     cwd(...path) {
-        return (0, node_path_1.resolve)(process.cwd(), ...path);
+        return (0, path_1.resolve)(process.cwd(), ...path);
     }
     package(...path) {
-        return (0, node_path_1.resolve)(this.paths.package, ...path);
+        return (0, path_1.resolve)(this.paths.package, ...path);
     }
     requestedDir(...path) {
         if (!this.paths.requestedDir)
             return null;
-        return (0, node_path_1.resolve)(this.paths.requestedDir, ...path);
+        return (0, path_1.resolve)(this.paths.requestedDir, ...path);
     }
     monorepo(...path) {
         if (!this.paths.monorepo)
             return null;
-        return (0, node_path_1.resolve)(this.paths.monorepo, ...path);
+        return (0, path_1.resolve)(this.paths.monorepo, ...path);
     }
-    onMonorepoSub(packagePath) {
-        return new NodePaths(Object.assign(Object.assign({}, this.paths), { monorepo: this.paths.package, package: packagePath }));
+    onMonorepoSub(packagePath, monorepoPath) {
+        return new NodePaths(Object.assign(Object.assign({}, this.paths), { monorepo: monorepoPath !== null && monorepoPath !== void 0 ? monorepoPath : this.paths.package, package: packagePath }));
     }
 }
 exports.NodePaths = NodePaths;

package/lib/boilersmith/scaffolding/audit-step-factory.js

@@ -8,7 +8,7 @@ const module_1 = require("./module");
 const template_param_1 = require("./template-param");
 const cond_format_1 = require("boilersmith/utils/cond-format");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
-const node_fs_1 = require("node:fs");
+const fs_1 = require("fs");
 function auditStepFactory(dry, scaffoldDir, modules, templateParams, excludeScaffoldingFunc, moduleStatusCache) {
     let modulesEnabled;
     return {
@@ -17,28 +17,28 @@ function auditStepFactory(dry, scaffoldDir, modules, templateParams, excludeScaf
         async run(_fs, paths, io, _providers) {
             const paramVals = await (0, template_param_1.currParamValues)(templateParams, _fs, paths, io);
             modulesEnabled = await (0, module_1.currModulesEnabled)(modules, _fs, paths, moduleStatusCache);
-            const actionableModules = modules.filter(m => m.updatable && modulesEnabled[m.name] && (!m.togglable || !m.dependsOn.some(dep => !modulesEnabled[dep])));
-            io.info((0, cond_format_1.condFormat)(io.supportsAnsiColor, m => chalk_1.default.yellow(chalk_1.default.bold(chalk_1.default.underline(m))), `Auditing infrastructure for ${actionableModules.length} enabled modules:`), true);
+            const actionableModules = modules.filter((m) => m.updatable && modulesEnabled[m.name] && (!m.togglable || !m.dependsOn.some((dep) => !modulesEnabled[dep])));
+            io.info((0, cond_format_1.condFormat)(io.supportsAnsiColor, (m) => chalk_1.default.yellow(chalk_1.default.bold(chalk_1.default.underline(m))), `Auditing infrastructure for ${actionableModules.length} enabled modules:`), true);
             for (const m of modules) {
                 if (actionableModules.includes(m)) {
-                    io.info((0, cond_format_1.condFormat)(io.supportsAnsiColor, m => chalk_1.default.dim(chalk_1.default.green(m)), `✓ ${m.name}: ${m.shortDescription}`), true);
+                    io.info((0, cond_format_1.condFormat)(io.supportsAnsiColor, (m) => chalk_1.default.dim(chalk_1.default.green(m)), `✓ ${m.name}: ${m.shortDescription}`), true);
                 }
                 else if (m.updatable) {
-                    io.info((0, cond_format_1.condFormat)(io.supportsAnsiColor, m => chalk_1.default.dim(chalk_1.default.red(m)), `𐄂 ${m.name}: ${m.shortDescription} (disabled)`), true);
+                    io.info((0, cond_format_1.condFormat)(io.supportsAnsiColor, (m) => chalk_1.default.dim(chalk_1.default.red(m)), `✕ ${m.name}: ${m.shortDescription} (disabled)`), true);
                 }
             }
             for (const m of actionableModules) {
                 const fs = dry ? (0, mem_fs_1.create)() : _fs;
-                const excludeScaffolding = excludeScaffoldingFunc ? excludeScaffoldingFunc(fs, paths) : [];
+                const excludeScaffolding = excludeScaffoldingFunc ? excludeScaffoldingFunc(fs, paths) : { files: [], configKeys: {} };
                 (0, module_1.applyModule)(m, modulesEnabled, paramVals, scaffoldDir, fs, paths, excludeScaffolding, true);
                 if (dry) {
                     const filesWithChanges = fs
                         .all()
-                        .filter(f => f.state && f.state !== 'deleted')
-                        .filter(f => { var _a; return !(0, node_fs_1.existsSync)(f.path) || (0, node_fs_1.readFileSync)(f.path, 'utf8').toString() !== ((_a = f.contents) === null || _a === void 0 ? void 0 : _a.toString()); });
+                        .filter((f) => f.state && f.state !== 'deleted')
+                        .filter((f) => { var _a; return !(0, fs_1.existsSync)(f.path) || (0, fs_1.readFileSync)(f.path, 'utf8').toString() !== ((_a = f.contents) === null || _a === void 0 ? void 0 : _a.toString()); });
                     if (filesWithChanges.length > 0) {
                         io.error(`Module ${m.name} has ${filesWithChanges.length} changed files: ${filesWithChanges
-                            .map(f => f.path.replace(paths.package() + '/', ''))
+                            .map((f) => f.path.replace(paths.package() + '/', ''))
                             .join(', ')}`, false);
                     }
                 }
@@ -52,9 +52,9 @@ function auditStepFactory(dry, scaffoldDir, modules, templateParams, excludeScaf
             }
             return _fs;
         },
-        exposes: modules.map(m => `modules.${m.name}`),
+        exposes: modules.map((m) => `modules.${m.name}`),
         getExposed(_paths, _paramProvider) {
-            return (0, rename_keys_1.renameKeys)(modulesEnabled, k => `modules.${k}`);
+            return (0, rename_keys_1.renameKeys)(modulesEnabled, (k) => `modules.${k}`);
         },
     };
 }

package/lib/boilersmith/scaffolding/infra-step-factory.js

@@ -4,7 +4,7 @@ exports.infraStepFactory = void 0;
 const module_1 = require("./module");
 const template_param_1 = require("./template-param");
 function infraStepFactory(scaffoldDir, moduleName, modules, templateParams, excludeScaffoldingFunc, moduleStatusCache) {
-    const module = modules.find(m => m.name === moduleName);
+    const module = modules.find((m) => m.name === moduleName);
     if (!module) {
         throw new Error(`Module ${moduleName} not found`);
     }
@@ -17,7 +17,7 @@ function infraStepFactory(scaffoldDir, moduleName, modules, templateParams, excl
             if (!module.updatable) {
                 io.error(`${module.name} is not updatable.`, true);
             }
-            const excludeScaffolding = excludeScaffoldingFunc ? excludeScaffoldingFunc(fs, paths) : [];
+            const excludeScaffolding = excludeScaffoldingFunc ? excludeScaffoldingFunc(fs, paths) : { files: [], configKeys: {} };
             const initializing = !modulesEnabled[module.name];
             (0, module_1.applyModule)(module, Object.assign(Object.assign({}, modulesEnabled), { [module.name]: true }), paramVals, scaffoldDir, fs, paths, excludeScaffolding, initializing);
             if (moduleStatusCache) {

package/lib/boilersmith/scaffolding/init-step-factory.js

@@ -12,22 +12,22 @@ function initStepFactory(scaffoldDir, modules, templateParams, excludeScaffoldin
         async run(fs, paths, io, _providers) {
             const paramVals = await (0, template_param_1.promptParamValues)(templateParams, paths, io);
             modulesEnabled = await (0, module_1.promptModulesEnabled)(modules, io);
-            const excludeScaffolding = excludeScaffoldingFunc ? excludeScaffoldingFunc(fs, paths) : [];
+            const excludeScaffolding = excludeScaffoldingFunc ? excludeScaffoldingFunc(fs, paths) : { files: [], configKeys: {} };
             for (const m of modules) {
-                if (modulesEnabled[m.name] && (!m.togglable || !m.dependsOn.some(dep => !modulesEnabled[dep]))) {
+                if (modulesEnabled[m.name] && (!m.togglable || !m.dependsOn.some((dep) => !modulesEnabled[dep]))) {
                     (0, module_1.applyModule)(m, modulesEnabled, paramVals, scaffoldDir, fs, paths, excludeScaffolding, true);
                 }
             }
             if (moduleStatusCache) {
-                modules.forEach(m => {
+                modules.forEach((m) => {
                     (0, module_1.setModuleValue)(m, modulesEnabled[m.name], fs, paths, moduleStatusCache);
                 });
             }
             return fs;
         },
-        exposes: modules.map(m => `modules.${m.name}`),
+        exposes: modules.map((m) => `modules.${m.name}`),
         getExposed(_paths, _paramProvider) {
-            return (0, rename_keys_1.renameKeys)(modulesEnabled, k => `modules.${k}`);
+            return (0, rename_keys_1.renameKeys)(modulesEnabled, (k) => `modules.${k}`);
         },
     };
 }

package/lib/boilersmith/scaffolding/module.d.ts

@@ -1,7 +1,8 @@
 import { Store } from 'mem-fs';
 import { IO } from 'boilersmith/io';
 import { Paths } from 'boilersmith/paths';
-interface FileOwnership {
+import { ExcludeScaffoldingFunc } from './scaffolder';
+declare type FileOwnershipCommon<N extends string> = {
     /**
      * The path to the file
      */
@@ -13,16 +14,26 @@ interface FileOwnership {
     /**
      * Depends on other modules being enabled (or disabled).
      */
-    moduleDeps?: (string | {
-        module: string;
+    moduleDeps?: (N | {
+        module: N;
         enabled: boolean;
     })[];
+    /**
+     * Only create the file if it doesn't exist; do not update existing files.
+     */
+    doNotUpdate?: boolean;
+};
+declare type FileOwnership<N extends string> = (FileOwnershipCommon<N> & {
     /**
      * If in a monorepo, should the file be placed relative to the monorepo root, and if so, where?
      * If provided, takes priority over destPath.
      */
-    monorepoPath?: string;
-}
+    monorepoPath: string;
+    /**
+     * Only place this file if in a monorepo?
+     */
+    requireMonorepo: boolean;
+}) | FileOwnershipCommon<N>;
 interface CommonModule<N extends string> {
     name: N;
     shortDescription: string;
@@ -34,7 +45,7 @@ interface CommonModule<N extends string> {
     /**
      * A list of scaffolding files managed by this module.
      */
-    filesToReplace: (string | FileOwnership)[];
+    filesToReplace: (string | FileOwnership<N>)[];
     /**
      * A map of names of JSON files to keys which should be deep-merged from the scaffolding.
      */
@@ -62,7 +73,7 @@ interface TogglableModule<N extends string> extends CommonModule<N> {
     /**
      * Can only be enabled if these other modules are enabled.
      */
-    dependsOn: string[];
+    dependsOn: N[];
     /**
      * On an existing installation, if no information about whether this
      * module is enabled or disabled is cached, infer whether it's enabled
@@ -78,5 +89,5 @@ export declare type ModuleStatusCache<N extends string> = {
 export declare function promptModulesEnabled<N extends string>(modules: Module<N>[], io: IO): Promise<Record<N, boolean>>;
 export declare function currModulesEnabled<N extends string>(modules: Module<N>[], fs: Store, paths: Paths, cache?: ModuleStatusCache<N>): Promise<Record<N, boolean>>;
 export declare function setModuleValue<MN extends string>(module: Module<MN>, enabled: boolean, fs: Store, paths: Paths, cache: ModuleStatusCache<MN>): Promise<void>;
-export declare function applyModule<MN extends string, TN extends string>(module: Module<MN>, modulesEnabled: Record<string, boolean>, paramVals: Record<TN, unknown>, scaffoldDir: string, fs: Store, paths: Paths, excludeFiles?: string[], isInitial?: boolean): Promise<Store>;
+export declare function applyModule<MN extends string, TN extends string>(module: Module<MN>, modulesEnabled: Record<string, boolean>, paramVals: Record<TN, unknown>, scaffoldDir: string, fs: Store, paths: Paths, excludeScaffolding?: ReturnType<ExcludeScaffoldingFunc>, isInitial?: boolean): Promise<Store>;
 export {};

package/lib/boilersmith/scaffolding/module.js

@@ -4,7 +4,7 @@ exports.applyModule = exports.setModuleValue = exports.currModulesEnabled = expo
 const tslib_1 = require("tslib");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const mem_fs_editor_1 = require("mem-fs-editor");
-const node_path_1 = require("node:path");
+const path_1 = require("path");
 const pick_deep_1 = (0, tslib_1.__importDefault)(require("pick-deep"));
 const read_tpl_1 = require("boilersmith/utils/read-tpl");
 const clone_and_fill_1 = require("boilersmith/utils/clone-and-fill");
@@ -19,7 +19,7 @@ async function promptModulesEnabled(modules, io) {
         message: `Advanced Initialization ${(0, cond_format_1.condFormat)(io.supportsAnsiColor, chalk_1.default.dim, '(fine-tune which features are enabled)')}`,
     });
     for (const m of modules) {
-        const missingDeps = !m.togglable || m.dependsOn.some(dep => !modulesEnabled[dep]);
+        const missingDeps = !m.togglable || m.dependsOn.some((dep) => !modulesEnabled[dep]);
         if (!m.togglable) {
             modulesEnabled[m.name] = true;
         }
@@ -48,7 +48,7 @@ async function currModulesEnabled(modules, fs, paths, cache) {
     for (const m of modules) {
         if (m.togglable) {
             // eslint-disable-next-line no-await-in-loop
-            const isEnabled = (_a = await (cache === null || cache === void 0 ? void 0 : cache.get(m, fs, paths))) !== null && _a !== void 0 ? _a : await ((_b = m.inferEnabled) === null || _b === void 0 ? void 0 : _b.call(m, fs, paths));
+            const isEnabled = (_a = (await (cache === null || cache === void 0 ? void 0 : cache.get(m, fs, paths)))) !== null && _a !== void 0 ? _a : (await ((_b = m.inferEnabled) === null || _b === void 0 ? void 0 : _b.call(m, fs, paths)));
             modulesEnabled[m.name] = isEnabled !== null && isEnabled !== void 0 ? isEnabled : m.defaultEnabled;
         }
         else {
@@ -64,21 +64,23 @@ async function setModuleValue(module, enabled, fs, paths, cache) {
     }
 }
 exports.setModuleValue = setModuleValue;
-// eslint-disable-next-line max-params
-async function applyModule(module, modulesEnabled, paramVals, scaffoldDir, fs, paths, excludeFiles = [], isInitial = false) {
-    var _a;
+// eslint-disable-next-line max-params,complexity
+async function applyModule(module, modulesEnabled, paramVals, scaffoldDir, fs, paths, 
+// eslint-disable-next-line unicorn/no-object-as-default-parameter
+excludeScaffolding = { files: [], configKeys: {} }, isInitial = false) {
+    var _a, _b;
     const fsEditor = (0, mem_fs_editor_1.create)(fs);
     // Validate that module can be enabled
     if (!(modulesEnabled === null || modulesEnabled === void 0 ? void 0 : modulesEnabled[module.name])) {
         throw new Error(`Could not apply module "${module.name}", because it is not enabled in the provided module statuses.`);
     }
     // Validate that dependencies are enabled
-    const missingDeps = module.togglable ? module.dependsOn.filter(dep => !modulesEnabled[dep]) : [];
+    const missingDeps = module.togglable ? module.dependsOn.filter((dep) => !modulesEnabled[dep]) : [];
     if (missingDeps.length > 0) {
         throw new Error(`Could not apply module "${module.name}", because the following dependency modules are missing: "${missingDeps.join(', ')}".`);
     }
     // Validate that all needed params are present
-    const missingParams = module.needsTemplateParams.filter(p => !(p in paramVals));
+    const missingParams = module.needsTemplateParams.filter((p) => !(p in paramVals));
     if (missingParams.length > 0) {
         throw new Error(`Could not apply module "${module.name}", because the following params are missing: "${missingParams.join(', ')}".`);
     }
@@ -89,28 +91,63 @@ async function applyModule(module, modulesEnabled, paramVals, scaffoldDir, fs, p
         params: paramVals,
         modules: modulesEnabled,
     };
-    const tplDataFlat = Object.assign(Object.assign({}, (0, rename_keys_1.renameKeys)(tplData.modules, k => `modules.${k}`)), (0, rename_keys_1.renameKeys)(tplData.params, k => `params.${k}`));
+    const tplDataFlat = Object.assign(Object.assign({}, (0, rename_keys_1.renameKeys)(tplData.modules, (k) => `modules.${k}`)), (0, rename_keys_1.renameKeys)(tplData.params, (k) => `params.${k}`));
+    // This is necessary because one layer of escaped backslashes is lost on template population.
+    tplData.params = Object.fromEntries(Object.entries(paramVals).map(([k, v]) => [k, typeof v === 'string' ? v.replace('\\', '\\\\') : v]));
     for (const file of module.filesToReplace) {
         const path = typeof file === 'string' ? file : file.path;
         const moduleDeps = typeof file === 'string' ? [] : (_a = file.moduleDeps) !== null && _a !== void 0 ? _a : [];
-        if (!excludeFiles.includes(path) && !moduleDeps.some(dep => {
-            const depName = typeof dep === 'string' ? dep : dep.module;
-            const enabled = modulesEnabled[depName];
-            return typeof dep === 'string' || dep.enabled ? !enabled : enabled;
-        })) {
-            const copyToIfMonorepo = typeof file !== 'string' && file.monorepoPath ? paths.monorepo((0, clone_and_fill_1.cloneAndFill)(file.monorepoPath, tplDataFlat)) : undefined;
-            const copyTo = copyToIfMonorepo !== null && copyToIfMonorepo !== void 0 ? copyToIfMonorepo : paths.package(typeof file !== 'string' && file.destPath ? (0, clone_and_fill_1.cloneAndFill)(file.destPath, tplDataFlat) : path);
-            fsEditor.copyTpl((0, node_path_1.resolve)(scaffoldDir, path), copyTo, tplData);
+        const copyToIfMonorepo = typeof file !== 'string' && 'monorepoPath' in file && file.monorepoPath
+            ? paths.monorepo((0, clone_and_fill_1.cloneAndFill)(file.monorepoPath, tplDataFlat))
+            : undefined;
+        const copyTo = copyToIfMonorepo !== null && copyToIfMonorepo !== void 0 ? copyToIfMonorepo : paths.package(typeof file !== 'string' && file.destPath ? (0, clone_and_fill_1.cloneAndFill)(file.destPath, tplDataFlat) : path);
+        if (typeof file !== 'string' && file.doNotUpdate && fsEditor.exists(copyTo)) {
+            continue;
+        }
+        if (typeof file !== 'string' && 'requireMonorepo' in file && file.requireMonorepo && paths.monorepo() === null) {
+            continue;
+        }
+        if (excludeScaffolding.files.includes(path) ||
+            moduleDeps.some((dep) => {
+                const depName = typeof dep === 'string' ? dep : dep.module;
+                const enabled = modulesEnabled[depName];
+                return typeof dep === 'string' || dep.enabled ? !enabled : enabled;
+            })) {
+            continue;
         }
+        let source = (0, read_tpl_1.readTpl)((0, path_1.resolve)(scaffoldDir, path), tplData);
+        if (fsEditor.exists(copyTo)) {
+            source = applyCustomizations(source, fsEditor.read(copyTo));
+        }
+        fsEditor.write(copyTo, source);
     }
     const jsonPaths = (0, clone_and_fill_1.cloneAndFill)(module.jsonToAugment, tplDataFlat);
     for (const jsonPath of Object.keys(jsonPaths)) {
-        const scaffoldContents = (0, read_tpl_1.readTpl)((0, node_path_1.resolve)(scaffoldDir, jsonPath), tplData);
+        const scaffoldContents = (0, read_tpl_1.readTpl)((0, path_1.resolve)(scaffoldDir, jsonPath), tplData);
         const scaffoldContentsJson = JSON.parse(scaffoldContents);
-        const fieldsToAugment = jsonPaths[jsonPath];
+        const excludeKeys = (0, clone_and_fill_1.cloneAndFill)((_b = excludeScaffolding.configKeys[jsonPath]) !== null && _b !== void 0 ? _b : [], tplDataFlat);
+        const fieldsToAugment = jsonPaths[jsonPath].filter((key) => !excludeKeys.includes(key));
         const relevant = (0, pick_deep_1.default)(scaffoldContentsJson, fieldsToAugment);
         fsEditor.extendJSON(paths.package(jsonPath), relevant, undefined, 4);
     }
     return fs;
 }
 exports.applyModule = applyModule;
+function applyCustomizations(source, curr) {
+    const commentStructures = [
+        ['//', '\n'],
+        ['/*', ' */'],
+        ['<!--', '-->'],
+        ['#', '\n'],
+    ];
+    commentStructures.forEach((x) => x);
+    return commentStructures.reduce((acc, [start, end]) => {
+        const CUSTOMIZATION_REGEX = new RegExp(`(${start}\\s*<CUSTOM-(?<id>.*)>\\s*${end})(?<contents>.*)(${start}\\s*</CUSTOM-\\k<id>>\\s*${end})`, 'gs');
+        const matches = curr.matchAll(CUSTOMIZATION_REGEX);
+        const customizations = Object.fromEntries([...matches]
+            .map((m) => m.groups)
+            .filter(Boolean)
+            .map((g) => [g === null || g === void 0 ? void 0 : g.id, g === null || g === void 0 ? void 0 : g.contents]));
+        return acc.replace(CUSTOMIZATION_REGEX, (_m, open, id, _c, close) => { var _a; return `${open}${(_a = customizations[id]) !== null && _a !== void 0 ? _a : ''}${close}`; });
+    }, source);
+}

package/lib/boilersmith/scaffolding/scaffolder.d.ts

@@ -4,7 +4,10 @@ import { DefaultProviders, Step } from '../step-manager';
 import { Module, ModuleStatusCache } from './module';
 import { TemplateParam } from './template-param';
 import { IO } from 'boilersmith/io';
-export declare type ExcludeScaffoldingFunc = (fs: Store, paths: Paths) => string[];
+export declare type ExcludeScaffoldingFunc = (fs: Store, paths: Paths) => {
+    files: string[];
+    configKeys: Record<string, string[]>;
+};
 export declare class Scaffolder<TN extends string = string, MN extends string = string> {
     private templateParams;
     private modules;

package/lib/boilersmith/scaffolding/scaffolder.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Scaffolder = void 0;
 const tslib_1 = require("tslib");
 const globby_1 = (0, tslib_1.__importDefault)(require("globby"));
-const node_path_1 = require("node:path");
+const path_1 = require("path");
 const json_leaf_paths_1 = require("boilersmith/utils/json-leaf-paths");
 const read_tpl_1 = require("boilersmith/utils/read-tpl");
 const init_step_factory_1 = require("./init-step-factory");
@@ -27,8 +27,8 @@ class Scaffolder {
     }
     registerTemplateParam(templateParam) {
         if ((0, template_param_1.isComputedParam)(templateParam)) {
-            const currParams = new Set(this.templateParams.map(p => (0, template_param_1.getParamName)(p)));
-            const missingDeps = templateParam.uses.filter(dep => !currParams.has(dep));
+            const currParams = new Set(this.templateParams.map((p) => (0, template_param_1.getParamName)(p)));
+            const missingDeps = templateParam.uses.filter((dep) => !currParams.has(dep));
             if (missingDeps.length > 0) {
                 throw new Error(`Computed template param "${(0, template_param_1.getParamName)(templateParam)}" is missing dependency params: "${missingDeps.join(', ')}".`);
             }
@@ -56,7 +56,7 @@ class Scaffolder {
     }
     moduleFiles(moduleName) {
         var _a, _b;
-        return (_b = (_a = this.modules.find(m => m.name === moduleName)) === null || _a === void 0 ? void 0 : _a.filesToReplace.map(f => typeof f === 'string' ? f : f.path)) !== null && _b !== void 0 ? _b : [];
+        return (_b = (_a = this.modules.find((m) => m.name === moduleName)) === null || _a === void 0 ? void 0 : _a.filesToReplace.map((f) => (typeof f === 'string' ? f : f.path))) !== null && _b !== void 0 ? _b : [];
     }
     /**
      * Confirm that all files and configuration keys in the scaffolding dir
@@ -66,13 +66,13 @@ class Scaffolder {
     async validate() {
         const errors = [];
         // Generate template data for future checks
-        const paramVals = Object.fromEntries(this.templateParams.map(param => [(0, template_param_1.getParamName)(param), 'TEST']));
-        const modulesEnabled = Object.fromEntries(this.modules.map(module => [module.name, true]));
+        const paramVals = Object.fromEntries(this.templateParams.map((param) => [(0, template_param_1.getParamName)(param), 'TEST']));
+        const modulesEnabled = Object.fromEntries(this.modules.map((module) => [module.name, true]));
         const tplData = { params: paramVals, modules: modulesEnabled };
-        const tplDataFlat = Object.assign(Object.assign({}, (0, rename_keys_1.renameKeys)(tplData.modules, k => `modules.${k}`)), (0, rename_keys_1.renameKeys)(tplData.params, k => `params.${k}`));
-        const moduleNames = new Set(this.modules.map(m => m.name));
+        const tplDataFlat = Object.assign(Object.assign({}, (0, rename_keys_1.renameKeys)(tplData.modules, (k) => `modules.${k}`)), (0, rename_keys_1.renameKeys)(tplData.params, (k) => `params.${k}`));
+        const moduleNames = new Set(this.modules.map((m) => m.name));
         for (const module of this.modules) {
-            const missingDeps = module.togglable ? module.dependsOn.filter(dep => !moduleNames.has(dep)) : [];
+            const missingDeps = module.togglable ? module.dependsOn.filter((dep) => !moduleNames.has(dep)) : [];
             if (missingDeps.length > 0) {
                 errors.push(`Module "${module.name}" depends on modules that are not registered: "${missingDeps.join(', ')}".`);
             }
@@ -81,23 +81,23 @@ class Scaffolder {
         const configKeysToOwnerModules = new Map();
         const templateParamsToUsingModules = new Map();
         for (const module of this.modules) {
-            module.filesToReplace.forEach(file => {
+            module.filesToReplace.forEach((file) => {
                 var _a;
                 const path = typeof file === 'string' ? file : file.path;
                 const currModules = (_a = filesToOwnerModules.get(path)) !== null && _a !== void 0 ? _a : [];
                 filesToOwnerModules.set(path, [...currModules, module.name]);
             });
-            module.needsTemplateParams.forEach(paramName => {
+            module.needsTemplateParams.forEach((paramName) => {
                 var _a;
                 const currModules = (_a = filesToOwnerModules.get(paramName)) !== null && _a !== void 0 ? _a : [];
                 templateParamsToUsingModules.set(paramName, [...currModules, module.name]);
             });
-            Object.keys(module.jsonToAugment).forEach(jsonPath => {
+            Object.keys(module.jsonToAugment).forEach((jsonPath) => {
                 var _a;
                 const ownedKeys = (0, clone_and_fill_1.cloneAndFill)(module.jsonToAugment, tplDataFlat)[jsonPath];
                 const currJsonData = (_a = configKeysToOwnerModules.get(jsonPath)) !== null && _a !== void 0 ? _a : { fileOwners: [], keyOwners: new Map() };
                 currJsonData.fileOwners.push(module.name);
-                ownedKeys.forEach(key => {
+                ownedKeys.forEach((key) => {
                     var _a;
                     const currModules = (_a = currJsonData.keyOwners.get(key)) !== null && _a !== void 0 ? _a : [];
                     currJsonData.keyOwners.set(key, [...currModules, module.name]);
@@ -109,46 +109,46 @@ class Scaffolder {
         const moduleOwnedFiles = [...filesToOwnerModules.keys()];
         const moduleOwnedJsonConfs = new Set(configKeysToOwnerModules.keys());
         moduleOwnedFiles
-            .filter(path => moduleOwnedJsonConfs.has(path))
-            .forEach(path => {
+            .filter((path) => moduleOwnedJsonConfs.has(path))
+            .forEach((path) => {
             var _a, _b;
             const fileModules = (_a = filesToOwnerModules.get(path)) === null || _a === void 0 ? void 0 : _a.join(', ');
             const keyModules = (_b = configKeysToOwnerModules.get(path)) === null || _b === void 0 ? void 0 : _b.fileOwners.join(', ');
             errors.push(`File "${path}" is owned by modules: "${fileModules}". However, it also has keys that are owned by modules: "${keyModules}".`);
         });
         // Ensure that all owned files exist in the filesystem.
-        const scaffoldingFilePaths = new Set((await (0, globby_1.default)((0, node_path_1.resolve)(this.scaffoldDir, '**/*'), { dot: true })).map(p => p.replace(`${this.scaffoldDir}/`, '')).filter(p => p !== ''));
+        const scaffoldingFilePaths = new Set((await (0, globby_1.default)((0, path_1.resolve)(this.scaffoldDir, '**/*'), { dot: true })).map((p) => p.replace(`${this.scaffoldDir}/`, '')).filter((p) => p !== ''));
         moduleOwnedFiles
-            .filter(path => !scaffoldingFilePaths.has(path))
-            .forEach(path => {
+            .filter((path) => !scaffoldingFilePaths.has(path))
+            .forEach((path) => {
             var _a;
             const fileModules = (_a = filesToOwnerModules.get(path)) === null || _a === void 0 ? void 0 : _a.join(', ');
             errors.push(`File "${path}" is owned by modules: "${fileModules}", but it doesn't exist in the scaffolding directory.`);
         });
         [...moduleOwnedJsonConfs]
-            .filter(path => !scaffoldingFilePaths.has(path))
-            .forEach(path => {
+            .filter((path) => !scaffoldingFilePaths.has(path))
+            .forEach((path) => {
             var _a;
             const keyModules = (_a = configKeysToOwnerModules.get(path)) === null || _a === void 0 ? void 0 : _a.fileOwners.join(', ');
             errors.push(`File "${path}" has keys owned by modules: "${keyModules}", but it doesn't exist in the scaffolding directory.`);
         });
         // Ensure that all files in the filesystem are owned by at least one module.
         [...scaffoldingFilePaths]
-            .filter(path => !filesToOwnerModules.has(path) && !configKeysToOwnerModules.has(path))
-            .forEach(path => {
+            .filter((path) => !filesToOwnerModules.has(path) && !configKeysToOwnerModules.has(path))
+            .forEach((path) => {
             errors.push(`File "${path}" is not owned by any module.`);
         });
         // Ensure that every template param is used by at least one module.
         this.templateParams
-            .filter(p => !templateParamsToUsingModules.has((0, template_param_1.getParamName)(p)))
-            .forEach(p => {
+            .filter((p) => !templateParamsToUsingModules.has((0, template_param_1.getParamName)(p)))
+            .forEach((p) => {
             errors.push(`Template param "${(0, template_param_1.getParamName)(p)}" is defined, but not used by any modules.`);
         });
         // Ensure that every module's needed template params are provided.
-        const providedParams = new Set(this.templateParams.map(p => (0, template_param_1.getParamName)(p)));
+        const providedParams = new Set(this.templateParams.map((p) => (0, template_param_1.getParamName)(p)));
         [...templateParamsToUsingModules.keys()]
-            .filter(paramName => !providedParams.has(paramName))
-            .forEach(paramName => {
+            .filter((paramName) => !providedParams.has(paramName))
+            .forEach((paramName) => {
             var _a;
             const paramModules = (_a = templateParamsToUsingModules.get(paramName)) === null || _a === void 0 ? void 0 : _a.join(', ');
             errors.push(`Template param "${paramName}" is used by modules: "${paramModules}", but is not provided.`);
@@ -164,14 +164,14 @@ class Scaffolder {
             if (errors.length > 0) {
                 throw new Error(errors.join('\n'));
             }
-            const contents = (0, read_tpl_1.readTpl)((0, node_path_1.resolve)(this.scaffoldDir, path), tplData);
+            const contents = (0, read_tpl_1.readTpl)((0, path_1.resolve)(this.scaffoldDir, path), tplData);
             let json;
             try {
                 json = JSON.parse(contents);
                 const keys = new Set((0, json_leaf_paths_1.jsonLeafPaths)(json));
                 [...keys]
-                    .filter(k => !ownerData.keyOwners.has(k))
-                    .forEach(k => {
+                    .filter((k) => !ownerData.keyOwners.has(k))
+                    .forEach((k) => {
                     errors.push(`Key "${k}" in file "${path}" is not owned by any module.`);
                 });
                 [...ownerData.keyOwners.entries()]
@@ -195,8 +195,8 @@ class Scaffolder {
             throw new Error(errors.join('\n'));
         }
         // Ensure that all files can be resolved with ejs using provided template variables.
-        scaffoldingFilePaths.forEach(path => {
-            (0, read_tpl_1.readTpl)((0, node_path_1.resolve)(this.scaffoldDir, path), tplData);
+        scaffoldingFilePaths.forEach((path) => {
+            (0, read_tpl_1.readTpl)((0, path_1.resolve)(this.scaffoldDir, path), tplData);
         });
     }
 }

package/lib/boilersmith/scaffolding/template-param.d.ts

@@ -11,7 +11,7 @@ interface PromptTemplateParam<T, N extends string = string> {
 }
 interface ComputedTemplateParam<T, N extends string = string> {
     name: N;
-    uses: string[];
+    uses: N[];
     compute: (paths: Paths, ...args: any[]) => Promise<T>;
 }
 export declare type TemplateParam<T = unknown, N extends string = string> = PromptTemplateParam<T, N> | ComputedTemplateParam<T, N>;

package/lib/boilersmith/scaffolding/template-param.js

@@ -17,7 +17,7 @@ async function withComputedParamValues(params, paths, paramVals) {
     const vals = Object.assign({}, paramVals);
     const computedParams = params.filter(isComputedParam);
     for (const p of computedParams) {
-        const depValues = p.uses.map(key => vals[key]);
+        const depValues = p.uses.map((key) => vals[key]);
         // eslint-disable-next-line no-await-in-loop
         vals[p.name] = await p.compute(paths, ...depValues);
     }
@@ -39,7 +39,7 @@ async function currParamValues(params, fs, paths, io) {
     const paramVals = {};
     for (const p of promptParams) {
         // eslint-disable-next-line no-await-in-loop
-        paramVals[p.prompt.name] = (_a = await p.getCurrVal(fs, paths)) !== null && _a !== void 0 ? _a : await io.getParam(p.prompt);
+        paramVals[p.prompt.name] = (_a = (await p.getCurrVal(fs, paths))) !== null && _a !== void 0 ? _a : (await io.getParam(p.prompt));
     }
     return withComputedParamValues(params, paths, paramVals);
 }

package/lib/boilersmith/step-manager.d.ts

@@ -72,7 +72,6 @@ export declare class StepManager<Providers extends DefaultProviders> {
     run(paths: Paths, io: IO, providers: Providers, dry?: boolean): Promise<StepsResult>;
     protected stepShouldRun(storedStep: StoredStep<Providers>, io: IO, packagePath?: string): Promise<boolean>;
     protected runStep(storedStep: StoredStep<Providers>, paths: Paths, io: IO, providers: Providers, packagePath?: string, fs?: Store): Promise<Store>;
-    protected commit(fs: Store): Promise<boolean>;
 }
 export declare class AtomicStepManager<Providers = DefaultProviders> extends StepManager<Providers> {
     protected steps: StoredStep<Providers>[];