simple-scaffold 2.3.3 → 3.1.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">
 
@@ -45,6 +40,21 @@ See full documentation [here](https://chenasraf.github.io/simple-scaffold).
 
 ## Getting Started
 
+### Quick Start
+
+The fastest way to get started is to run `init` in your project directory:
+
+```sh
+npx simple-scaffold init
+```
+
+This creates a `scaffold.config.js` and an example template in `templates/default/`. Then generate
+files with:
+
+```sh
+npx simple-scaffold MyProject
+```
+
 ### Cheat Sheet
 
 A quick rundown of common usage scenarios:
@@ -100,9 +110,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 +161,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"];