simple-scaffold 2.3.3 → 3.0.0

package/README.md

@@ -13,17 +13,12 @@
 
 </h2>
 
-Looking to streamline your workflow and get your projects up and running quickly? Look no further
-than Simple Scaffold - the easy-to-use NPM package that simplifies the process of organizing and
-copying your commonly-created files.
+Simple Scaffold is a file scaffolding tool. You define templates once, then generate files from them
+whenever you need — whether it's a single component or an entire app boilerplate.
 
-With its agnostic and un-opinionated approach, Simple Scaffold can handle anything from a few simple
-files to an entire app boilerplate setup. Plus, with the power of **Handlebars.js** syntax, you can
-easily replace custom data and personalize your files to fit your exact needs. But that's not all -
-you can also use it to loop through data, use conditions, and write custom functions using helpers.
-
-Don't waste any more time manually copying and pasting files - let Simple Scaffold do the heavy
-lifting for you and start building your projects faster and more efficiently today!
+Templates use **Handlebars.js** syntax, so you can inject data, loop over lists, use conditionals,
+and write custom helpers. It works as a CLI or as a Node.js library, and it doesn't care what kind
+of files you're generating.
 
 <div align="center">
 
@@ -100,9 +95,40 @@ See information about each option and flag using the `--help` flag, or read the
 [CLI documentation](https://chenasraf.github.io/simple-scaffold/docs/usage/cli). For information
 about how configuration files work, [see below](#configuration-files).
 
+### Interactive Mode
+
+When running in a terminal, Simple Scaffold will interactively prompt for any missing required
+values — name, output directory, template paths, and template key (if multiple are available).
+
+Config files can also define **inputs** — custom fields that are prompted interactively and become
+template data:
+
+```js
+module.exports = {
+  component: {
+    templates: ["templates/component"],
+    output: "src/components",
+    inputs: {
+      author: { message: "Author name", required: true },
+      license: { message: "License", default: "MIT" },
+    },
+  },
+}
+```
+
+Inputs can be pre-provided via `--data` or `-D` to skip the prompt:
+
+```sh
+npx simple-scaffold -c scaffold.config.js -k component -D author=John MyComponent
+```
+
 ### Configuration Files
 
-You can use a config file to more easily maintain all your scaffold definitions.
+You can use a config file to more easily maintain all your scaffold definitions. Simple Scaffold
+**auto-detects** config files in the current directory — no `--config` flag needed.
+
+It searches for these files in order: `scaffold.config.{mjs,cjs,js,json}`,
+`scaffold.{mjs,cjs,js,json}`, `.scaffold.{mjs,cjs,js,json}`.
 
 `scaffold.config.js`
 
@@ -120,10 +146,11 @@ module.exports = {
 }
 ```
 
-Then call your scaffold like this:
+Then just run from the same directory:
 
 ```sh
-$ npx simple-scaffold -c scaffold.config.js PageWrapper
+$ npx simple-scaffold PageWrapper
+# or explicitly: npx simple-scaffold -c scaffold.config.js PageWrapper
 ```
 
 This will allow you to avoid needing to remember which configs are needed or to store them in a

package/before-write.d.ts

@@ -0,0 +1,7 @@
+import { LogConfig, ScaffoldConfig } from "./types";
+/**
+ * Wraps a CLI beforeWrite command string into a beforeWrite callback function.
+ * The command receives the processed content via a temp file and can return modified content via stdout.
+ * @internal
+ */
+export declare function wrapBeforeWrite(config: LogConfig & Pick<ScaffoldConfig, "dryRun">, beforeWrite: string): ScaffoldConfig["beforeWrite"];

package/cmd.js

@@ -1,265 +1,219 @@
 #!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCliArgs = parseCliArgs;
-const node_path_1 = __importDefault(require("node:path"));
-const promises_1 = __importDefault(require("node:fs/promises"));
-const massarg_1 = require("massarg");
-const types_1 = require("./types");
-const scaffold_1 = require("./scaffold");
-const config_1 = require("./config");
-const logger_1 = require("./logger");
-const command_1 = require("massarg/command");
-const file_1 = require("./file");
-const utils_1 = require("./utils");
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_scaffold = require("./scaffold-Ce-rIwy9.js");
+let node_path = require("node:path");
+node_path = require_scaffold.__toESM(node_path);
+let node_fs_promises = require("node:fs/promises");
+node_fs_promises = require_scaffold.__toESM(node_fs_promises);
+let massarg = require("massarg");
+let massarg_command = require("massarg/command");
+//#region src/cmd.ts
 async function parseCliArgs(args = process.argv.slice(2)) {
-    const isProjectRoot = Boolean(await promises_1.default.stat(node_path_1.default.join(__dirname, "package.json")).catch(() => false));
-    const pkgFile = await promises_1.default.readFile(node_path_1.default.resolve(__dirname, isProjectRoot ? "." : "..", "package.json"));
-    const pkg = JSON.parse(pkgFile.toString());
-    const isVersionFlag = args.includes("--version") || args.includes("-v");
-    const isConfigFileProvided = args.includes("--config") || args.includes("-c");
-    const isGitProvided = args.includes("--git") || args.includes("-g");
-    const isConfigProvided = isConfigFileProvided || isGitProvided || isVersionFlag;
-    return (0, massarg_1.massarg)({
-        name: pkg.name,
-        description: pkg.description,
-    })
-        .main(async (config) => {
-        if (config.version) {
-            console.log(pkg.version);
-            return;
-        }
-        (0, logger_1.log)(config, types_1.LogLevel.info, `Simple Scaffold v${pkg.version}`);
-        config.tmpDir = (0, file_1.getUniqueTmpPath)();
-        try {
-            (0, logger_1.log)(config, types_1.LogLevel.debug, "Parsing config file...", config);
-            const parsed = await (0, config_1.parseConfigFile)(config);
-            await (0, scaffold_1.Scaffold)(parsed);
-        }
-        catch (e) {
-            const message = "message" in e ? e.message : e?.toString();
-            (0, logger_1.log)(config, types_1.LogLevel.error, message);
-        }
-        finally {
-            (0, logger_1.log)(config, types_1.LogLevel.debug, "Cleaning up temporary files...", config.tmpDir);
-            await promises_1.default.rm(config.tmpDir, { recursive: true, force: true });
-        }
-    })
-        .option({
-        name: "name",
-        aliases: ["n"],
-        description: "Name to be passed to the generated files. `{{name}}` and other data parameters inside " +
-            "contents and file names will be replaced accordingly. You may omit the `--name` or `-n` " +
-            "for this specific option.",
-        isDefault: true,
-        required: !isConfigProvided,
-    })
-        .option({
-        name: "config",
-        aliases: ["c"],
-        description: "Filename or directory to load config from",
-    })
-        .option({
-        name: "git",
-        aliases: ["g"],
-        description: "Git URL or GitHub path to load a template from.",
-    })
-        .option({
-        name: "key",
-        aliases: ["k"],
-        description: "Key to load inside the config file. This overwrites the config key provided after the colon in `--config` " +
-            "(e.g. `--config scaffold.cmd.js:component)`",
-    })
-        .option({
-        name: "output",
-        aliases: ["o"],
-        description: "Path to output to. If `--subdir` is enabled, the subdir will be created inside " +
-            "this path. Default is current working directory.",
-        required: !isConfigProvided,
-    })
-        .option({
-        name: "templates",
-        aliases: ["t"],
-        array: true,
-        description: "Template files to use as input. You may provide multiple files, each of which can be a relative or " +
-            "absolute path, " +
-            "or a glob pattern for multiple file matching easily.",
-        required: !isConfigProvided,
-    })
-        .flag({
-        name: "overwrite",
-        aliases: ["w"],
-        defaultValue: false,
-        description: "Enable to override output files, even if they already exist.",
-        negatable: true,
-    })
-        .option({
-        name: "data",
-        aliases: ["d"],
-        description: "Add custom data to the templates. By default, only your app name is included.",
-        parse: (v) => JSON.parse(v),
-    })
-        .option({
-        name: "append-data",
-        aliases: ["D"],
-        description: "Append additional custom data to the templates, which will overwrite `--data`, using an alternate syntax, " +
-            "which is easier to use with CLI: `-D key1=string -D key2:=raw`",
-        parse: config_1.parseAppendData,
-    })
-        .flag({
-        name: "subdir",
-        aliases: ["s"],
-        defaultValue: false,
-        description: "Create a parent directory with the input name (and possibly `--subdir-helper`",
-        negatable: true,
-        negationName: "no-subdir",
-    })
-        .option({
-        name: "subdir-helper",
-        aliases: ["H"],
-        description: "Default helper to apply to subdir name when using `--subdir`.",
-    })
-        .flag({
-        name: "quiet",
-        aliases: ["q"],
-        defaultValue: false,
-        description: "Suppress output logs (Same as `--log-level none`)",
-    })
-        .option({
-        name: "log-level",
-        aliases: ["l"],
-        defaultValue: types_1.LogLevel.info,
-        description: "Determine amount of logs to display. The values are: " +
-            `${utils_1.colorize.bold `\`none | debug | info | warn | error\``}. ` +
-            "The provided level will display messages of the same level or higher.",
-        parse: (v) => {
-            const val = v.toLowerCase();
-            if (!(val in types_1.LogLevel)) {
-                throw new Error(`Invalid log level: ${val}, must be one of: ${Object.keys(types_1.LogLevel).join(", ")}`);
-            }
-            return val;
-        },
-    })
-        .option({
-        name: "before-write",
-        aliases: ["B"],
-        description: "Run a script before writing the files. This can be a command or a path to a" +
-            " file. A temporary file path will be passed to the given command and the command should " +
-            "return a string for the final output.",
-    })
-        .flag({
-        name: "dry-run",
-        aliases: ["dr"],
-        defaultValue: false,
-        description: "Don't emit files. This is good for testing your scaffolds and making sure they " +
-            "don't fail, without having to write actual file contents or create directories.",
-    })
-        .flag({
-        name: "version",
-        aliases: ["v"],
-        description: "Display version.",
-    })
-        .command(new command_1.MassargCommand({
-        name: "list",
-        aliases: ["ls"],
-        description: "List all available templates for a given config. See `list -h` for more information.",
-        run: async (_config) => {
-            const config = {
-                templates: [],
-                name: "",
-                version: false,
-                output: "",
-                subdir: false,
-                overwrite: false,
-                dryRun: false,
-                tmpDir: (0, file_1.getUniqueTmpPath)(),
-                ..._config,
-                config: _config.config ?? (!_config.git ? process.cwd() : undefined),
-            };
-            try {
-                const file = await (0, config_1.getConfigFile)(config);
-                console.log(utils_1.colorize.underline `Available templates:\n`);
-                console.log(Object.keys(file).join("\n"));
-            }
-            catch (e) {
-                const message = "message" in e ? e.message : e?.toString();
-                (0, logger_1.log)(config, types_1.LogLevel.error, message);
-            }
-            finally {
-                (0, logger_1.log)(config, types_1.LogLevel.debug, "Cleaning up temporary files...", config.tmpDir);
-                await promises_1.default.rm(config.tmpDir, { recursive: true, force: true });
-            }
-        },
-    })
-        .option({
-        name: "config",
-        aliases: ["c"],
-        description: "Filename or directory to load config from. Defaults to current working directory.",
-    })
-        .option({
-        name: "git",
-        aliases: ["g"],
-        description: "Git URL or GitHub path to load a template from.",
-    })
-        .option({
-        name: "log-level",
-        aliases: ["l"],
-        defaultValue: types_1.LogLevel.none,
-        description: "Determine amount of logs to display. The values are: " +
-            `${utils_1.colorize.bold `\`none | debug | info | warn | error\``}. ` +
-            "The provided level will display messages of the same level or higher.",
-        parse: (v) => {
-            const val = v.toLowerCase();
-            if (!(val in types_1.LogLevel)) {
-                throw new Error(`Invalid log level: ${val}, must be one of: ${Object.keys(types_1.LogLevel).join(", ")}`);
-            }
-            return val;
-        },
-    })
-        .help({
-        bindOption: true,
-    }))
-        .example({
-        description: "Usage with config file",
-        input: "simple-scaffold -c scaffold.cmd.js --key component",
-    })
-        .example({
-        description: "Usage with GitHub config file",
-        input: "simple-scaffold -g chenasraf/simple-scaffold --key component",
-    })
-        .example({
-        description: "Usage with https git URL (for non-GitHub)",
-        input: "simple-scaffold -g https://example.com/user/template.git -c scaffold.cmd.js --key component",
-    })
-        .example({
-        description: "Excluded template key, assumes 'default' key",
-        input: "simple-scaffold -c scaffold.cmd.js MyComponent",
-    })
-        .example({
-        description: "Shortest syntax for GitHub, searches for config file automaticlly, assumes and template key 'default'",
-        input: "simple-scaffold -g chenasraf/simple-scaffold MyComponent",
-    })
-        .help({
-        bindOption: true,
-        lineLength: 100,
-        useGlobalTableColumns: true,
-        usageText: [utils_1.colorize.yellow `simple-scaffold`, utils_1.colorize.gray `[options]`, utils_1.colorize.cyan `<name>`].join(" "),
-        optionOptions: {
-            displayNegations: true,
-        },
-        footerText: [
-            `Version:  ${pkg.version}`,
-            `Copyright © Chen Asraf 2017-${new Date().getFullYear()}`,
-            ``,
-            `Documentation:  ${utils_1.colorize.underline `https://chenasraf.github.io/simple-scaffold`}`,
-            `NPM:  ${utils_1.colorize.underline `https://npmjs.com/package/simple-scaffold`}`,
-            `GitHub:  ${utils_1.colorize.underline `https://github.com/chenasraf/simple-scaffold`}`,
-        ].join("\n"),
-    })
-        .parse(args);
+	const isProjectRoot = Boolean(await node_fs_promises.default.stat(node_path.default.join(__dirname, "package.json")).catch(() => false));
+	const pkgFile = await node_fs_promises.default.readFile(node_path.default.resolve(__dirname, isProjectRoot ? "." : "..", "package.json"));
+	const pkg = JSON.parse(pkgFile.toString());
+	args.includes("--version") || args.includes("-v");
+	args.includes("--config") || args.includes("-c");
+	args.includes("--git") || args.includes("-g");
+	return (0, massarg.massarg)({
+		name: pkg.name,
+		description: pkg.description
+	}).main(async (config) => {
+		if (config.version) {
+			console.log(pkg.version);
+			return;
+		}
+		require_scaffold.log(config, require_scaffold.LogLevel.info, `Simple Scaffold v${pkg.version}`);
+		config.tmpDir = require_scaffold.getUniqueTmpPath();
+		try {
+			if (!config.config && !config.git) try {
+				config.config = await require_scaffold.findConfigFile(process.cwd());
+				require_scaffold.log(config, require_scaffold.LogLevel.debug, `Auto-detected config file: ${config.config}`);
+			} catch {}
+			const hasConfigSource = Boolean(config.config || config.git);
+			let configMap;
+			if (hasConfigSource) configMap = await require_scaffold.getConfigFile(config);
+			config = await require_scaffold.promptForMissingConfig(config, configMap);
+			require_scaffold.log(config, require_scaffold.LogLevel.debug, "Parsing config file...", config);
+			await require_scaffold.Scaffold(await require_scaffold.resolveInputs(await require_scaffold.parseConfigFile(config)));
+		} catch (e) {
+			const message = "message" in e ? e.message : e?.toString();
+			require_scaffold.log(config, require_scaffold.LogLevel.error, message);
+		} finally {
+			require_scaffold.log(config, require_scaffold.LogLevel.debug, "Cleaning up temporary files...", config.tmpDir);
+			if (config.tmpDir) await node_fs_promises.default.rm(config.tmpDir, {
+				recursive: true,
+				force: true
+			});
+		}
+	}).option({
+		name: "name",
+		aliases: ["n"],
+		description: "Name to be passed to the generated files. `{{name}}` and other data parameters inside contents and file names will be replaced accordingly. You may omit the `--name` or `-n` for this specific option. If omitted in an interactive terminal, you will be prompted.",
+		isDefault: true
+	}).option({
+		name: "config",
+		aliases: ["c"],
+		description: "Filename or directory to load config from"
+	}).option({
+		name: "git",
+		aliases: ["g"],
+		description: "Git URL or GitHub path to load a template from."
+	}).option({
+		name: "key",
+		aliases: ["k"],
+		description: "Key to load inside the config file. This overwrites the config key provided after the colon in `--config` (e.g. `--config scaffold.cmd.js:component)`. If omitted and multiple templates are available, you will be prompted to select one."
+	}).option({
+		name: "output",
+		aliases: ["o"],
+		description: "Path to output to. If `--subdir` is enabled, the subdir will be created inside this path. If omitted in an interactive terminal, you will be prompted."
+	}).option({
+		name: "templates",
+		aliases: ["t"],
+		array: true,
+		description: "Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path, or a glob pattern for multiple file matching easily. If omitted in an interactive terminal, you will be prompted for a comma-separated list."
+	}).flag({
+		name: "overwrite",
+		aliases: ["w"],
+		defaultValue: false,
+		description: "Enable to override output files, even if they already exist.",
+		negatable: true
+	}).option({
+		name: "data",
+		aliases: ["d"],
+		description: "Add custom data to the templates. By default, only your app name is included.",
+		parse: (v) => JSON.parse(v)
+	}).option({
+		name: "append-data",
+		aliases: ["D"],
+		description: "Append additional custom data to the templates, which will overwrite `--data`, using an alternate syntax, which is easier to use with CLI: `-D key1=string -D key2:=raw`",
+		parse: require_scaffold.parseAppendData
+	}).flag({
+		name: "subdir",
+		aliases: ["s"],
+		defaultValue: false,
+		description: "Create a parent directory with the input name (and possibly `--subdir-helper`",
+		negatable: true,
+		negationName: "no-subdir"
+	}).option({
+		name: "subdir-helper",
+		aliases: ["H"],
+		description: "Default helper to apply to subdir name when using `--subdir`."
+	}).flag({
+		name: "quiet",
+		aliases: ["q"],
+		defaultValue: false,
+		description: "Suppress output logs (Same as `--log-level none`)"
+	}).option({
+		name: "log-level",
+		aliases: ["l"],
+		defaultValue: require_scaffold.LogLevel.info,
+		description: `Determine amount of logs to display. The values are: ${require_scaffold.colorize.bold`\`none | debug | info | warn | error\``}. The provided level will display messages of the same level or higher.`,
+		parse: (v) => {
+			const val = v.toLowerCase();
+			if (!(val in require_scaffold.LogLevel)) throw new Error(`Invalid log level: ${val}, must be one of: ${Object.keys(require_scaffold.LogLevel).join(", ")}`);
+			return val;
+		}
+	}).option({
+		name: "before-write",
+		aliases: ["B"],
+		description: "Run a script before writing the files. This can be a command or a path to a file. A temporary file path will be passed to the given command and the command should return a string for the final output."
+	}).flag({
+		name: "dry-run",
+		aliases: ["dr"],
+		defaultValue: false,
+		description: "Don't emit files. This is good for testing your scaffolds and making sure they don't fail, without having to write actual file contents or create directories."
+	}).flag({
+		name: "version",
+		aliases: ["v"],
+		description: "Display version."
+	}).command(new massarg_command.MassargCommand({
+		name: "list",
+		aliases: ["ls"],
+		description: "List all available templates for a given config. See `list -h` for more information.",
+		run: async (_config) => {
+			const config = {
+				templates: [],
+				name: "",
+				version: false,
+				output: "",
+				subdir: false,
+				overwrite: false,
+				dryRun: false,
+				tmpDir: require_scaffold.getUniqueTmpPath(),
+				..._config,
+				config: _config.config ?? (!_config.git ? process.cwd() : void 0)
+			};
+			try {
+				const file = await require_scaffold.getConfigFile(config);
+				console.log(require_scaffold.colorize.underline`Available templates:\n`);
+				console.log(Object.keys(file).join("\n"));
+			} catch (e) {
+				const message = "message" in e ? e.message : e?.toString();
+				require_scaffold.log(config, require_scaffold.LogLevel.error, message);
+			} finally {
+				require_scaffold.log(config, require_scaffold.LogLevel.debug, "Cleaning up temporary files...", config.tmpDir);
+				if (config.tmpDir) await node_fs_promises.default.rm(config.tmpDir, {
+					recursive: true,
+					force: true
+				});
+			}
+		}
+	}).option({
+		name: "config",
+		aliases: ["c"],
+		description: "Filename or directory to load config from. Defaults to current working directory."
+	}).option({
+		name: "git",
+		aliases: ["g"],
+		description: "Git URL or GitHub path to load a template from."
+	}).option({
+		name: "log-level",
+		aliases: ["l"],
+		defaultValue: require_scaffold.LogLevel.none,
+		description: `Determine amount of logs to display. The values are: ${require_scaffold.colorize.bold`\`none | debug | info | warn | error\``}. The provided level will display messages of the same level or higher.`,
+		parse: (v) => {
+			const val = v.toLowerCase();
+			if (!(val in require_scaffold.LogLevel)) throw new Error(`Invalid log level: ${val}, must be one of: ${Object.keys(require_scaffold.LogLevel).join(", ")}`);
+			return val;
+		}
+	}).help({ bindOption: true })).example({
+		description: "Usage with config file",
+		input: "simple-scaffold -c scaffold.cmd.js --key component"
+	}).example({
+		description: "Usage with GitHub config file",
+		input: "simple-scaffold -g chenasraf/simple-scaffold --key component"
+	}).example({
+		description: "Usage with https git URL (for non-GitHub)",
+		input: "simple-scaffold -g https://example.com/user/template.git -c scaffold.cmd.js --key component"
+	}).example({
+		description: "Excluded template key, assumes 'default' key",
+		input: "simple-scaffold -c scaffold.cmd.js MyComponent"
+	}).example({
+		description: "Shortest syntax for GitHub, searches for config file automaticlly, assumes and template key 'default'",
+		input: "simple-scaffold -g chenasraf/simple-scaffold MyComponent"
+	}).help({
+		bindOption: true,
+		lineLength: 100,
+		useGlobalTableColumns: true,
+		usageText: [
+			require_scaffold.colorize.yellow`simple-scaffold`,
+			require_scaffold.colorize.gray`[options]`,
+			require_scaffold.colorize.cyan`<name>`
+		].join(" "),
+		optionOptions: { displayNegations: true },
+		footerText: [
+			`Version:  ${pkg.version}`,
+			`Copyright © Chen Asraf 2017-${(/* @__PURE__ */ new Date()).getFullYear()}`,
+			``,
+			`Documentation:  ${require_scaffold.colorize.underline`https://chenasraf.github.io/simple-scaffold`}`,
+			`NPM:  ${require_scaffold.colorize.underline`https://npmjs.com/package/simple-scaffold`}`,
+			`GitHub:  ${require_scaffold.colorize.underline`https://github.com/chenasraf/simple-scaffold`}`
+		].join("\n")
+	}).parse(args);
 }
 parseCliArgs();
+//#endregion
+exports.parseCliArgs = parseCliArgs;
+
 //# sourceMappingURL=cmd.js.map