@flarum/cli 2.0.0-beta.8 → 2.0.0

package/lib/base-command.js

@@ -4,16 +4,18 @@ exports.LocationType = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const cli_ux_1 = (0, tslib_1.__importDefault)(require("cli-ux"));
-const node_path_1 = require("node:path");
+const path_1 = require("path");
 const globby_1 = (0, tslib_1.__importDefault)(require("globby"));
-const node_child_process_1 = require("node:child_process");
-const node_fs_1 = require("node:fs");
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
 const io_1 = require("boilersmith/io");
 const step_manager_1 = require("boilersmith/step-manager");
 const paths_1 = require("boilersmith/paths");
 const php_provider_1 = require("./providers/php-provider");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const errors_1 = require("@oclif/errors");
+const monorepo_1 = require("./utils/monorepo");
+const mem_fs_1 = require("mem-fs");
 var LocationType;
 (function (LocationType) {
     LocationType[LocationType["FLARUM_EXTENSION"] = 0] = "FLARUM_EXTENSION";
@@ -23,7 +25,7 @@ var LocationType;
 class BaseCommand extends core_1.Command {
     constructor() {
         super(...arguments);
-        this.STUB_PATH = (0, node_path_1.resolve)(__dirname, '../boilerplate/stubs/');
+        this.STUB_PATH = (0, path_1.resolve)(__dirname, '../boilerplate/stubs/');
         this.dry = false;
         this.requireExistingExtension = true;
     }
@@ -51,10 +53,9 @@ class BaseCommand extends core_1.Command {
             requestedDir: path,
             package: extRoot,
         });
-        const phpProvider = new php_provider_1.PhpSubsystemProvider((0, node_path_1.resolve)(__dirname, '../php-subsystem/index.php'));
-        const out = await this.steps(new step_manager_1.StepManager())
-            .run(paths, this.genIO(), { php: phpProvider }, this.dry);
-        const errorMessages = out.messages.filter(m => m.type === 'error');
+        const phpProvider = new php_provider_1.PhpSubsystemProvider((0, path_1.resolve)(__dirname, '../php-subsystem/index.php'));
+        const out = await this.steps(new step_manager_1.StepManager(), extRoot).run(paths, this.genIO(), { php: phpProvider }, this.dry);
+        const errorMessages = out.messages.filter((m) => m.type === 'error');
         this.log('\n\n');
         if (out.succeeded && errorMessages.length === 0) {
             this.log(chalk_1.default.bold(chalk_1.default.underline(chalk_1.default.green('Success! The following steps were completed:'))));
@@ -66,7 +67,7 @@ class BaseCommand extends core_1.Command {
             }
             this.log(chalk_1.default.bold(chalk_1.default.yellow('The steps that completed were:')));
         }
-        else if (out.error === 'EEXIT: 0') {
+        else if (out.error.startsWith('EEXIT:')) {
             this.log(chalk_1.default.bold(chalk_1.default.underline(chalk_1.default.red('Exiting.'))));
             if (out.stepsRan.length > 0) {
                 this.log(chalk_1.default.bold(chalk_1.default.yellow('Before the exit, the following steps were completed:')));
@@ -86,7 +87,7 @@ class BaseCommand extends core_1.Command {
         for (const stepName of out.stepsRan)
             this.log(`- ${chalk_1.default.dim(stepName)}`);
         this.log('');
-        const nonErrorMessages = out.messages.filter(m => m.type !== 'error');
+        const nonErrorMessages = out.messages.filter((m) => m.type !== 'error');
         if (nonErrorMessages.length > 0) {
             this.log('');
             this.log('The following messages were generated during execution:');
@@ -118,45 +119,53 @@ class BaseCommand extends core_1.Command {
         return new io_1.PromptsIO({}, [], this.flags['no-interaction'], errors_1.exit);
     }
     monorepoPaths(options) {
+        var _a, _b;
         try {
-            const monorepoConfig = (0, node_fs_1.readFileSync)((0, node_path_1.resolve)(process.cwd(), 'flarum-monorepo.json'));
-            const contents = JSON.parse(monorepoConfig.toString());
+            const monorepoConfig = (0, monorepo_1.getMonorepoConf)((0, mem_fs_1.create)(), new paths_1.NodePaths({ package: process.cwd() }));
             return [
-                ...(options.includeCore ? [contents.packages.core] : []),
-                ...(options.includeExtensions ? contents.packages.extensions : []),
-                ...(options.includePhpPackages ? contents.packages.composerPackages : []),
-                ...(options.includeJSPackages ? contents.packages.npmPackages : []),
+                ...(options.includeCore && monorepoConfig.packages.core ? [(0, monorepo_1.corePath)(monorepoConfig.packages.core.name)] : []),
+                ...(options.includeExtensions ? monorepoConfig.packages.extensions : []).map((ext) => (0, monorepo_1.extensionPath)(ext.name)),
+                ...(options.includePhpPackages ? (_a = monorepoConfig.packages.composer) !== null && _a !== void 0 ? _a : [] : []).map((lib) => (0, monorepo_1.composerPath)(lib.name)),
+                ...(options.includeJSPackages ? (_b = monorepoConfig.packages.npm) !== null && _b !== void 0 ? _b : [] : []).map((lib) => (0, monorepo_1.npmPath)(lib.name)),
             ];
         }
-        catch (_a) {
+        catch (_c) {
             this.error('Could not run monorepo command: `flarum-monorepo.json` file is missing or invalid.');
         }
     }
+    isFlarumMonorepo(path) {
+        return (0, fs_1.existsSync)((0, path_1.resolve)(path, 'flarum-monorepo.json'));
+    }
     isFlarumCore(path) {
         try {
-            const composerJsonPath = (0, node_path_1.resolve)(path, 'composer.json');
-            const val = JSON.parse((0, node_fs_1.readFileSync)(composerJsonPath, 'utf8'));
+            const composerJsonPath = (0, path_1.resolve)(path, 'composer.json');
+            const val = JSON.parse((0, fs_1.readFileSync)(composerJsonPath, 'utf8'));
             return val.name === 'flarum/core';
         }
         catch (_a) {
             return false;
         }
     }
+    jsPackageManager(currDir) {
+        if (!(0, fs_1.existsSync)((0, path_1.resolve)(currDir, 'js')))
+            return null;
+        return (0, fs_1.existsSync)((0, path_1.resolve)(currDir, 'js/yarn.lock')) ? 'yarn' : 'npm';
+    }
     async getFlarumExtensionRoot(currDir) {
-        let currPath = (0, node_path_1.resolve)(currDir);
+        let currPath = (0, path_1.resolve)(currDir);
         while (currPath !== '/') {
-            if ((0, node_fs_1.existsSync)((0, node_path_1.resolve)(currPath, 'flarum-monorepo.json'))) {
+            if ((0, fs_1.existsSync)((0, path_1.resolve)(currPath, 'flarum-monorepo.json'))) {
                 return { path: currPath, type: LocationType.FLARUM_MONOREPO };
             }
-            if ((0, node_fs_1.existsSync)((0, node_path_1.resolve)(currPath, 'composer.json')) && (0, node_fs_1.existsSync)((0, node_path_1.resolve)(currPath, 'extend.php'))) {
+            if ((0, fs_1.existsSync)((0, path_1.resolve)(currPath, 'composer.json')) && (0, fs_1.existsSync)((0, path_1.resolve)(currPath, 'extend.php'))) {
                 return { path: currPath, type: LocationType.FLARUM_EXTENSION };
             }
             if (this.isFlarumCore(currPath)) {
                 return { path: currPath, type: LocationType.FLARUM_CORE };
             }
-            currPath = (0, node_path_1.resolve)(currPath, '..');
+            currPath = (0, path_1.resolve)(currPath, '..');
         }
-        this.error(`${(0, node_path_1.resolve)(currDir)} is not located in a valid Flarum package!
+        this.error(`${(0, path_1.resolve)(currDir)} is not located in a valid Flarum package!
 - Flarum extensions must contain (at a minimum) 'extend.php' and 'composer.json' files.
 - Flarum core must contain a 'composer.json' file with the name 'flarum/core'.
 - Flarum monorepos must have a valid 'flarum-monorepo.json' file`);
@@ -165,14 +174,14 @@ class BaseCommand extends core_1.Command {
         const verify = await this.genIO().getParam({
             name: 'verify',
             type: 'confirm',
-            message: `Work in Flarum package located at ${(0, node_path_1.resolve)(extRoot)}?`,
+            message: `Work in Flarum package located at ${(0, path_1.resolve)(extRoot)}?`,
             initial: true,
         });
         if (!verify)
             this.exit();
     }
     async ensureComposerInstallRan(extRoot) {
-        if ((0, node_fs_1.existsSync)((0, node_path_1.resolve)(extRoot, 'vendor/flarum/core/composer.json')))
+        if ((0, fs_1.existsSync)((0, path_1.resolve)(extRoot, 'vendor/flarum/core/composer.json')))
             return;
         this.log("This command requires `composer install` to have been ran in your extension's root directory.");
         const composer = await this.genIO().getParam({
@@ -183,7 +192,7 @@ class BaseCommand extends core_1.Command {
         });
         if (composer) {
             cli_ux_1.default.action.start('Installing composer packages');
-            (0, node_child_process_1.execSync)('composer install', { cwd: extRoot });
+            (0, child_process_1.execSync)('composer install', { cwd: extRoot });
             cli_ux_1.default.action.stop();
         }
         else {
@@ -197,7 +206,7 @@ class BaseCommand extends core_1.Command {
      */
     async confirmOverrideFiles(dir, pattern, confirmationMessage) {
         const paths = Array.isArray(pattern) ? pattern : [pattern];
-        const files = await (0, globby_1.default)(paths.map(p => (0, node_path_1.resolve)(dir, p)));
+        const files = await (0, globby_1.default)(paths.map((p) => (0, path_1.resolve)(dir, p)));
         const empty = files.length === 0 || (files.length === 1 && files[0] === '.git');
         if (empty)
             return false;
@@ -212,13 +221,17 @@ class BaseCommand extends core_1.Command {
         return true;
     }
     async deleteFiles(dir, pattern) {
-        const pathsToDelete = await (0, globby_1.default)((0, node_path_1.resolve)(dir, pattern));
-        pathsToDelete.forEach(node_fs_1.unlinkSync);
+        const pathsToDelete = await (0, globby_1.default)((0, path_1.resolve)(dir, pattern));
+        pathsToDelete.forEach(fs_1.unlinkSync);
     }
 }
 exports.default = BaseCommand;
 BaseCommand.flags = {
-    'no-interaction': core_1.Flags.boolean({ char: 'n', description: 'Do not ask any interactive questions, assume defaults. When impossible, error.', default: false }),
+    'no-interaction': core_1.Flags.boolean({
+        char: 'n',
+        description: 'Do not ask any interactive questions, assume defaults. When impossible, error.',
+        default: false,
+    }),
     help: core_1.Flags.help({ char: 'h' }),
 };
 BaseCommand.args = [

package/lib/boilersmith/io.d.ts

@@ -1,6 +1,11 @@
-import { PromptObject } from 'prompts';
+import { PromptObject, PromptType } from 'prompts';
+declare type BooleanPromptType = PromptType & ('confirm' | 'toggle');
+declare type StringPromptType = PromptType & ('text' | 'password' | 'invisible' | 'autocomplete');
+declare type DatePromptType = PromptType & 'date';
+declare type ListPromptType = PromptType & 'list';
 export declare type ParamDef<N extends string = string> = Omit<PromptObject<N>, 'name'> & {
     name: N;
+    message: string;
 };
 export declare type Message = {
     type: 'info' | 'warning' | 'error';
@@ -11,7 +16,19 @@ export interface IO {
     /**
      * Prompt the user for some input data.
      */
-    getParam<T>(param: ParamDef): Promise<T>;
+    getParam(param: ParamDef & {
+        type: BooleanPromptType;
+    }, noCache?: boolean): Promise<boolean>;
+    getParam(param: ParamDef & {
+        type: StringPromptType;
+    }, noCache?: boolean): Promise<string>;
+    getParam(param: ParamDef & {
+        type: DatePromptType;
+    }, noCache?: boolean): Promise<Date>;
+    getParam(param: ParamDef & {
+        type: ListPromptType;
+    }, noCache?: boolean): Promise<string[]>;
+    getParam<T>(param: ParamDef, noCache?: boolean): Promise<T>;
     /**
      * Check if some data has already been prompted for.
      */
@@ -32,13 +49,16 @@ export interface IO {
 declare type OnCancel = () => void;
 export declare class PromptsIO implements IO {
     supportsAnsiColor: boolean;
-    private cache;
-    private messages;
-    private noInteraction;
-    private onCancel?;
-    private prev?;
+    protected cache: Map<string, unknown>;
+    protected messages: Message[];
+    protected noInteraction: boolean;
+    protected onCancel?: OnCancel;
+    protected prev?: {
+        val: any;
+        prompt: ParamDef;
+    };
     constructor(initial?: Record<string, unknown>, messages?: Message[], noInteraction?: boolean, onCancel?: OnCancel);
-    getParam<T>(paramDef: ParamDef): Promise<T>;
+    getParam<T>(paramDef: ParamDef, noCache?: boolean): Promise<T>;
     hasCached(name: string): boolean;
     /**
      * @internal

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
      */
@@ -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;
+};
+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;
@@ -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,7 +73,13 @@ 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> = {
@@ -69,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;
         }
@@ -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,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(', ')}".`);
     }
@@ -88,24 +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 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);
     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);
+}