@flarum/cli 2.0.0-beta.9 → 3.0.0

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';
+type FileOwnershipCommon<N extends string> = {
     /**
      * The path to the file
      */
@@ -11,15 +12,28 @@ interface FileOwnership {
      */
     destPath?: string;
     /**
-     * If any of the needed modules aren't enabled, the file won't be updated.
+     * Depends on other modules being enabled (or disabled).
      */
-    needsOtherModules?: string[];
+    moduleDeps?: (N | {
+        module: N;
+        enabled: boolean;
+    })[];
+    /**
+     * Only create the file if it doesn't exist; do not update existing files.
+     */
+    doNotUpdate?: boolean;
+};
+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;
@@ -31,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.
      */
@@ -59,15 +73,21 @@ 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
+     * based on the current installation's state.
+     */
+    inferEnabled?: (fs: Store, paths: Paths) => Promise<boolean | undefined>;
 }
-export declare type Module<N extends string = string> = UntoggleableModule<N> | TogglableModule<N>;
-export declare type ModuleStatusCache<N extends string> = {
+export type Module<N extends string = string> = UntoggleableModule<N> | TogglableModule<N>;
+export type ModuleStatusCache<N extends string> = {
     get: (module: Module<N>, fs: Store, paths: Paths) => Promise<boolean | undefined>;
     set: (module: Module<N>, val: boolean, fs: Store, paths: Paths) => Promise<void>;
 };
 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

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applyModule = exports.setModuleValue = exports.currModulesEnabled = exports.promptModulesEnabled = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const mem_fs_editor_1 = require("mem-fs-editor");
-const node_path_1 = require("node:path");
-const pick_deep_1 = (0, tslib_1.__importDefault)(require("pick-deep"));
+const path_1 = require("path");
+const pick_deep_1 = 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");
 const rename_keys_1 = require("boilersmith/utils/rename-keys");
@@ -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;
         }
@@ -43,12 +43,13 @@ async function promptModulesEnabled(modules, io) {
 }
 exports.promptModulesEnabled = promptModulesEnabled;
 async function currModulesEnabled(modules, fs, paths, cache) {
+    var _a, _b;
     const modulesEnabled = {};
     for (const m of modules) {
         if (m.togglable) {
             // eslint-disable-next-line no-await-in-loop
-            const cacheVal = await (cache === null || cache === void 0 ? void 0 : cache.get(m, fs, paths));
-            modulesEnabled[m.name] = cacheVal !== null && cacheVal !== void 0 ? cacheVal : m.defaultEnabled;
+            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 {
             modulesEnabled[m.name] = true;
@@ -63,21 +64,22 @@ 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;
+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(', ')}".`);
     }
@@ -88,24 +90,64 @@ 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}`));
     for (const file of module.filesToReplace) {
         const path = typeof file === 'string' ? file : file.path;
-        const needsOtherModules = typeof file === 'string' ? [] : (_a = file.needsOtherModules) !== null && _a !== void 0 ? _a : [];
-        if (!excludeFiles.includes(path) && !needsOtherModules.some(dep => !modulesEnabled[dep])) {
-            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 moduleDeps = typeof file === 'string' ? [] : (_a = file.moduleDeps) !== null && _a !== void 0 ? _a : [];
+        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);
+    // This is necessary because one layer of escaped backslashes is lost on template population.
+    const clonedTplData = Object.assign({}, tplData);
+    clonedTplData.params = Object.fromEntries(Object.entries(paramVals).map(([k, v]) => [k, typeof v === 'string' ? v.replace('\\', '\\\\') : v]));
     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), clonedTplData);
         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 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

@@ -2,8 +2,8 @@
 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 globby_1 = tslib_1.__importDefault(require("globby"));
+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,10 +11,10 @@ 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>;
+export type TemplateParam<T = unknown, N extends string = string> = PromptTemplateParam<T, N> | ComputedTemplateParam<T, N>;
 export declare function isPromptParam<T, N extends string>(param: TemplateParam<T, N>): param is PromptTemplateParam<T, N>;
 export declare function isComputedParam<T, N extends string>(param: TemplateParam<T, N>): param is ComputedTemplateParam<T, N>;
 export declare function getParamName<T, N extends string>(param: TemplateParam<T, N>): 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

@@ -2,7 +2,7 @@ import { Store } from 'mem-fs';
 import { ExposedParamManager } from './exposed-param-manager';
 import { IO, Message } from './io';
 import { Paths } from './paths';
-export declare type DefaultProviders = {};
+export type DefaultProviders = {};
 export interface Step<Providers extends DefaultProviders = DefaultProviders, Exposes extends string = string> {
     /**
      * A short string describing what the step does.
@@ -26,12 +26,13 @@ export interface Step<Providers extends DefaultProviders = DefaultProviders, Exp
      */
     getExposed(paths: Paths, io: IO): Record<Exposes, unknown>;
 }
-interface ShouldRunConfig {
+export interface ShouldRunConfig {
     optional?: boolean;
     confirmationMessage?: string;
     default?: boolean;
+    silent?: boolean;
 }
-interface StoredStep<Providers extends DefaultProviders> {
+export interface StoredStep<Providers extends DefaultProviders> {
     name?: string;
     step: Step<Providers>;
     shouldRun: ShouldRunConfig;
@@ -39,15 +40,16 @@ interface StoredStep<Providers extends DefaultProviders> {
     predefinedParams: PredefinedParameters;
     mapPaths: string[];
 }
-interface StepDependency {
+export interface StepDependency {
     sourceStep: string;
     exposedName: string;
     consumedName?: string;
     dontRunIfFalsy?: boolean;
+    promptWhenMissing?: boolean;
     modifier?: (value: unknown) => string;
 }
-declare type PredefinedParameters = Record<string, unknown>;
-declare type StepsResult = {
+export type PredefinedParameters = Record<string, unknown>;
+type StepsResult = {
     succeeded: true;
     messages: Message[];
     stepsRan: string[];
@@ -57,29 +59,31 @@ declare type StepsResult = {
     errorTrace?: string;
     messages: Message[];
     stepsRan: string[];
+    e?: any;
 };
 export declare class StepManager<Providers extends DefaultProviders> {
     protected steps: Array<StoredStep<Providers> | AtomicStepManager<Providers>>;
     protected namedSteps: Map<string, StoredStep<Providers>>;
     protected exposedParams: ExposedParamManager;
+    private silent;
     /**
      * A step is an incremental operation that updates the filesystem.
      */
     step(step: Step<Providers>, shouldRun?: ShouldRunConfig, dependencies?: StepDependency[], predefinedParams?: PredefinedParameters, mapPaths?: string[]): this;
     namedStep(name: string, step: Step<Providers>, shouldRun?: ShouldRunConfig, dependencies?: StepDependency[], predefinedParams?: PredefinedParameters, mapPaths?: string[]): this;
     atomicGroup(callback: (stepManager: AtomicStepManager<Providers>) => void): this;
+    silentGroup(callback: (stepManager: StepManager<Providers>) => void): this;
     protected validateDependencies(step: Step<Providers>, dependencies: StepDependency[], mapPaths: string[]): void;
-    run(paths: Paths, io: IO, providers: Providers, dry?: boolean): Promise<StepsResult>;
+    run(paths: Paths, io: IO, providers: Providers, dry?: boolean, args?: Record<string, unknown>): 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>;
+    protected runStep(storedStep: StoredStep<Providers>, paths: Paths, io: IO, providers: Providers, packagePath?: string, fs?: Store, args?: Record<string, unknown>): Promise<Store>;
 }
-export declare class AtomicStepManager<Providers = DefaultProviders> extends StepManager<Providers> {
+export declare class AtomicStepManager<Providers extends DefaultProviders> extends StepManager<Providers> {
     protected steps: StoredStep<Providers>[];
     constructor(parentNamedSteps?: Map<string, StoredStep<Providers>>, parentExposedParams?: ExposedParamManager);
     step(step: Step<Providers>, shouldRun?: ShouldRunConfig, dependencies?: StepDependency[], predefinedParams?: PredefinedParameters, mapPaths?: string[]): this;
     namedStep(name: string, step: Step<Providers>, shouldRun?: ShouldRunConfig, dependencies?: StepDependency[], predefinedParams?: PredefinedParameters, mapPaths?: string[]): this;
     atomicGroup(_callback: (stepManager: AtomicStepManager<Providers>) => void): this;
-    run(paths: Paths, io: IO, providers: Providers, dry?: boolean): Promise<StepsResult>;
+    run(paths: Paths, io: IO, providers: Providers, dry?: boolean, args?: Record<string, unknown>): Promise<StepsResult>;
 }
 export {};