chore(release): 2.2.0 [skip ci]

# [2.2.0](https://github.com/chenasraf/simple-scaffold/compare/v2.1.0...v2.2.0) (2024-02-23) ### Features * `list` command ([d579c09](d579c09c11)) * add `--before-write` cli option ([#89](https://github.com/chenasraf/simple-scaffold/issues/89)) ([5f810e2](5f810e2116))
feat: add --before-write cli option (#89 )
2026-05-18 01:29:09 +00:00 · 2024-02-23 22:42:32 +00:00 · 2024-02-24 00:41:56 +02:00 · 2024-02-24 00:41:56 +02:00 · 2024-02-24 00:41:56 +02:00 · 2024-02-12 23:39:35 +00:00
21 changed files with 609 additions and 306 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Change Log

+# [2.2.0](https://github.com/chenasraf/simple-scaffold/compare/v2.1.0...v2.2.0) (2024-02-23)
+
+
+### Features
+
+* `list` command ([d579c09](https://github.com/chenasraf/simple-scaffold/commit/d579c09c11f2149fe7bb4515297c1287fa67083e))
+* add `--before-write` cli option ([#89](https://github.com/chenasraf/simple-scaffold/issues/89)) ([5f810e2](https://github.com/chenasraf/simple-scaffold/commit/5f810e21160816bc683cc0f375de318ff874871c))
+
+# [2.1.0](https://github.com/chenasraf/simple-scaffold/compare/v2.0.2...v2.1.0) (2024-02-12)
+
+
+### Features
+
+* support directory in --config flag ([e48b832](https://github.com/chenasraf/simple-scaffold/commit/e48b832e0b72a084d33fa2cbcca332e8209a734f))
+* support providing name in config ([4e7ac34](https://github.com/chenasraf/simple-scaffold/commit/4e7ac34db9bf67d012bbd1c06c1a26bc5ac93559))
+
 ## [2.0.2](https://github.com/chenasraf/simple-scaffold/compare/v2.0.1...v2.0.2) (2024-02-04)


--- a/docs/docs/usage/01-templates.md
+++ b/docs/docs/usage/01-templates.md
@@ -50,7 +50,6 @@ The contents of the file will be transformed in a similar fashion.

 Your `data` will be pre-populated with the following:

- `{{Name}}`: PascalCase of the component name
 - `{{name}}`: raw name of the component as you entered it

 > Simple-Scaffold uses [Handlebars.js](https://handlebarsjs.com/) for outputting the file contents.
@@ -110,7 +109,15 @@ Further details:
  ```

 - **The now helper** (for current time) takes the same arguments, minus the first one (`date`) as it
-  is implicitly the current date.
+  is implicitly the current date:
+
+  ```typescript
+  (
+    format: string,
+    offsetAmount?: number,
+    offsetType?: "years" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds"
+  )
+  ```

 ### Custom Helpers

--- a/docs/docs/usage/02-configuration_files.md
+++ b/docs/docs/usage/02-configuration_files.md
@@ -23,48 +23,11 @@ module.exports = {
 }
 ```

-The configuration contents are identical to the
-[Node.js configuration structure](https://chenasraf.github.io/simple-scaffold/docs/usage/node):
-
-```ts
-interface ScaffoldConfig {
-  name: string
-  templates: string[]
-  output: FileResponse<string>
-  subdir?: boolean
-  git?: string
-  config?: string
-  key?: string
-  data?: Record<string, any>
-  overwrite?: FileResponse<boolean>
-  quiet?: boolean
-  verbose?: LogLevel
-  dryRun?: boolean
-  helpers?: Record<string, Helper>
-  subdirHelper?: DefaultHelpers | string
-  beforeWrite?(
-    content: Buffer,
-    rawContent: Buffer,
-    outputPath: string,
-  ): string | Buffer | undefined | Promise<string | Buffer | undefined>
-}
-```
+For the full configuration options, see [ScaffoldConfigFile](../api/modules#scaffoldconfigfile).

 If you want to supply functions inside the configurations, you must use a `.js`/`.cjs`/`.mjs` file
 as JSON does not support non-primitives.

-A `.js` file can be just like a `.json` file, make sure to export the final configuration:
-
-```js
-/** @type {import('simple-scaffold').ScaffoldConfigFile} */
-module.exports = {
-  component: {
-    templates: ["templates/component"],
-    output: "src/components",
-  },
-}
-```
-
 Another feature of using a JS file is you can export a function which will be loaded with the CMD
 config provided to Simple Scaffold. The `extra` key contains any values not consumed by built-in
 flags, so you can pre-process your args before outputting a config:
@@ -82,6 +45,12 @@ module.exports = (config) => {
 }
 ```

+If you want to provide templates that need no name (such as common config files which are easily
+portable between projects), you may provide the `name` property in the config object.
+
+You will always be able to override it using `--name NewName`, but it will be given a value by
+default and therefore it will no longer be required in the CLI arguments.
+
 ## Using a config file

 Once your config is created, you can use it by providing the file name to the `--config` (or `-c`
@@ -116,7 +85,7 @@ And then:
 simple-scaffold -c scaffold.json MyComponentName
 ```

- When the filename is omitted, the following files will be tried in order:
+- When the a directory is given, the following files in the given directory will be tried in order:

  - `scaffold.config.*`
  - `scaffold.*`
@@ -162,6 +131,12 @@ simple-scaffold -g git://gitlab.com/<username>/<project_name> [-c <filename>] [-
 simple-scaffold -g https://gitlab.com/<username>/<project_name>.git [-c <filename>] [-k <template_key>]
 ```

+When a config file path is omitted, the files given in the list above will be tried on the root
+directory of the git repository.
+
+**Note:** The repository will be cloned to a temporary directory and removed after the scaffolding
+has been done.
+
 ## Use In Node.js

 You can also start a scaffold from Node.js with a remote file or URL config.
--- a/docs/docs/usage/03-cli.md
+++ b/docs/docs/usage/03-cli.md
@@ -11,24 +11,57 @@ 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 to load config from instead of passing arguments to CLI or using a Node.js script. See examples for syntax. This can also work in conjunction with `--git` or `--github` to point to remote files, and with `--key` to denote which key to select from the file., |
-| `--git`\|`-g`                       | Git URL to load config from instead of passing arguments to CLI or using a Node.js script. See examples for syntax.                                                                                                                                                        |
-| `--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.                                                                                                       |
-| `--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.                                                                                                                                                                                                                                                           |
+| 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.                                                                                                                                                                                         |
+
+### Before Write option
+
+This option allows you to preprocess a file before it is being written, such as running a formatter,
+linter or other commands.
+
+To use this option, pass it the command you would like to run. The following tokens will be replaced
+in your string:
+
+- `{{path}}` - the temporary file path for you to read from
+- `{{rawpath}}` - a different file path containing the raw file contents **before** they were
+  handled by Handlebars.js.
+
+If none of these tokens are found, the regular (non-raw) path will be appended to the end of the
+command.
+
+```shell
+simple-scaffold -c . --before-write prettier
+# command: prettier /tmp/somefile
+
+simple-scaffold -c . --before-write 'cat {{path}} | my-linter'
+# command: cat /tmp/somefile | my-linter
+```
+
+The command should return the string to write to the file through standard output (stdout), and not
+re-write the tmp file as it is not used for writing. Returning an empty string (after trimming) will
+discard the result and write the original file contents.
+
+See
+[beforeWrite](https://chenasraf.github.io/simple-scaffold/docs/api/interfaces/ScaffoldConfig#beforewrite)
+Node.js API for more details. Instead of returning `undefined` to keep the default behavior, you can
+output `''` for the same effect.

 ## Examples:

--- a/docs/docs/usage/04-node.md
+++ b/docs/docs/usage/04-node.md
@@ -2,6 +2,8 @@
 title: Node.js Usage
 ---

+## Overview
+
 You can build the scaffold yourself, if you want to create more complex arguments, scaffold groups,
 etc - simply pass a config object to the Scaffold function when you are ready to start.

@@ -33,6 +35,19 @@ interface ScaffoldConfig {
 }
 ```

+### Before Write option
+
+This option allows you to preprocess a file before it is being written, such as running a formatter,
+linter or other commands.
+
+To use this option, you can run any async/blocking command, and return a string as the final output
+to be used as the file contents.
+
+Returning `undefined` will keep the file contents as-is, after normal Handlebars.js procesing by
+Simple Scaffold.
+
+## Example
+
 This is an example of loading a complete scaffold via Node.js:

 ```typescript
@@ -50,6 +65,8 @@ const config = {
  helpers: {
    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()
 }

--- a/docs/docs/usage/05-examples.md
+++ b/docs/docs/usage/05-examples.md
--- a/docs/docs/usage/06-migration.md
+++ b/docs/docs/usage/06-migration.md
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -83,7 +83,7 @@ const config: Config = {
      title: "Simple Scaffold",
      logo: {
        alt: "Simple Scaffold",
-        src: "img/logo.svg",
+        src: "img/favicon.svg",
      },
      items: [
        {
--- a/examples/test-input/Component/{{pascalCase
+++ b/examples/test-input/Component/{{pascalCase
@@ -1,7 +1,7 @@
 import * as React from "react"
-import * as css from "./{{pascalCae name}}.css"
+import * as css from "./{{pascalCase name}}.css"

-class {{pascalCae name}} extends React.Component<any> {
+class {{pascalCase name}} extends React.Component<any> {
  private {{ property }}

  constructor(props: any) {
@@ -10,8 +10,8 @@ class {{pascalCae name}} extends React.Component<any> {
  }

  public render() {
-    return <div className={ css.{{pascalCae name}} } />
+    return <div className={ css.{{pascalCase name}} } />
  }
 }

-export default {pascalCae nName}}
+export default {{pascalCase name}}
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "simple-scaffold",
-  "version": "2.0.2",
+  "version": "2.2.0",
  "description": "Generate any file structure - from single components to entire app boilerplates, with a single command.",
  "homepage": "https: //chenasraf.github.io/simple-scaffold",
  "repository": {
@@ -49,15 +49,15 @@
    "@semantic-release/exec": "^6.0.3",
    "@semantic-release/git": "^10.0.1",
    "@semantic-release/release-notes-generator": "^12.1.0",
-    "@types/jest": "^29.5.11",
+    "@types/jest": "^29.5.12",
    "@types/mock-fs": "^4.13.4",
-    "@types/node": "^20.11.14",
+    "@types/node": "^20.11.17",
    "@types/semantic-release": "^20.0.6",
    "conventional-changelog": "^5.1.0",
    "conventional-changelog-cli": "^4.1.0",
    "jest": "^29.7.0",
    "mock-fs": "^5.2.0",
-    "semantic-release": "^23.0.0",
+    "semantic-release": "^23.0.2",
    "semantic-release-conventional-commits": "^3.0.0",
    "ts-jest": "^29.1.2",
    "ts-node": "^10.9.2",
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -24,25 +24,25 @@ dependencies:
 devDependencies:
  '@semantic-release/changelog':
    specifier: ^6.0.3
-    version: 6.0.3(semantic-release@23.0.0)
+    version: 6.0.3(semantic-release@23.0.2)
  '@semantic-release/exec':
    specifier: ^6.0.3
-    version: 6.0.3(semantic-release@23.0.0)
+    version: 6.0.3(semantic-release@23.0.2)
  '@semantic-release/git':
    specifier: ^10.0.1
-    version: 10.0.1(semantic-release@23.0.0)
+    version: 10.0.1(semantic-release@23.0.2)
  '@semantic-release/release-notes-generator':
    specifier: ^12.1.0
-    version: 12.1.0(semantic-release@23.0.0)
+    version: 12.1.0(semantic-release@23.0.2)
  '@types/jest':
-    specifier: ^29.5.11
-    version: 29.5.11
+    specifier: ^29.5.12
+    version: 29.5.12
  '@types/mock-fs':
    specifier: ^4.13.4
    version: 4.13.4
  '@types/node':
-    specifier: ^20.11.14
-    version: 20.11.14
+    specifier: ^20.11.17
+    version: 20.11.17
  '@types/semantic-release':
    specifier: ^20.0.6
    version: 20.0.6
@@ -54,13 +54,13 @@ devDependencies:
    version: 4.1.0
  jest:
    specifier: ^29.7.0
-    version: 29.7.0(@types/node@20.11.14)(ts-node@10.9.2)
+    version: 29.7.0(@types/node@20.11.17)(ts-node@10.9.2)
  mock-fs:
    specifier: ^5.2.0
    version: 5.2.0
  semantic-release:
-    specifier: ^23.0.0
-    version: 23.0.0(typescript@5.3.3)
+    specifier: ^23.0.2
+    version: 23.0.2(typescript@5.3.3)
  semantic-release-conventional-commits:
    specifier: ^3.0.0
    version: 3.0.0
@@ -69,7 +69,7 @@ devDependencies:
    version: 29.1.2(@babel/core@7.23.9)(jest@29.7.0)(typescript@5.3.3)
  ts-node:
    specifier: ^10.9.2
-    version: 10.9.2(@types/node@20.11.14)(typescript@5.3.3)
+    version: 10.9.2(@types/node@20.11.17)(typescript@5.3.3)
  typescript:
    specifier: ^5.3.3
    version: 5.3.3
@@ -465,7 +465,7 @@ packages:
    engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
    dependencies:
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      chalk: 4.1.2
      jest-message-util: 29.7.0
      jest-util: 29.7.0
@@ -486,14 +486,14 @@ packages:
      '@jest/test-result': 29.7.0
      '@jest/transform': 29.7.0
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      ansi-escapes: 4.3.2
      chalk: 4.1.2
      ci-info: 3.9.0
      exit: 0.1.2
      graceful-fs: 4.2.11
      jest-changed-files: 29.7.0
-      jest-config: 29.7.0(@types/node@20.11.14)(ts-node@10.9.2)
+      jest-config: 29.7.0(@types/node@20.11.17)(ts-node@10.9.2)
      jest-haste-map: 29.7.0
      jest-message-util: 29.7.0
      jest-regex-util: 29.6.3
@@ -521,7 +521,7 @@ packages:
    dependencies:
      '@jest/fake-timers': 29.7.0
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      jest-mock: 29.7.0
    dev: true

@@ -548,7 +548,7 @@ packages:
    dependencies:
      '@jest/types': 29.6.3
      '@sinonjs/fake-timers': 10.3.0
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      jest-message-util: 29.7.0
      jest-mock: 29.7.0
      jest-util: 29.7.0
@@ -581,7 +581,7 @@ packages:
      '@jest/transform': 29.7.0
      '@jest/types': 29.6.3
      '@jridgewell/trace-mapping': 0.3.22
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      chalk: 4.1.2
      collect-v8-coverage: 1.0.2
      exit: 0.1.2
@@ -669,7 +669,7 @@ packages:
      '@jest/schemas': 29.6.3
      '@types/istanbul-lib-coverage': 2.0.6
      '@types/istanbul-reports': 3.0.4
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      '@types/yargs': 17.0.32
      chalk: 4.1.2
    dev: true
@@ -729,7 +729,7 @@ packages:
    engines: {node: '>= 8'}
    dependencies:
      '@nodelib/fs.scandir': 2.1.5
-      fastq: 1.17.0
+      fastq: 1.17.1
    dev: true

  /@octokit/auth-token@4.0.0:
@@ -743,7 +743,7 @@ packages:
    dependencies:
      '@octokit/auth-token': 4.0.0
      '@octokit/graphql': 7.0.2
-      '@octokit/request': 8.1.6
+      '@octokit/request': 8.2.0
      '@octokit/request-error': 5.0.1
      '@octokit/types': 12.4.0
      before-after-hook: 2.2.3
@@ -762,7 +762,7 @@ packages:
    resolution: {integrity: sha512-OJ2iGMtj5Tg3s6RaXH22cJcxXRi7Y3EBqbHTBRq+PQAqfaS8f/236fUrWhfSn8P4jovyzqucxme7/vWSSZBX2Q==}
    engines: {node: '>= 18'}
    dependencies:
-      '@octokit/request': 8.1.6
+      '@octokit/request': 8.2.0
      '@octokit/types': 12.4.0
      universal-user-agent: 6.0.1
    dev: true
@@ -813,8 +813,8 @@ packages:
      once: 1.4.0
    dev: true

-  /@octokit/request@8.1.6:
-    resolution: {integrity: sha512-YhPaGml3ncZC1NfXpP3WZ7iliL1ap6tLkAp6MvbK2fTTPytzVUyUesBBogcdMm86uRYO5rHaM1xIWxigWZ17MQ==}
+  /@octokit/request@8.2.0:
+    resolution: {integrity: sha512-exPif6x5uwLqv1N1irkLG1zZNJkOtj8bZxuVHd71U5Ftuxf2wGNvAJyNBcPbPC+EBzwYEbBDdSFb8EPcjpYxPQ==}
    engines: {node: '>= 18'}
    dependencies:
      '@octokit/endpoint': 9.0.4
@@ -857,7 +857,7 @@ packages:
      config-chain: 1.1.13
    dev: true

-  /@semantic-release/changelog@6.0.3(semantic-release@23.0.0):
+  /@semantic-release/changelog@6.0.3(semantic-release@23.0.2):
    resolution: {integrity: sha512-dZuR5qByyfe3Y03TpmCvAxCyTnp7r5XwtHRf/8vD9EAn4ZWbavUX8adMtXYzE86EVh0gyLA7lm5yW4IV30XUag==}
    engines: {node: '>=14.17'}
    peerDependencies:
@@ -867,10 +867,10 @@ packages:
      aggregate-error: 3.1.0
      fs-extra: 11.2.0
      lodash: 4.17.21
-      semantic-release: 23.0.0(typescript@5.3.3)
+      semantic-release: 23.0.2(typescript@5.3.3)
    dev: true

-  /@semantic-release/commit-analyzer@11.1.0(semantic-release@23.0.0):
+  /@semantic-release/commit-analyzer@11.1.0(semantic-release@23.0.2):
    resolution: {integrity: sha512-cXNTbv3nXR2hlzHjAMgbuiQVtvWHTlwwISt60B+4NZv01y/QRY7p2HcJm8Eh2StzcTJoNnflvKjHH/cjFS7d5g==}
    engines: {node: ^18.17 || >=20.6.1}
    peerDependencies:
@@ -883,7 +883,7 @@ packages:
      import-from-esm: 1.3.3
      lodash-es: 4.17.21
      micromatch: 4.0.5
-      semantic-release: 23.0.0(typescript@5.3.3)
+      semantic-release: 23.0.2(typescript@5.3.3)
    transitivePeerDependencies:
      - supports-color
    dev: true
@@ -898,7 +898,7 @@ packages:
    engines: {node: '>=18'}
    dev: true

-  /@semantic-release/exec@6.0.3(semantic-release@23.0.0):
+  /@semantic-release/exec@6.0.3(semantic-release@23.0.2):
    resolution: {integrity: sha512-bxAq8vLOw76aV89vxxICecEa8jfaWwYITw6X74zzlO0mc/Bgieqx9kBRz9z96pHectiTAtsCwsQcUyLYWnp3VQ==}
    engines: {node: '>=14.17'}
    peerDependencies:
@@ -910,12 +910,12 @@ packages:
      execa: 5.1.1
      lodash: 4.17.21
      parse-json: 5.2.0
-      semantic-release: 23.0.0(typescript@5.3.3)
+      semantic-release: 23.0.2(typescript@5.3.3)
    transitivePeerDependencies:
      - supports-color
    dev: true

-  /@semantic-release/git@10.0.1(semantic-release@23.0.0):
+  /@semantic-release/git@10.0.1(semantic-release@23.0.2):
    resolution: {integrity: sha512-eWrx5KguUcU2wUPaO6sfvZI0wPafUKAMNC18aXY4EnNcrZL86dEmpNVnC9uMpGZkmZJ9EfCVJBQx4pV4EMGT1w==}
    engines: {node: '>=14.17'}
    peerDependencies:
@@ -929,12 +929,12 @@ packages:
      lodash: 4.17.21
      micromatch: 4.0.5
      p-reduce: 2.1.0
-      semantic-release: 23.0.0(typescript@5.3.3)
+      semantic-release: 23.0.2(typescript@5.3.3)
    transitivePeerDependencies:
      - supports-color
    dev: true

-  /@semantic-release/github@9.2.6(semantic-release@23.0.0):
+  /@semantic-release/github@9.2.6(semantic-release@23.0.2):
    resolution: {integrity: sha512-shi+Lrf6exeNZF+sBhK+P011LSbhmIAoUEgEY6SsxF8irJ+J2stwI5jkyDQ+4gzYyDImzV6LCKdYB9FXnQRWKA==}
    engines: {node: '>=18'}
    peerDependencies:
@@ -948,20 +948,20 @@ packages:
      aggregate-error: 5.0.0
      debug: 4.3.4
      dir-glob: 3.0.1
-      globby: 14.0.0
-      http-proxy-agent: 7.0.0
-      https-proxy-agent: 7.0.2
+      globby: 14.0.1
+      http-proxy-agent: 7.0.1
+      https-proxy-agent: 7.0.3
      issue-parser: 6.0.0
      lodash-es: 4.17.21
      mime: 4.0.1
      p-filter: 4.1.0
-      semantic-release: 23.0.0(typescript@5.3.3)
+      semantic-release: 23.0.2(typescript@5.3.3)
      url-join: 5.0.0
    transitivePeerDependencies:
      - supports-color
    dev: true

-  /@semantic-release/npm@11.0.2(semantic-release@23.0.0):
+  /@semantic-release/npm@11.0.2(semantic-release@23.0.2):
    resolution: {integrity: sha512-owtf3RjyPvRE63iUKZ5/xO4uqjRpVQDUB9+nnXj0xwfIeM9pRl+cG+zGDzdftR4m3f2s4Wyf3SexW+kF5DFtWA==}
    engines: {node: ^18.17 || >=20}
    peerDependencies:
@@ -978,12 +978,12 @@ packages:
      rc: 1.2.8
      read-pkg: 9.0.1
      registry-auth-token: 5.0.2
-      semantic-release: 23.0.0(typescript@5.3.3)
-      semver: 7.5.4
+      semantic-release: 23.0.2(typescript@5.3.3)
+      semver: 7.6.0
      tempy: 3.1.0
    dev: true

-  /@semantic-release/release-notes-generator@12.1.0(semantic-release@23.0.0):
+  /@semantic-release/release-notes-generator@12.1.0(semantic-release@23.0.2):
    resolution: {integrity: sha512-g6M9AjUKAZUZnxaJZnouNBeDNTCUrJ5Ltj+VJ60gJeDaRRahcHsry9HW8yKrnKkKNkx5lbWiEP1FPMqVNQz8Kg==}
    engines: {node: ^18.17 || >=20.6.1}
    peerDependencies:
@@ -999,7 +999,7 @@ packages:
      into-stream: 7.0.0
      lodash-es: 4.17.21
      read-pkg-up: 11.0.0
-      semantic-release: 23.0.0(typescript@5.3.3)
+      semantic-release: 23.0.2(typescript@5.3.3)
    transitivePeerDependencies:
      - supports-color
    dev: true
@@ -1013,8 +1013,8 @@ packages:
    engines: {node: '>=10'}
    dev: true

-  /@sindresorhus/merge-streams@1.0.0:
-    resolution: {integrity: sha512-rUV5WyJrJLoloD4NDN1V1+LDMDWOa4OTsT4yYJwQNpTU6FWxkxHpL7eu4w+DmiH8x/EAM1otkPE1+LaspIbplw==}
+  /@sindresorhus/merge-streams@2.2.0:
+    resolution: {integrity: sha512-UTce8mUwUW0RikMb/eseJ7ys0BRkZVFB86orHzrfW12ZmFtym5zua8joZ4L7okH2dDFHkcFjqnZ5GocWBXOFtA==}
    engines: {node: '>=18'}
    dev: true

@@ -1078,7 +1078,7 @@ packages:
  /@types/graceful-fs@4.1.9:
    resolution: {integrity: sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ==}
    dependencies:
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
    dev: true

  /@types/istanbul-lib-coverage@2.0.6:
@@ -1097,8 +1097,8 @@ packages:
      '@types/istanbul-lib-report': 3.0.3
    dev: true

-  /@types/jest@29.5.11:
-    resolution: {integrity: sha512-S2mHmYIVe13vrm6q4kN6fLYYAka15ALQki/vgDC3mIukEOx8WJlv0kQPM+d4w8Gp6u0uSdKND04IlTXBv0rwnQ==}
+  /@types/jest@29.5.12:
+    resolution: {integrity: sha512-eDC8bTvT/QhYdxJAulQikueigY5AsdBRH2yDKW3yveW7svY3+DzN84/2NUgkw10RTiJbWqZrTtoGVdYlvFJdLw==}
    dependencies:
      expect: 29.7.0
      pretty-format: 29.7.0
@@ -1111,11 +1111,11 @@ packages:
  /@types/mock-fs@4.13.4:
    resolution: {integrity: sha512-mXmM0o6lULPI8z3XNnQCpL0BGxPwx1Ul1wXYEPBGl4efShyxW2Rln0JOPEWGyZaYZMM6OVXM/15zUuFMY52ljg==}
    dependencies:
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
    dev: true

-  /@types/node@20.11.14:
-    resolution: {integrity: sha512-w3yWCcwULefjP9DmDDsgUskrMoOy5Z8MiwKHr1FvqGPtx7CvJzQvxD7eKpxNtklQxLruxSXWddyeRtyud0RcXQ==}
+  /@types/node@20.11.17:
+    resolution: {integrity: sha512-QmgQZGWu1Yw9TDyAP9ZzpFJKynYNeOvwMJmaxABfieQoVoiVOS6MN1WSpqpRcbeA5+RW82kraAVxCCJg+780Qw==}
    dependencies:
      undici-types: 5.26.5
    dev: true
@@ -1127,7 +1127,7 @@ packages:
  /@types/semantic-release@20.0.6:
    resolution: {integrity: sha512-8YJXvsT1FwMrNdZI1e6NBHPzZWendDiUsLryzxurdup+9LnV3s9fF4NgO0D3LkBfLMnocb4Ax6TQ5yFdF3dXGQ==}
    dependencies:
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
    dev: true

  /@types/stack-utils@2.0.3:
@@ -1238,8 +1238,8 @@ packages:
    engines: {node: '>=12'}
    dev: false

-  /ansicolors@0.3.2:
-    resolution: {integrity: sha512-QXu7BPrP29VllRxH8GwB7x5iX5qWKAAMLqKQGWTeLWVlNHNOpVMJ91dsxQAIWXpjuW5wqvxu3Jd/nRjrJ+0pqg==}
+  /any-promise@1.3.0:
+    resolution: {integrity: sha512-7UvmKalWRt1wgjL1RrGxoSJW/0QZFIegpeGvZG9kjp8vrRu55XTHbwnqq2GpXm9uLbcuhxm3IqX9OB4MZR1b2A==}
    dev: true

  /anymatch@3.1.3:
@@ -1385,8 +1385,8 @@ packages:
    engines: {node: ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7}
    hasBin: true
    dependencies:
-      caniuse-lite: 1.0.30001581
-      electron-to-chromium: 1.4.652
+      caniuse-lite: 1.0.30001587
+      electron-to-chromium: 1.4.667
      node-releases: 2.0.14
      update-browserslist-db: 1.0.13(browserslist@4.22.3)
    dev: true
@@ -1432,16 +1432,8 @@ packages:
    engines: {node: '>=10'}
    dev: true

-  /caniuse-lite@1.0.30001581:
-    resolution: {integrity: sha512-whlTkwhqV2tUmP3oYhtNfaWGYHDdS3JYFQBKXxcUR9qqPWsRhFHhoISO2Xnl/g0xyKzht9mI1LZpiNWfMzHixQ==}
-    dev: true
-
-  /cardinal@2.1.1:
-    resolution: {integrity: sha512-JSr5eOgoEymtYHBjNWyjrMqet9Am2miJhlfKNdqLp6zoeAh0KN5dRAcxlecj5mAJrmQomgiOBj35xHLrFjqBpw==}
-    hasBin: true
-    dependencies:
-      ansicolors: 0.3.2
-      redeyed: 2.1.1
+  /caniuse-lite@1.0.30001587:
+    resolution: {integrity: sha512-HMFNotUmLXn71BQxg8cijvqxnIAofforZOwGsxyXJ0qugTdspUF4sPSJ2vhgprHCB996tIDzEq1ubumPDV8ULA==}
    dev: true

  /chalk@2.4.2:
@@ -1491,6 +1483,19 @@ packages:
      escape-string-regexp: 5.0.0
    dev: true

+  /cli-highlight@2.1.11:
+    resolution: {integrity: sha512-9KDcoEVwyUXrjcJNvHD0NFc/hiwe/WPVYIleQh2O1N2Zro5gWJZ/K+3DGn8w8P/F6FxOgzyC5bxDyHIgCSPhGg==}
+    engines: {node: '>=8.0.0', npm: '>=5.0.0'}
+    hasBin: true
+    dependencies:
+      chalk: 4.1.2
+      highlight.js: 10.7.3
+      mz: 2.7.0
+      parse5: 5.1.1
+      parse5-htmlparser2-tree-adapter: 6.0.1
+      yargs: 16.2.0
+    dev: true
+
  /cli-table3@0.6.3:
    resolution: {integrity: sha512-w5Jac5SykAeZJKntOxJCrm63Eg5/4dhMWIcuTbo9rpE+brgaSZo0RuNJZeOyMgsUdhDeojvgyQLmjI+K50ZGyg==}
    engines: {node: 10.* || >= 12.*}
@@ -1500,6 +1505,14 @@ packages:
      '@colors/colors': 1.5.0
    dev: true

+  /cliui@7.0.4:
+    resolution: {integrity: sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==}
+    dependencies:
+      string-width: 4.2.3
+      strip-ansi: 6.0.1
+      wrap-ansi: 7.0.0
+    dev: true
+
  /cliui@8.0.1:
    resolution: {integrity: sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==}
    engines: {node: '>=12'}
@@ -1647,7 +1660,7 @@ packages:
      handlebars: 4.7.8
      json-stringify-safe: 5.0.1
      meow: 12.1.1
-      semver: 7.5.4
+      semver: 7.6.0
      split2: 4.2.0
    dev: true

@@ -1721,7 +1734,7 @@ packages:
      typescript: 5.3.3
    dev: true

-  /create-jest@29.7.0(@types/node@20.11.14)(ts-node@10.9.2):
+  /create-jest@29.7.0(@types/node@20.11.17)(ts-node@10.9.2):
    resolution: {integrity: sha512-Adz2bdH0Vq3F53KEMJOoftQFutWCukm6J24wbPWRO4k1kMY7gS7ds/uoJkNuV8wDCtWWnuwGcJwpWcih+zEW1Q==}
    engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
    hasBin: true
@@ -1730,7 +1743,7 @@ packages:
      chalk: 4.1.2
      exit: 0.1.2
      graceful-fs: 4.2.11
-      jest-config: 29.7.0(@types/node@20.11.14)(ts-node@10.9.2)
+      jest-config: 29.7.0(@types/node@20.11.17)(ts-node@10.9.2)
      jest-util: 29.7.0
      prompts: 2.4.2
    transitivePeerDependencies:
@@ -1855,8 +1868,8 @@ packages:
    resolution: {integrity: sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==}
    dev: false

-  /electron-to-chromium@1.4.652:
-    resolution: {integrity: sha512-XvQaa8hVUAuEJtLw6VKQqvdOxTOfBLWfI10t2xWpezx4XXD3k8bdLweEKeItqaa0+OkJX5l0mP1W+JWobyIDrg==}
+  /electron-to-chromium@1.4.667:
+    resolution: {integrity: sha512-66L3pLlWhTNVUhnmSA5+qDM3fwnXsM6KAqE36e2w4KN0g6pkEtlT5bs41FQtQwVwKnfhNBXiWRLPs30HSxd7Kw==}
    dev: true

  /emittery@0.13.1:
@@ -1894,8 +1907,8 @@ packages:
      is-arrayish: 0.2.1
    dev: true

-  /escalade@3.1.1:
-    resolution: {integrity: sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==}
+  /escalade@3.1.2:
+    resolution: {integrity: sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==}
    engines: {node: '>=6'}
    dev: true

@@ -1981,8 +1994,8 @@ packages:
    resolution: {integrity: sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==}
    dev: true

-  /fastq@1.17.0:
-    resolution: {integrity: sha512-zGygtijUMT7jnk3h26kUms3BkSDp4IfIKjmnqI2tvx6nuBfiF1UqOxbnLfzdv+apBy+53oaImsKtMw/xYbW+1w==}
+  /fastq@1.17.1:
+    resolution: {integrity: sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==}
    dependencies:
      reusify: 1.0.4
    dev: true
@@ -2146,7 +2159,7 @@ packages:
    hasBin: true
    dependencies:
      meow: 12.1.1
-      semver: 7.5.4
+      semver: 7.6.0
    dev: true

  /glob-parent@5.1.2:
@@ -2184,13 +2197,13 @@ packages:
    engines: {node: '>=4'}
    dev: true

-  /globby@14.0.0:
-    resolution: {integrity: sha512-/1WM/LNHRAOH9lZta77uGbq0dAEQM+XjNesWwhlERDVenqothRbnzTrL3/LrIoEPPjeUHC3vrS6TwoyxeHs7MQ==}
+  /globby@14.0.1:
+    resolution: {integrity: sha512-jOMLD2Z7MAhyG8aJpNOpmziMOP4rPLcc95oQPKXBazW82z+CEgPFBQvEpRUa1KeIMUJo4Wsm+q6uzO/Q/4BksQ==}
    engines: {node: '>=18'}
    dependencies:
-      '@sindresorhus/merge-streams': 1.0.0
+      '@sindresorhus/merge-streams': 2.2.0
      fast-glob: 3.3.2
-      ignore: 5.3.0
+      ignore: 5.3.1
      path-type: 5.0.0
      slash: 5.1.0
      unicorn-magic: 0.1.0
@@ -2230,13 +2243,17 @@ packages:
    resolution: {integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==}
    engines: {node: '>=8'}

-  /hasown@2.0.0:
-    resolution: {integrity: sha512-vUptKVTpIJhcczKBbgnS+RtcuYMB8+oNzPK2/Hp3hanz8JmpATdmmgLgSaadVREkDm+e2giHwY3ZRkyjSIDDFA==}
+  /hasown@2.0.1:
+    resolution: {integrity: sha512-1/th4MHjnwncwXsIW6QMzlvYL9kG5e/CpVvLRZe4XPa8TOUNbCELqmvhDmnkNsAjwaG4+I8gJJL0JBvTTLO9qA==}
    engines: {node: '>= 0.4'}
    dependencies:
      function-bind: 1.1.2
    dev: true

+  /highlight.js@10.7.3:
+    resolution: {integrity: sha512-tzcUFauisWKNHaRkN4Wjl/ZA07gENAjFl3J/c480dprkGTg5EQstgaNFqBfUqCq54kZRIEcreTsAgF/m2quD7A==}
+    dev: true
+
  /hook-std@3.0.0:
    resolution: {integrity: sha512-jHRQzjSDzMtFy34AGj1DN+vq54WVuhSvKgrHf0OMiFQTwDD4L/qqofVEWjLOBMTn5+lCD3fPg32W9yOfnEJTTw==}
    engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0}
@@ -2264,8 +2281,8 @@ packages:
    resolution: {integrity: sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==}
    dev: true

-  /http-proxy-agent@7.0.0:
-    resolution: {integrity: sha512-+ZT+iBxVUQ1asugqnD6oWoRiS25AkjNfG085dKJGtGxkdwLQrMKU5wJr2bOOFAXzKcTuqq+7fZlTMgG3SRfIYQ==}
+  /http-proxy-agent@7.0.1:
+    resolution: {integrity: sha512-My1KCEPs6A0hb4qCVzYp8iEvA8j8YqcvXLZZH8C9OFuTYpYjHE7N2dtG3mRl1HMD4+VGXpF3XcDVcxGBT7yDZQ==}
    engines: {node: '>= 14'}
    dependencies:
      agent-base: 7.1.0
@@ -2274,8 +2291,8 @@ packages:
      - supports-color
    dev: true

-  /https-proxy-agent@7.0.2:
-    resolution: {integrity: sha512-NmLNjm6ucYwtcUmL7JQC1ZQ57LmHP4lT15FQ8D61nak1rO6DH+fz5qNK2Ap5UN4ZapYICE3/0KodcLYSPsPbaA==}
+  /https-proxy-agent@7.0.3:
+    resolution: {integrity: sha512-kCnwztfX0KZJSLOBrcL0emLeFako55NWMovvyPP2AjsghNk9RB1yjSI+jVumPHYZsNXegNoqupSW9IY3afSH8w==}
    engines: {node: '>= 14'}
    dependencies:
      agent-base: 7.1.0
@@ -2294,8 +2311,8 @@ packages:
    engines: {node: '>=16.17.0'}
    dev: true

-  /ignore@5.3.0:
-    resolution: {integrity: sha512-g7dmpshy+gD7mh88OC9NwSGTKoc3kyLAZQRU1mt53Aw/vnvfXnbC+F/7F7QoYVKbV+KNvJx8wArewKy1vXMtlg==}
+  /ignore@5.3.1:
+    resolution: {integrity: sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==}
    engines: {node: '>= 4'}
    dev: true

@@ -2380,7 +2397,7 @@ packages:
  /is-core-module@2.13.1:
    resolution: {integrity: sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==}
    dependencies:
-      hasown: 2.0.0
+      hasown: 2.0.1
    dev: true

  /is-extglob@2.1.1:
@@ -2492,7 +2509,7 @@ packages:
      '@babel/parser': 7.23.9
      '@istanbuljs/schema': 0.1.3
      istanbul-lib-coverage: 3.2.2
-      semver: 7.5.4
+      semver: 7.6.0
    transitivePeerDependencies:
      - supports-color
    dev: true
@@ -2556,7 +2573,7 @@ packages:
      '@jest/expect': 29.7.0
      '@jest/test-result': 29.7.0
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      chalk: 4.1.2
      co: 4.6.0
      dedent: 1.5.1
@@ -2577,7 +2594,7 @@ packages:
      - supports-color
    dev: true

-  /jest-cli@29.7.0(@types/node@20.11.14)(ts-node@10.9.2):
+  /jest-cli@29.7.0(@types/node@20.11.17)(ts-node@10.9.2):
    resolution: {integrity: sha512-OVVobw2IubN/GSYsxETi+gOe7Ka59EFMR/twOU3Jb2GnKKeMGJB5SGUUrEz3SFVmJASUdZUzy83sLNNQ2gZslg==}
    engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
    hasBin: true
@@ -2591,10 +2608,10 @@ packages:
      '@jest/test-result': 29.7.0
      '@jest/types': 29.6.3
      chalk: 4.1.2
-      create-jest: 29.7.0(@types/node@20.11.14)(ts-node@10.9.2)
+      create-jest: 29.7.0(@types/node@20.11.17)(ts-node@10.9.2)
      exit: 0.1.2
      import-local: 3.1.0
-      jest-config: 29.7.0(@types/node@20.11.14)(ts-node@10.9.2)
+      jest-config: 29.7.0(@types/node@20.11.17)(ts-node@10.9.2)
      jest-util: 29.7.0
      jest-validate: 29.7.0
      yargs: 17.7.2
@@ -2605,7 +2622,7 @@ packages:
      - ts-node
    dev: true

-  /jest-config@29.7.0(@types/node@20.11.14)(ts-node@10.9.2):
+  /jest-config@29.7.0(@types/node@20.11.17)(ts-node@10.9.2):
    resolution: {integrity: sha512-uXbpfeQ7R6TZBqI3/TxCU4q4ttk3u0PJeC+E0zbfSoSjq6bJ7buBPxzQPL0ifrkY4DNu4JUdk0ImlBUYi840eQ==}
    engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
    peerDependencies:
@@ -2620,7 +2637,7 @@ packages:
      '@babel/core': 7.23.9
      '@jest/test-sequencer': 29.7.0
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      babel-jest: 29.7.0(@babel/core@7.23.9)
      chalk: 4.1.2
      ci-info: 3.9.0
@@ -2640,7 +2657,7 @@ packages:
      pretty-format: 29.7.0
      slash: 3.0.0
      strip-json-comments: 3.1.1
-      ts-node: 10.9.2(@types/node@20.11.14)(typescript@5.3.3)
+      ts-node: 10.9.2(@types/node@20.11.17)(typescript@5.3.3)
    transitivePeerDependencies:
      - babel-plugin-macros
      - supports-color
@@ -2681,7 +2698,7 @@ packages:
      '@jest/environment': 29.7.0
      '@jest/fake-timers': 29.7.0
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      jest-mock: 29.7.0
      jest-util: 29.7.0
    dev: true
@@ -2697,7 +2714,7 @@ packages:
    dependencies:
      '@jest/types': 29.6.3
      '@types/graceful-fs': 4.1.9
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      anymatch: 3.1.3
      fb-watchman: 2.0.2
      graceful-fs: 4.2.11
@@ -2748,7 +2765,7 @@ packages:
    engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
    dependencies:
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      jest-util: 29.7.0
    dev: true

@@ -2803,7 +2820,7 @@ packages:
      '@jest/test-result': 29.7.0
      '@jest/transform': 29.7.0
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      chalk: 4.1.2
      emittery: 0.13.1
      graceful-fs: 4.2.11
@@ -2834,7 +2851,7 @@ packages:
      '@jest/test-result': 29.7.0
      '@jest/transform': 29.7.0
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      chalk: 4.1.2
      cjs-module-lexer: 1.2.3
      collect-v8-coverage: 1.0.2
@@ -2876,7 +2893,7 @@ packages:
      jest-util: 29.7.0
      natural-compare: 1.4.0
      pretty-format: 29.7.0
-      semver: 7.5.4
+      semver: 7.6.0
    transitivePeerDependencies:
      - supports-color
    dev: true
@@ -2886,7 +2903,7 @@ packages:
    engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
    dependencies:
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      chalk: 4.1.2
      ci-info: 3.9.0
      graceful-fs: 4.2.11
@@ -2911,7 +2928,7 @@ packages:
    dependencies:
      '@jest/test-result': 29.7.0
      '@jest/types': 29.6.3
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      ansi-escapes: 4.3.2
      chalk: 4.1.2
      emittery: 0.13.1
@@ -2923,13 +2940,13 @@ packages:
    resolution: {integrity: sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==}
    engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
    dependencies:
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      jest-util: 29.7.0
      merge-stream: 2.0.0
      supports-color: 8.1.1
    dev: true

-  /jest@29.7.0(@types/node@20.11.14)(ts-node@10.9.2):
+  /jest@29.7.0(@types/node@20.11.17)(ts-node@10.9.2):
    resolution: {integrity: sha512-NIy3oAFp9shda19hy4HK0HRTWKtPJmGdnvywu01nOqNC2vZg+Z+fvJDxpMQA88eb2I9EcafcdjYgsDthnYTvGw==}
    engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
    hasBin: true
@@ -2942,7 +2959,7 @@ packages:
      '@jest/core': 29.7.0(ts-node@10.9.2)
      '@jest/types': 29.6.3
      import-local: 3.1.0
-      jest-cli: 29.7.0(@types/node@20.11.14)(ts-node@10.9.2)
+      jest-cli: 29.7.0(@types/node@20.11.17)(ts-node@10.9.2)
    transitivePeerDependencies:
      - '@types/node'
      - babel-plugin-macros
@@ -3120,7 +3137,7 @@ packages:
    resolution: {integrity: sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==}
    engines: {node: '>=10'}
    dependencies:
-      semver: 7.5.4
+      semver: 7.6.0
    dev: true

  /make-error@1.3.6:
@@ -3143,23 +3160,23 @@ packages:
    engines: {node: '>=8'}
    dev: true

-  /marked-terminal@6.2.0(marked@11.2.0):
-    resolution: {integrity: sha512-ubWhwcBFHnXsjYNsu+Wndpg0zhY4CahSpPlA70PlO0rR9r2sZpkyU+rkCsOWH+KMEkx847UpALON+HWgxowFtw==}
+  /marked-terminal@7.0.0(marked@12.0.0):
+    resolution: {integrity: sha512-sNEx8nn9Ktcm6pL0TnRz8tnXq/mSS0Q1FRSwJOAqw4lAB4l49UeDf85Gm1n9RPFm5qurCPjwi1StAQT2XExhZw==}
    engines: {node: '>=16.0.0'}
    peerDependencies:
-      marked: '>=1 <12'
+      marked: '>=1 <13'
    dependencies:
      ansi-escapes: 6.2.0
-      cardinal: 2.1.1
      chalk: 5.3.0
+      cli-highlight: 2.1.11
      cli-table3: 0.6.3
-      marked: 11.2.0
+      marked: 12.0.0
      node-emoji: 2.1.3
      supports-hyperlinks: 3.0.0
    dev: true

-  /marked@11.2.0:
-    resolution: {integrity: sha512-HR0m3bvu0jAPYiIvLUUQtdg1g6D247//lvcekpHO1WMvbwDlwSkZAX9Lw4F4YHE1T0HaaNve0tuAWuV1UJ6vtw==}
+  /marked@12.0.0:
+    resolution: {integrity: sha512-Vkwtq9rLqXryZnWaQc86+FHLC6tr/fycMfYAhiOIXkrNmeGAyhSxjqu0Rs1i0bBqw5u0S7+lV9fdH2ZSVaoa0w==}
    engines: {node: '>= 18'}
    hasBin: true
    dev: true
@@ -3269,6 +3286,14 @@ packages:
    resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==}
    dev: true

+  /mz@2.7.0:
+    resolution: {integrity: sha512-z81GNO7nnYMEhrGh9LeymoE4+Yr0Wn5McHIZMK5cfQCl+NDX08sCZgUc9/6MHni9IWuFLm1Z3HTCXu2z9fN62Q==}
+    dependencies:
+      any-promise: 1.3.0
+      object-assign: 4.1.1
+      thenify-all: 1.6.0
+    dev: true
+
  /natural-compare@1.4.0:
    resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==}
    dev: true
@@ -3313,7 +3338,7 @@ packages:
    dependencies:
      hosted-git-info: 4.1.0
      is-core-module: 2.13.1
-      semver: 7.5.4
+      semver: 7.6.0
      validate-npm-package-license: 3.0.4
    dev: true

@@ -3323,7 +3348,7 @@ packages:
    dependencies:
      hosted-git-info: 7.0.1
      is-core-module: 2.13.1
-      semver: 7.5.4
+      semver: 7.6.0
      validate-npm-package-license: 3.0.4
    dev: true

@@ -3428,6 +3453,11 @@ packages:
      - which
      - write-file-atomic

+  /object-assign@4.1.1:
+    resolution: {integrity: sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==}
+    engines: {node: '>=0.10.0'}
+    dev: true
+
  /once@1.4.0:
    resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==}
    dependencies:
@@ -3584,6 +3614,20 @@ packages:
      type-fest: 4.10.2
    dev: true

+  /parse5-htmlparser2-tree-adapter@6.0.1:
+    resolution: {integrity: sha512-qPuWvbLgvDGilKc5BoicRovlT4MtYT6JfJyBOMDsKoiT+GiuP5qyrPCnR9HcPECIJJmZh5jRndyNThnhhb/vlA==}
+    dependencies:
+      parse5: 6.0.1
+    dev: true
+
+  /parse5@5.1.1:
+    resolution: {integrity: sha512-ugq4DFI0Ptb+WWjAdOK16+u/nHfiIrcE+sh8kZMaM0WllQKLI9rOUq6c2b7cwPkXdzfQESqvoqK6ug7U/Yyzug==}
+    dev: true
+
+  /parse5@6.0.1:
+    resolution: {integrity: sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==}
+    dev: true
+
  /path-exists@3.0.0:
    resolution: {integrity: sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==}
    engines: {node: '>=4'}
@@ -3809,12 +3853,6 @@ packages:
      strip-indent: 3.0.0
    dev: true

-  /redeyed@2.1.1:
-    resolution: {integrity: sha512-FNpGGo1DycYAdnrKFxCMmKYgo/mILAqtRYbkdQD8Ep/Hk2PQ5+aEAEx+IU713RTDmuBaH0c8P5ZozurNu5ObRQ==}
-    dependencies:
-      esprima: 4.0.1
-    dev: true
-
  /registry-auth-token@5.0.2:
    resolution: {integrity: sha512-o/3ikDxtXaA59BmZuZrJZDJv8NMDGSj+6j6XaeBmHw8eY1i1qd9+6H+LjVvQXx3HN6aRCGa1cUdJ9RaJZUugnQ==}
    engines: {node: '>=14'}
@@ -3884,16 +3922,16 @@ packages:
      conventional-commits-parser: 3.2.4
    dev: true

-  /semantic-release@23.0.0(typescript@5.3.3):
-    resolution: {integrity: sha512-Jz7jEWO2igTtske112gC4PPE2whCMVrsgxUPG3/SZI7VE357suIUZFlJd1Yu0g2I6RPc2HxNEfUg7KhmDTjwqg==}
+  /semantic-release@23.0.2(typescript@5.3.3):
+    resolution: {integrity: sha512-OnVYJ6Xgzwe1x8MKswba7RU9+5djS1MWRTrTn5qsq3xZYpslroZkV9Pt0dA2YcIuieeuSZWJhn+yUWoBUHO5Fw==}
    engines: {node: '>=20.8.1'}
    hasBin: true
    dependencies:
-      '@semantic-release/commit-analyzer': 11.1.0(semantic-release@23.0.0)
+      '@semantic-release/commit-analyzer': 11.1.0(semantic-release@23.0.2)
      '@semantic-release/error': 4.0.0
-      '@semantic-release/github': 9.2.6(semantic-release@23.0.0)
-      '@semantic-release/npm': 11.0.2(semantic-release@23.0.0)
-      '@semantic-release/release-notes-generator': 12.1.0(semantic-release@23.0.0)
+      '@semantic-release/github': 9.2.6(semantic-release@23.0.2)
+      '@semantic-release/npm': 11.0.2(semantic-release@23.0.2)
+      '@semantic-release/release-notes-generator': 12.1.0(semantic-release@23.0.2)
      aggregate-error: 5.0.0
      cosmiconfig: 9.0.0(typescript@5.3.3)
      debug: 4.3.4
@@ -3907,14 +3945,14 @@ packages:
      hosted-git-info: 7.0.1
      import-from-esm: 1.3.3
      lodash-es: 4.17.21
-      marked: 11.2.0
-      marked-terminal: 6.2.0(marked@11.2.0)
+      marked: 12.0.0
+      marked-terminal: 7.0.0(marked@12.0.0)
      micromatch: 4.0.5
      p-each-series: 3.0.0
      p-reduce: 3.0.0
      read-pkg-up: 11.0.0
      resolve-from: 5.0.0
-      semver: 7.5.4
+      semver: 7.6.0
      semver-diff: 4.0.0
      signale: 1.4.0
      yargs: 17.7.2
@@ -3927,7 +3965,7 @@ packages:
    resolution: {integrity: sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==}
    engines: {node: '>=12'}
    dependencies:
-      semver: 7.5.4
+      semver: 7.6.0
    dev: true

  /semver-regex@4.0.5:
@@ -3945,8 +3983,8 @@ packages:
    hasBin: true
    dev: true

-  /semver@7.5.4:
-    resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==}
+  /semver@7.6.0:
+    resolution: {integrity: sha512-EnwXhrlwXMk9gKu5/flx5sv/an57AkRplG3hTK68W7FRDN+k+OWBj65M7719OkA82XLBxrcX0KSHj+X5COhOVg==}
    engines: {node: '>=10'}
    hasBin: true
    dependencies:
@@ -4020,7 +4058,7 @@ packages:
    resolution: {integrity: sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==}
    dependencies:
      spdx-expression-parse: 3.0.1
-      spdx-license-ids: 3.0.16
+      spdx-license-ids: 3.0.17
    dev: true

  /spdx-exceptions@2.4.0:
@@ -4031,11 +4069,11 @@ packages:
    resolution: {integrity: sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==}
    dependencies:
      spdx-exceptions: 2.4.0
-      spdx-license-ids: 3.0.16
+      spdx-license-ids: 3.0.17
    dev: true

-  /spdx-license-ids@3.0.16:
-    resolution: {integrity: sha512-eWN+LnM3GR6gPu35WxNgbGl8rmY1AEmoMDvL/QD6zYmPWgywxWqJWNdLGT+ke8dKNWrcYgYjPpG5gbTfghP8rw==}
+  /spdx-license-ids@3.0.17:
+    resolution: {integrity: sha512-sh8PWc/ftMqAAdFiBu6Fy6JUOYjqDJBJvIhpfDMyHrr0Rbp5liZqd4TjtQ/RgfLjKFZb+LMx5hpml5qOWy0qvg==}
    dev: true

  /split2@1.0.0:
@@ -4234,6 +4272,19 @@ packages:
    engines: {node: '>=8'}
    dev: true

+  /thenify-all@1.6.0:
+    resolution: {integrity: sha512-RNxQH/qI8/t3thXJDwcstUO4zeqo64+Uy/+sNVRBx4Xn2OX+OZ9oP+iJnNFqplFra2ZUVeKCSa2oVWi3T4uVmA==}
+    engines: {node: '>=0.8'}
+    dependencies:
+      thenify: 3.3.1
+    dev: true
+
+  /thenify@3.3.1:
+    resolution: {integrity: sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw==}
+    dependencies:
+      any-promise: 1.3.0
+    dev: true
+
  /through2@2.0.5:
    resolution: {integrity: sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==}
    dependencies:
@@ -4301,17 +4352,17 @@ packages:
      '@babel/core': 7.23.9
      bs-logger: 0.2.6
      fast-json-stable-stringify: 2.1.0
-      jest: 29.7.0(@types/node@20.11.14)(ts-node@10.9.2)
+      jest: 29.7.0(@types/node@20.11.17)(ts-node@10.9.2)
      jest-util: 29.7.0
      json5: 2.2.3
      lodash.memoize: 4.1.2
      make-error: 1.3.6
-      semver: 7.5.4
+      semver: 7.6.0
      typescript: 5.3.3
      yargs-parser: 21.1.1
    dev: true

-  /ts-node@10.9.2(@types/node@20.11.14)(typescript@5.3.3):
+  /ts-node@10.9.2(@types/node@20.11.17)(typescript@5.3.3):
    resolution: {integrity: sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==}
    hasBin: true
    peerDependencies:
@@ -4330,7 +4381,7 @@ packages:
      '@tsconfig/node12': 1.0.11
      '@tsconfig/node14': 1.0.3
      '@tsconfig/node16': 1.0.4
-      '@types/node': 20.11.14
+      '@types/node': 20.11.17
      acorn: 8.11.3
      acorn-walk: 8.3.2
      arg: 4.1.3
@@ -4437,7 +4488,7 @@ packages:
      browserslist: '>= 4.21.0'
    dependencies:
      browserslist: 4.22.3
-      escalade: 3.1.1
+      escalade: 3.1.2
      picocolors: 1.0.0
    dev: true

@@ -4543,12 +4594,25 @@ packages:
    engines: {node: '>=12'}
    dev: true

+  /yargs@16.2.0:
+    resolution: {integrity: sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==}
+    engines: {node: '>=10'}
+    dependencies:
+      cliui: 7.0.4
+      escalade: 3.1.2
+      get-caller-file: 2.0.5
+      require-directory: 2.1.1
+      string-width: 4.2.3
+      y18n: 5.0.8
+      yargs-parser: 20.2.9
+    dev: true
+
  /yargs@17.7.2:
    resolution: {integrity: sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==}
    engines: {node: '>=12'}
    dependencies:
      cliui: 8.0.1
-      escalade: 3.1.1
+      escalade: 3.1.2
      get-caller-file: 2.0.5
      require-directory: 2.1.1
      string-width: 4.2.3
--- a/release.config.js
+++ b/release.config.js
@@ -13,31 +13,27 @@ module.exports = {
      "@semantic-release/npm",
      {
        // only update the pkg version on root, don't publish
+        // this is to keep package.json version in sync with the release
        npmPublish: false,
      },
    ],
-    // [
-    //   '@semantic-release/npm',
-    //   {
-    //     // only update the pkg version on doc, don't publish
-    //     npmPublish: false,
-    //     pkgRoot: 'doc',
-    //   },
-    // ]
    [
      "@semantic-release/exec",
      {
-        publish: "cd ./dist && pnpm pack --pack-destination=../",
+        // pack the dist folder, during publish step (after version was bumped)
+        publishCmd: 'echo "Packing..."; cd ./dist && pnpm pack --pack-destination=../; echo "Done"',
      },
    ],
    [
      "@semantic-release/npm",
      {
        // publish from dist dir instead of root
+        // this is the actual uild output
        pkgRoot: "dist",
      },
    ],
    [
+      // Release to GitHub
      "@semantic-release/github",
      {
        assets: ["*.tgz"],
@@ -45,14 +41,16 @@ module.exports = {
    ],
    branch === "master"
      ? [
-          "@semantic-release/changelog",
-          {
-            changelogFile: "CHANGELOG.md",
-            changelogTitle: "# Change Log",
-          },
-        ]
+        // Update CHANGELOG.md only on master
+        "@semantic-release/changelog",
+        {
+          changelogFile: "CHANGELOG.md",
+          changelogTitle: "# Change Log",
+        },
+      ]
      : undefined,
    [
+      // Commit the package.json and CHANGELOG.md files to git (if modified)
      "@semantic-release/git",
      {
        assets: ["package.json", "CHANGELOG.md"].filter(Boolean),
--- a/scaffold.config.js
+++ b/scaffold.config.js
@@ -1,4 +1,5 @@
-/** @type {import('simple-scaffold').ScaffoldConfigFile} */
+// @ts-check
+/** @type {import('./dist').ScaffoldConfigFile} */
 module.exports = (conf) => {
  console.log("Config:", conf)
  return {
@@ -12,5 +13,10 @@ module.exports = (conf) => {
      output: "examples/test-output/component",
      data: { property: "myProp", value: "10" },
    },
+    configs: {
+      templates: ["examples/test-input/**/.*"],
+      output: "examples/test-output/configs",
+      name: "---",
+    },
  }
 }
--- a/src/cmd.ts
+++ b/src/cmd.ts
@@ -1,22 +1,24 @@
 #!/usr/bin/env node

-import os from "node:os"
-import { massarg } from "massarg"
-import chalk from "chalk"
-import { LogLevel, ScaffoldCmdConfig } from "./types"
-import { Scaffold } from "./scaffold"
 import path from "node:path"
 import fs from "node:fs/promises"
-import { parseAppendData, parseConfigFile } from "./config"
+import { massarg } from "massarg"
+import chalk from "chalk"
+import { ListCommandCliOptions, LogLevel, ScaffoldCmdConfig } from "./types"
+import { Scaffold } from "./scaffold"
+import { getConfigFile, parseAppendData, parseConfigFile } from "./config"
 import { log } from "./logger"
+import { MassargCommand } from "massarg/command"
+import { getUniqueTmpPath as generateUniqueTmpPath } from "./file"

 export async function parseCliArgs(args = process.argv.slice(2)) {
  const isProjectRoot = Boolean(await fs.stat(path.join(__dirname, "package.json")).catch(() => false))
  const pkgFile = await fs.readFile(path.resolve(__dirname, isProjectRoot ? "." : "..", "package.json"))
  const pkg = JSON.parse(pkgFile.toString())
  const isVersionFlag = args.includes("--version") || args.includes("-v")
-  const isConfigProvided =
-    args.includes("--config") || args.includes("-c") || args.includes("--git") || args.includes("-g") || isVersionFlag
+  const isConfigFileProvided = args.includes("--config") || args.includes("-c")
+  const isGitProvided = args.includes("--git") || args.includes("-g")
+  const isConfigProvided = isConfigFileProvided || isGitProvided || isVersionFlag

  return massarg<ScaffoldCmdConfig>({
    name: pkg.name,
@@ -28,11 +30,14 @@ export async function parseCliArgs(args = process.argv.slice(2)) {
        return
      }
      log(config, LogLevel.info, `Simple Scaffold v${pkg.version}`)
-      const tmpPath = path.resolve(os.tmpdir(), `scaffold-config-${Date.now()}`)
+      const tmpPath = generateUniqueTmpPath()
      try {
        log(config, LogLevel.debug, "Parsing config file...", config)
        const parsed = await parseConfigFile(config, tmpPath)
        await Scaffold(parsed)
+      } catch (e) {
+        const message = "message" in (e as any) ? (e as any).message : e?.toString()
+        log(config, LogLevel.error, message)
      } finally {
        log(config, LogLevel.debug, "Cleaning up temporary files...", tmpPath)
        await fs.rm(tmpPath, { recursive: true, force: true })
@@ -43,24 +48,20 @@ export async function parseCliArgs(args = process.argv.slice(2)) {
      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.",
+        "contents and file names will be replaced accordingly. You may omit the `--name` or `-n` " +
+        "for this specific option.",
      isDefault: true,
-      required: !isVersionFlag,
+      required: !isConfigProvided,
    })
    .option({
      name: "config",
      aliases: ["c"],
-      description:
-        "Filename to load config from instead of passing arguments to CLI or using a Node.js " +
-        "script. See examples for syntax. This can also work in conjunction with `--git` or `--github` to point " +
-        "to remote files, and with `--key` to denote which key to select from the file.",
+      description: "Filename or directory to load config from",
    })
    .option({
      name: "git",
      aliases: ["g"],
-      description:
-        "Git URL to load config from instead of passing arguments to CLI or using a Node.js script. See " +
-        "examples for syntax.",
+      description: "Git URL or GitHub path to load a template from.",
    })
    .option({
      name: "key",
@@ -143,6 +144,14 @@ export async function parseCliArgs(args = process.argv.slice(2)) {
        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"],
@@ -156,6 +165,67 @@ export async function parseCliArgs(args = process.argv.slice(2)) {
      aliases: ["v"],
      description: "Display version.",
    })
+    .command(
+      new MassargCommand<ListCommandCliOptions>({
+        name: "list",
+        aliases: ["ls"],
+        description: "List all available templates for a given config. See `list -h` for more information.",
+        run: async (_config) => {
+          const tmpPath = generateUniqueTmpPath()
+          const config = {
+            templates: [],
+            name: "",
+            version: false,
+            output: "",
+            subdir: false,
+            overwrite: false,
+            dryRun: false,
+            ..._config,
+            config: _config.config ?? (!_config.git ? process.cwd() : undefined),
+          }
+          try {
+            const file = await getConfigFile(config, tmpPath)
+            console.log(chalk.underline`Available templates:\n`)
+            console.log(Object.keys(file).join("\n"))
+          } catch (e) {
+            const message = "message" in (e as any) ? (e as any).message : e?.toString()
+            log(config, LogLevel.error, message)
+          } finally {
+            log(config, LogLevel.debug, "Cleaning up temporary files...", tmpPath)
+            await fs.rm(tmpPath, { 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: LogLevel.none,
+          description:
+            "Determine amount of logs to display. The values are: " +
+            `${chalk.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 LogLevel)) {
+              throw new Error(`Invalid log level: ${val}, must be one of: ${Object.keys(LogLevel).join(", ")}`)
+            }
+            return val
+          },
+        })
+        .help({
+          bindOption: true,
+        }),
+    )
    .example({
      description: "Usage with config file",
      input: "simple-scaffold -c scaffold.cmd.js --key component",
--- a/src/config.ts
+++ b/src/config.ts
@@ -1,4 +1,5 @@
 import path from "node:path"
+import fs from "node:fs/promises"
 import {
  ConfigLoadConfig,
  FileResponse,
@@ -9,11 +10,14 @@ import {
  ScaffoldCmdConfig,
  ScaffoldConfig,
  ScaffoldConfigFile,
+  ScaffoldConfigMap,
 } from "./types"
 import { handlebarsParse } from "./parser"
 import { log } from "./logger"
 import { resolve, wrapNoopResolver } from "./utils"
 import { getGitConfig } from "./git"
+import { createDirIfNotExists, getUniqueTmpPath, isDir, pathExists } from "./file"
+import { exec, spawn } from "node:child_process"

 /** @internal */
 export function getOptionValueForFile<T>(
@@ -48,57 +52,72 @@ function isWrappedWithQuotes(string: string): boolean {
 }

 /** @internal */
-export async function parseConfigFile(config: ScaffoldCmdConfig, tmpPath: string): Promise<ScaffoldConfig> {
-  let output: ScaffoldConfig = config
-
-  if (config.quiet) {
-    config.logLevel = LogLevel.none
-  }
-
+export async function getConfigFile(config: ScaffoldCmdConfig, tmpPath: string): Promise<ScaffoldConfigMap> {
  if (config.git && !config.git.includes("://")) {
    log(config, LogLevel.info, `Loading config from GitHub ${config.git}`)
    config.git = githubPartToUrl(config.git)
  }

-  const shouldLoadConfig = config.config || config.git
+  const isGit = Boolean(config.git)
+  const configFilename = config.config
+  const configPath = isGit ? config.git : configFilename
+
+  log(config, LogLevel.info, `Loading config from file ${configFilename}`)
+
+  const configPromise = await (isGit
+    ? getRemoteConfig({ git: configPath, config: configFilename, logLevel: config.logLevel, tmpPath })
+    : getLocalConfig({ config: configFilename, logLevel: config.logLevel }))
+
+  // resolve the config
+  let configImport = await resolve(configPromise, config)
+
+  // If the config is a function or promise, return the output
+  if (typeof configImport.default === "function" || configImport.default instanceof Promise) {
+    log(config, LogLevel.debug, "Config is a function or promise, resolving...")
+    configImport = await resolve(configImport.default, config)
+  }
+  return configImport
+}
+
+/** @internal */
+export async function parseConfigFile(config: ScaffoldCmdConfig, tmpPath: string): Promise<ScaffoldConfig> {
+  let output: ScaffoldConfig = { ...config, beforeWrite: undefined }
+
+  if (config.quiet) {
+    config.logLevel = LogLevel.none
+  }
+
+  const shouldLoadConfig = Boolean(config.config || config.git)

  if (shouldLoadConfig) {
-    const isGit = Boolean(config.git)
    const key = config.key ?? "default"
-    const configFilename = config.config
-    const configPath = isGit ? config.git : configFilename
-
-    log(config, LogLevel.info, `Loading config from ${configFilename} with key ${key}`)
-
-    const configPromise = await (isGit
-      ? getRemoteConfig({ git: configPath, config: configFilename, logLevel: config.logLevel, tmpPath })
-      : getLocalConfig({ config: configFilename, logLevel: config.logLevel }))
-
-    // resolve the config
-    let configImport = await resolve(configPromise, config)
-
-    // If the config is a function or promise, return the output
-    if (typeof configImport.default === "function" || configImport.default instanceof Promise) {
-      configImport = await resolve(configImport.default, config)
-    }
+    const configImport = await getConfigFile(config, tmpPath)

    if (!configImport[key]) {
-      throw new Error(`Template "${key}" not found in ${configFilename}`)
+      throw new Error(`Template "${key}" not found in ${config.config}`)
    }

-    const importedKey = configImport[key]
+    const imported = configImport[key]
+    log(config, LogLevel.debug, "Imported result", imported)
    output = {
      ...config,
-      ...importedKey,
+      ...imported,
+      beforeWrite: undefined,
      data: {
-        ...(importedKey as any).data,
+        ...(imported as any).data,
        ...config.data,
      },
    }
  }

  output.data = { ...output.data, ...config.appendData }
-  delete config.appendData
+  output.beforeWrite = config.beforeWrite ? wrapBeforeWrite(config, config.beforeWrite) : undefined
+
+  if (!output.name) {
+    throw new Error("simple-scaffold: Missing required option: name")
+  }
+
+  log(output, LogLevel.debug, "Parsed config", output)
  return output
 }

@@ -115,8 +134,22 @@ export function githubPartToUrl(part: string): string {
 export async function getLocalConfig(config: ConfigLoadConfig & Partial<LogConfig>): Promise<ScaffoldConfigFile> {
  const { config: configFile, ...logConfig } = config as Required<typeof config>

-  log(logConfig, LogLevel.info, `Loading config from file ${configFile}`)
  const absolutePath = path.resolve(process.cwd(), configFile)
+
+  const _isDir = await isDir(absolutePath)
+
+  if (_isDir) {
+    log(logConfig, LogLevel.debug, `Resolving config file from directory ${absolutePath}`)
+    const file = await findConfigFile(absolutePath)
+    const exists = await pathExists(file)
+    if (!exists) {
+      throw new Error(`Could not find config file in directory ${absolutePath}`)
+    }
+    log(logConfig, LogLevel.info, `Loading config from: ${path.resolve(absolutePath, file)}`)
+    return wrapNoopResolver(import(path.resolve(absolutePath, file)))
+  }
+
+  log(logConfig, LogLevel.info, `Loading config from: ${absolutePath}`)
  return wrapNoopResolver(import(absolutePath))
 }

@@ -138,3 +171,88 @@ export async function getRemoteConfig(

  return getGitConfig(url, configFile, tmpPath, logConfig)
 }
+
+/** @internal */
+export async function findConfigFile(root: string): Promise<string> {
+  const allowed = ["mjs", "cjs", "js", "json"].reduce((acc, ext) => {
+    acc.push(`scaffold.config.${ext}`)
+    acc.push(`scaffold.${ext}`)
+    return acc
+  }, [] as string[])
+  for (const file of allowed) {
+    const exists = await pathExists(path.resolve(root, file))
+    if (exists) {
+      return file
+    }
+  }
+  throw new Error(`Could not find config file in git repo`)
+}
+
+function wrapBeforeWrite(
+  config: LogConfig & Pick<ScaffoldConfig, "dryRun">,
+  beforeWrite: string,
+): ScaffoldConfig["beforeWrite"] {
+  return async (content, rawContent, outputFile) => {
+    const tmpPath = path.join(getUniqueTmpPath(), path.basename(outputFile))
+    await createDirIfNotExists(path.dirname(tmpPath), config)
+    const ext = path.extname(outputFile)
+    const rawTmpPath = tmpPath.replace(ext, ".raw" + ext)
+    try {
+      log(config, LogLevel.debug, "Parsing beforeWrite command", beforeWrite)
+      let cmd = await prepareBeforeWriteCmd({ beforeWrite, tmpPath, content, rawTmpPath, rawContent })
+      const result = await new Promise<string | undefined>((resolve, reject) => {
+        log(config, LogLevel.debug, "Running parsed beforeWrite command:", cmd)
+        const proc = exec(cmd)
+        proc.stdout!.on("data", (data) => {
+          if (data.trim()) {
+            resolve(data.toString())
+          } else {
+            resolve(undefined)
+          }
+        })
+        proc.stderr!.on("data", (data) => {
+          reject(data.toString())
+        })
+      })
+      return result
+    } catch (e) {
+      log(config, LogLevel.debug, e)
+      log(config, LogLevel.warning, "Error running beforeWrite command, returning original content")
+      return undefined
+    } finally {
+      await fs.rm(tmpPath, { force: true })
+      await fs.rm(rawTmpPath, { force: true })
+    }
+  }
+}
+
+async function prepareBeforeWriteCmd({
+  beforeWrite,
+  tmpPath,
+  content,
+  rawTmpPath,
+  rawContent,
+}: {
+  beforeWrite: string
+  tmpPath: string
+  content: Buffer
+  rawTmpPath: string
+  rawContent: Buffer
+}): Promise<string> {
+  let cmd: string = ""
+  const pathReg = /\{\{\s*path\s*\}\}/gi
+  const rawPathReg = /\{\{\s*rawpath\s*\}\}/gi
+  if (pathReg.test(beforeWrite)) {
+    await fs.writeFile(tmpPath, content)
+    cmd = beforeWrite.replaceAll(pathReg, tmpPath)
+  }
+  if (rawPathReg.test(beforeWrite)) {
+    await fs.writeFile(rawTmpPath, rawContent)
+    cmd = beforeWrite.replaceAll(rawPathReg, rawTmpPath)
+  }
+  if (!cmd) {
+    await fs.writeFile(tmpPath, content)
+    cmd = [beforeWrite, tmpPath].join(" ")
+  }
+  return cmd
+}
--- a/src/file.ts
+++ b/src/file.ts
@@ -1,7 +1,8 @@
+import os from "node:os"
 import path from "node:path"
-import { F_OK } from "node:constants"
-import { LogLevel, ScaffoldConfig } from "./types"
 import fs from "node:fs/promises"
+import { F_OK } from "node:constants"
+import { LogConfig, LogLevel, ScaffoldConfig } from "./types"
 import { glob, hasMagic } from "glob"
 import { log } from "./logger"
 import { getOptionValueForFile } from "./config"
@@ -10,7 +11,10 @@ import { handleErr } from "./utils"

 const { stat, access, mkdir, readFile, writeFile } = fs

-export async function createDirIfNotExists(dir: string, config: ScaffoldConfig): Promise<void> {
+export async function createDirIfNotExists(
+  dir: string,
+  config: LogConfig & Pick<ScaffoldConfig, "dryRun">,
+): Promise<void> {
  if (config.dryRun) {
    log(config, LogLevel.info, `Dry Run. Not creating dir ${dir}`)
    return
@@ -142,6 +146,7 @@ export async function copyFileTransformed(
    if (exists && overwrite) {
      log(config, LogLevel.info, `File ${outputPath} exists, overwriting`)
    }
+    log(config, LogLevel.debug, `Processing file ${inputPath}`)
    const templateBuffer = await readFile(inputPath)
    const unprocessedOutputContents = handlebarsParse(config, templateBuffer)
    const finalOutputContents =
@@ -149,7 +154,6 @@ export async function copyFileTransformed(

    if (!config.dryRun) {
      await writeFile(outputPath, finalOutputContents)
-      log(config, LogLevel.info, "Done.")
    } else {
      log(config, LogLevel.info, "Dry Run. Output should be:")
      log(config, LogLevel.info, finalOutputContents.toString())
@@ -157,6 +161,7 @@ export async function copyFileTransformed(
  } else if (exists) {
    log(config, LogLevel.info, `File ${outputPath} already exists, skipping`)
  }
+  log(config, LogLevel.info, "Done.")
 }

 export function getOutputDir(config: ScaffoldConfig, outputPathOpt: string, basePath: string): string {
@@ -209,3 +214,8 @@ export async function handleTemplateFile(
    }
  })
 }
+
+/** @internal */
+export function getUniqueTmpPath(): string {
+  return path.resolve(os.tmpdir(), `scaffold-config-${Date.now()}-${Math.random().toString(36).slice(2)}`)
+}
--- a/src/git.ts
+++ b/src/git.ts
@@ -1,9 +1,9 @@
 import path from "node:path"
-import fs from "node:fs/promises"
 import { log } from "./logger"
 import { AsyncResolver, LogConfig, LogLevel, ScaffoldCmdConfig, ScaffoldConfigMap } from "./types"
 import { spawn } from "node:child_process"
 import { resolve, wrapNoopResolver } from "./utils"
+import { findConfigFile } from "./config"

 export async function getGitConfig(
  url: URL,
@@ -60,22 +60,3 @@ export async function loadGitConfig({
  }
  return wrapNoopResolver(fixedConfig)
 }
-
-/** @internal */
-export async function findConfigFile(root: string): Promise<string> {
-  const allowed = ["mjs", "cjs", "js", "json"].reduce((acc, ext) => {
-    acc.push(`scaffold.config.${ext}`)
-    acc.push(`scaffold.${ext}`)
-    return acc
-  }, [] as string[])
-  for (const file of allowed) {
-    const exists = await fs
-      .stat(path.resolve(root, file))
-      .then(() => true)
-      .catch(() => false)
-    if (exists) {
-      return file
-    }
-  }
-  throw new Error(`Could not find config file in git repo`)
-}
--- a/src/logger.ts
+++ b/src/logger.ts
@@ -1,3 +1,4 @@
+import util from "util"
 import { LogConfig, LogLevel, ScaffoldConfig } from "./types"
 import chalk from "chalk"

@@ -30,7 +31,7 @@ export function log(config: LogConfig, level: LogLevel, ...obj: any[]): void {
      i instanceof Error
        ? chalkFn(i, JSON.stringify(i, undefined, 1), i.stack)
        : typeof i === "object"
-          ? chalkFn(JSON.stringify(i, undefined, 1))
+          ? util.inspect(i, { depth: null, colors: true })
          : chalkFn(i),
    ),
  )
--- a/src/parser.ts
+++ b/src/parser.ts
@@ -121,7 +121,7 @@ export function handlebarsParse(
    return Buffer.from(outputContents)
  } catch (e) {
    log(config, LogLevel.debug, e)
-    log(config, LogLevel.info, "Couldn't parse file with handlebars, returning original content")
+    log(config, LogLevel.warning, "Couldn't parse file with handlebars, returning original content")
    return Buffer.from(templateBuffer)
  }
 }
--- a/src/types.ts
+++ b/src/types.ts
@@ -368,6 +368,8 @@ export type ScaffoldCmdConfig = {
  git?: string
  /** Display version */
  version: boolean
+  /** Run a script before writing the files. This can be a command or a path to a file. The file contents will be passed to the given command. */
+  beforeWrite?: string
 }

 /**
@@ -413,3 +415,5 @@ export type RemoteConfigLoadConfig = LogConfig & Pick<ScaffoldCmdConfig, "config

 /** @internal */
 export type MinimalConfig = Pick<ScaffoldCmdConfig, "name" | "key">
+
+export type ListCommandCliOptions = Pick<ScaffoldCmdConfig, "config" | "git" | "logLevel" | "quiet">
--- a/tests/config.test.ts
+++ b/tests/config.test.ts
@@ -6,7 +6,7 @@ import * as config from "../src/config"
 import { resolve } from "../src/utils"
 // @ts-ignore
 import * as configFile from "../scaffold.config"
-import { findConfigFile } from "../src/git"
+import { findConfigFile } from "../src/config"

 jest.mock("../src/git", () => {
  return {
@@ -72,16 +72,18 @@ describe("config", () => {
        await parseConfigFile(
          {
            ...blankCliConf,
+            name: "-",
          },
          `/tmp/scaffold-config-${Date.now()}`,
        ),
-      ).toEqual(blankCliConf)
+      ).toEqual({ ...blankCliConf, name: "-" })
    })
    describe("appendData", () => {
      test("appends", async () => {
        const result = await parseConfigFile(
          {
            ...blankCliConf,
+            name: "-",
            appendData: { key: "value" },
          },
          `/tmp/scaffold-config-${Date.now()}`,
@@ -92,6 +94,7 @@ describe("config", () => {
        const result = await parseConfigFile(
          {
            ...blankCliConf,
+            name: "-",
            data: { num: "123" },
            appendData: { num: "1234" },
          },
Author	SHA1	Message	Date
semantic-release-bot	df6c351cb0	chore(release): 2.2.0 [skip ci] # [2.2.0](https://github.com/chenasraf/simple-scaffold/compare/v2.1.0...v2.2.0) (2024-02-23) ### Features * `list` command ([`d579c09`](`d579c09c11`)) * add `--before-write` cli option ([#89](https://github.com/chenasraf/simple-scaffold/issues/89)) ([`5f810e2`](`5f810e2116`))	2024-02-23 22:42:32 +00:00
Chen Asraf	5f810e2116	feat: add `--before-write` cli option (#89 ) * feat: add `--before-write` cli option * refactor: cleanup before write wrapper * docs: add before-write docs	2024-02-24 00:41:56 +02:00
Chen Asraf	d579c09c11	feat: `list` command	2024-02-24 00:41:56 +02:00
Chen Asraf	3765398ab9	ci: attemp to fix pack cmd	2024-02-24 00:41:56 +02:00
semantic-release-bot	9be8a8b71b	chore(release): 2.1.0 [skip ci] # [2.1.0](https://github.com/chenasraf/simple-scaffold/compare/v2.0.2...v2.1.0) (2024-02-12) ### Features * support directory in --config flag ([`e48b832`](`e48b832e0b`)) * support providing name in config ([`4e7ac34`](`4e7ac34db9`))	2024-02-12 23:39:35 +00:00
Chen Asraf	5cb8c3c081	docs: update navbar logo	2024-02-13 01:39:04 +02:00
Chen Asraf	3b52c255f0	chore: dry	2024-02-13 01:39:04 +02:00
Chen Asraf	80cf2076b0	chore: update dependencies	2024-02-13 01:39:04 +02:00
Chen Asraf	4fd710b763	test: fix tests	2024-02-13 01:39:04 +02:00
Chen Asraf	4e7ac34db9	feat: support providing name in config	2024-02-13 01:39:04 +02:00
Chen Asraf	e48b832e0b	feat: support directory in --config flag	2024-02-13 01:39:04 +02:00
Chen Asraf	06ffa656ae	docs: update templates page	2024-02-13 01:39:04 +02:00
Chen Asraf	919fd54ebb	docs: usage page order	2024-02-13 01:39:04 +02:00