chore(release): 2.2.2 [skip ci]

## [2.2.2](https://github.com/chenasraf/simple-scaffold/compare/v2.2.1...v2.2.2) (2024-08-27)

### Bug Fixes

* homepage url ([daaefaf](daaefaf54e))

.github/workflows/docs.yml

@@ -1,5 +1,8 @@
 name: Documentation
 
+permissions:
+  contents: write
+
 on:
   push:
     branches: [master, pre, develop]

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## [2.2.2](https://github.com/chenasraf/simple-scaffold/compare/v2.2.1...v2.2.2) (2024-08-27)
+
+
+### Bug Fixes
+
+* homepage url ([daaefaf](https://github.com/chenasraf/simple-scaffold/commit/daaefaf54e8c8887e6f210d02fd5f96c6ff4aa21))
+
+## [2.2.1](https://github.com/chenasraf/simple-scaffold/compare/v2.2.0...v2.2.1) (2024-04-21)
+
+
+### Bug Fixes
+
+* beforeWrite from config files ([98b326c](https://github.com/chenasraf/simple-scaffold/commit/98b326c84346162f379af46bc5aefb69df8be515))
+* use console.info for handlebars parse warning ([19e7b0f](https://github.com/chenasraf/simple-scaffold/commit/19e7b0f0c35c1b79a98781bdec9f54354123d8e0))
+
 # [2.2.0](https://github.com/chenasraf/simple-scaffold/compare/v2.1.0...v2.2.0) (2024-02-23)
 
 

docs/docs/usage/03-cli.md

@@ -11,25 +11,26 @@ Usage: simple-scaffold [options]
 To see this and more information anytime, add the `-h` or `--help` flag to your call, e.g.
 `npx simple-scaffold@latest -h`.
 
-| Command \| alias                    |                                                                                                                                                                                                          |
-| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--name` \| `-n`                    | 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.  |
-| `--config`\|`-c`                    | Filename or directory to load config from                                                                                                                                                                |
-| `--git`\|`-g`                       | Git URL or GitHub path to load a template from.                                                                                                                                                          |
-| `--key` \| `-k`                     | 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`)                                                    |
-| `--output` \| `-o`                  | Path to output to. If `--create-sub-folder` is enabled, the subfolder will be created inside this path. Default is current working directory.                                                            |
-| `--templates` \| `-t`               | 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.                                   |
-| `--overwrite` \| `-w`               | Enable to override output files, even if they already exist.                                                                                                                                             |
-| `--data` \| `-d`                    | Add custom data to the templates. By default, only your app name is included.                                                                                                                            |
-| `--append-data` \| `-D`             | 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`                                 |
-| `--create-sub-folder` \| `-s`       | Create subfolder with the input name                                                                                                                                                                     |
-| `--sub-folder-name-helper` \| `-sh` | Default helper to apply to subfolder name when using `--create-sub-folder true`.                                                                                                                         |
-| `--quiet` \| `-q`                   | Suppress output logs (Same as `--log-level none`)                                                                                                                                                        |
-| `--log-level` \| `-l`               | Determine amount of logs to display. The values are: `none \| debug \| info \| warn \| error`. The provided level will display messages of the same level or higher.                                     |
-| `--before-write` \| `-B`            | 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. |
-| `--dry-run` \| `-dr`                | 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.                                           |
-| `--help` \| `-h`                    | Show this help message                                                                                                                                                                                   |
-| `--version` \| `-v`                 | Display version.                                                                                                                                                                                         |
+Options:
+
+| Option/flag \| Alias                              | Description                                                                                                                                                                                              |
+| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--name` \| `-n`                                  | 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.  |
+| `--config` \| `-c`                                | Filename or directory to load config from                                                                                                                                                                |
+| `--git` \| `-g`                                   | Git URL or GitHub path to load a template from.                                                                                                                                                          |
+| `--key` \| `-k`                                   | 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)`                                                    |
+| `--output` \| `-o`                                | Path to output to. If `--subdir` is enabled, the subdir will be created inside this path. Default is current working directory.                                                                          |
+| `--templates` \| `-t`                             | 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.                                   |
+| `--overwrite` \| `-w` \| `--no-overwrite` \| `-W` | Enable to override output files, even if they already exist. (default: false)                                                                                                                            |
+| `--data` \| `-d`                                  | Add custom data to the templates. By default, only your app name is included.                                                                                                                            |
+| `--append-data` \| `-D`                           | 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`                                 |
+| `--subdir` \| `-s` \| `--no-subdir` \| `-S`       | Create a parent directory with the input name (and possibly `--subdir-helper` (default: false)                                                                                                           |
+| `--subdir-helper` \| `-H`                         | Default helper to apply to subdir name when using `--subdir`.                                                                                                                                            |
+| `--quiet` \| `-q`                                 | Suppress output logs (Same as `--log-level none`)(default: false)                                                                                                                                        |
+| `--log-level` \| `-l`                             | Determine amount of logs to display. The values are: `none, debug, info, warn, error`. The provided level will display messages of the same level or higher. (default: info)                             |
+| `--before-write` \| `-B`                          | 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. |
+| `--dry-run` \| `-dr`                              | 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. (default: false)                          |
+| `--version` \| `-v`                               | Display version.                                                                                                                                                                                         |
 
 ### Before Write option
 
@@ -63,6 +64,12 @@ See
 Node.js API for more details. Instead of returning `undefined` to keep the default behavior, you can
 output `''` for the same effect.
 
+## Available Commands:
+
+| Command \| Alias | Description                                                                          |
+| ---------------- | ------------------------------------------------------------------------------------ |
+| `list` \| `ls`   | List all available templates for a given config. See `list -h` for more information. |
+
 ## Examples:
 
 > See

docs/docs/usage/04-node.md

@@ -19,14 +19,14 @@ interface ScaffoldConfig {
   name: string
   templates: string[]
   output: FileResponse<string>
-  createSubFolder?: boolean
+  subdir?: boolean
   data?: Record<string, any>
   overwrite?: FileResponse<boolean>
   quiet?: boolean
   verbose?: LogLevel
   dryRun?: boolean
   helpers?: Record<string, Helper>
-  subFolderNameHelper?: DefaultHelpers | string
+  subdirHelper?: DefaultHelpers | string
   beforeWrite?(
     content: Buffer,
     rawContent: Buffer,
@@ -57,17 +57,17 @@ const config = {
   name: "component",
   templates: [path.join(__dirname, "scaffolds", "component")],
   output: path.join(__dirname, "src", "components"),
-  createSubFolder: true,
-  subFolderNameHelper: "upperCase"
+  subdir: true,
+  subdirHelper: "upperCase",
   data: {
     property: "value",
   },
   helpers: {
-    twice: (text) => [text, text].join(" ")
+    twice: (text) => [text, text].join(" "),
   },
   // return a string to replace the final file contents after pre-processing, or `undefined`
   // to keep it as-is
-  beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase()
+  beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase(),
 }
 
 const scaffold = Scaffold(config)

package.json

@@ -1,8 +1,8 @@
 {
   "name": "simple-scaffold",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "Generate any file structure - from single components to entire app boilerplates, with a single command.",
-  "homepage": "https: //chenasraf.github.io/simple-scaffold",
+  "homepage": "https://chenasraf.github.io/simple-scaffold",
   "repository": {
     "type": "git",
     "url": "https://github.com/chenasraf/simple-scaffold.git"
@@ -13,7 +13,7 @@
   "bin": {
     "simple-scaffold": "cmd.js"
   },
-  "packageManager": "pnpm@8.15.1",
+  "packageManager": "pnpm@9.0.4",
   "keywords": [
     "javascript",
     "cli",
@@ -39,28 +39,28 @@
   },
   "dependencies": {
     "chalk": "^4.1.2",
-    "date-fns": "^3.3.1",
-    "glob": "^10.3.10",
+    "date-fns": "^3.6.0",
+    "glob": "^11.0.0",
     "handlebars": "^4.7.8",
-    "massarg": "2.0.0"
+    "massarg": "2.0.1"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/release-notes-generator": "^12.1.0",
+    "@semantic-release/release-notes-generator": "^14.0.1",
     "@types/jest": "^29.5.12",
     "@types/mock-fs": "^4.13.4",
-    "@types/node": "^20.11.17",
+    "@types/node": "^22.5.0",
     "@types/semantic-release": "^20.0.6",
-    "conventional-changelog": "^5.1.0",
-    "conventional-changelog-cli": "^4.1.0",
+    "conventional-changelog": "^6.0.0",
+    "conventional-changelog-cli": "^5.0.0",
     "jest": "^29.7.0",
     "mock-fs": "^5.2.0",
-    "semantic-release": "^23.0.2",
+    "semantic-release": "^24.1.0",
     "semantic-release-conventional-commits": "^3.0.0",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.5.4"
   }
 }

src/cmd.ts

@@ -74,7 +74,7 @@ export async function parseCliArgs(args = process.argv.slice(2)) {
       name: "output",
       aliases: ["o"],
       description:
-        "Path to output to. If `--subdir` is enabled, the subfolder will be created inside " +
+        "Path to output to. If `--subdir` is enabled, the subdir will be created inside " +
         "this path. Default is current working directory.",
       required: !isConfigProvided,
     })
@@ -120,7 +120,7 @@ export async function parseCliArgs(args = process.argv.slice(2)) {
     .option({
       name: "subdir-helper",
       aliases: ["H"],
-      description: "Default helper to apply to subfolder name when using `--subdir`.",
+      description: "Default helper to apply to subdir name when using `--subdir`.",
     })
     .flag({
       name: "quiet",

src/config.ts

@@ -111,7 +111,8 @@ export async function parseConfigFile(config: ScaffoldCmdConfig, tmpPath: string
   }
 
   output.data = { ...output.data, ...config.appendData }
-  output.beforeWrite = config.beforeWrite ? wrapBeforeWrite(config, config.beforeWrite) : undefined
+  const cmdBeforeWrite = config.beforeWrite ? wrapBeforeWrite(config, config.beforeWrite) : undefined
+  output.beforeWrite = cmdBeforeWrite ?? output.beforeWrite
 
   if (!output.name) {
     throw new Error("simple-scaffold: Missing required option: name")

src/parser.ts

@@ -121,7 +121,7 @@ export function handlebarsParse(
     return Buffer.from(outputContents)
   } catch (e) {
     log(config, LogLevel.debug, e)
-    log(config, LogLevel.warning, "Couldn't parse file with handlebars, returning original content")
+    log(config, LogLevel.info, "Couldn't parse file with handlebars, returning original content")
     return Buffer.from(templateBuffer)
   }
 }

src/types.ts

@@ -27,7 +27,7 @@ export interface ScaffoldConfig {
   templates: string[]
 
   /**
-   * Path to output to. If `subdir` is `true`, the subfolder will be created inside this path.
+   * Path to output to. If `subdir` is `true`, the subdir will be created inside this path.
    *
    * May also be a {@link FileResponseHandler} which returns a new output path to override the default one.
    *
@@ -37,7 +37,7 @@ export interface ScaffoldConfig {
   output: FileResponse<string>
 
   /**
-   * Whether to create subfolder with the input name.
+   * Whether to create subdir with the input name.
    *
    * When `true`, you may also use {@link subdirHelper} to determine a pre-process helper on
    * the directory name.
@@ -131,7 +131,7 @@ export interface ScaffoldConfig {
   helpers?: Record<string, Helper>
 
   /**
-   * Default transformer to apply to subfolder name when using `subdir: true`. Can be one of the default
+   * Default transformer to apply to subdir name when using `subdir: true`. Can be one of the default
    * capitalization helpers, or a custom one you provide to `helpers`. Defaults to `undefined`, which means no
    * transformation is done.
    *
@@ -165,7 +165,7 @@ export interface ScaffoldConfig {
 /**
  * The names of the available helper functions that relate to text capitalization.
  *
- * These are available for `subfolderNameHelper`.
+ * These are available for `subdirHelper`.
  *
  * | Helper name  | Example code            | Example output |
  * | ------------ | ----------------------- | -------------- |
@@ -340,9 +340,9 @@ export type ScaffoldCmdConfig = {
   templates: string[]
   /** The output path to write to */
   output: string
-  /** Whether to create subfolder with the input name */
+  /** Whether to create subdir with the input name */
   subdir: boolean
-  /** Default transformer to apply to subfolder name when using `subdir: true` */
+  /** Default transformer to apply to subdir name when using `subdir: true` */
   subdirHelper?: string
   /** Add custom data to the templates */
   data?: Record<string, string>

tests/scaffold.test.ts

@@ -92,7 +92,7 @@ function withMock(fileStruct: FileSystem.DirectoryItems, testFn: jest.EmptyFunct
 
 describe("Scaffold", () => {
   describe(
-    "create subfolder",
+    "create subdir",
     withMock(fileStructNormal, () => {
       test("should not create by default", async () => {
         await Scaffold({
@@ -395,7 +395,7 @@ describe("Scaffold", () => {
     }),
   )
   describe(
-    "transform subfolder",
+    "transform subdir",
     withMock(fileStructSubdirTransformer, () => {
       test("should work with no helper", async () => {
         await Scaffold({