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,36 @@
 # 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)
+
+
+### 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)
 
 

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
 

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.

docs/docs/usage/03-cli.md

@@ -0,0 +1,130 @@
+---
+title: CLI Usage
+---
+
+## Available flags
+
+```text
+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`.
+
+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
+
+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.
+
+## Available Commands:
+
+| Command \| Alias | Description                                                                          |
+| ---------------- | ------------------------------------------------------------------------------------ |
+| `list` \| `ls`   | List all available templates for a given config. See `list -h` for more information. |
+
+## Examples:
+
+> See
+> [Configuration Files](https://chenasraf.github.io/simple-scaffold/docs/usage/configuration_files)
+> for organizing multiple scaffold types into easy-to-maintain files
+
+Usage with config file
+
+```shell
+$ simple-scaffold -c scaffold.cmd.js -k component MyComponent
+```
+
+Usage with GitHub config file
+
+```shell
+$ simple-scaffold -g chenasraf/simple-scaffold -k component MyComponent
+```
+
+Usage with https git URL (for non-GitHub)
+
+```shell
+$ simple-scaffold \
+      -g https://example.com/user/template.git \
+      -c scaffold.cmd.js \
+      -k component \
+      MyComponent
+```
+
+Full syntax with config path and template key (applicable to all above methods)
+
+```shell
+$ simple-scaffold -c scaffold.cmd.js -k component MyComponent
+```
+
+Excluded template key, assumes 'default' key
+
+```shell
+$ simple-scaffold -c scaffold.cmd.js MyComponent
+```
+
+Shortest syntax for GitHub, assumes file 'scaffold.cmd.js' and template key 'default'
+
+```shell
+$ simple-scaffold -g chenasraf/simple-scaffold MyComponent
+```
+
+You can also add this as a script in your `package.json`:
+
+```json
+{
+  "scripts": {
+    "scaffold-cfg": "npx simple-scaffold -c scaffold.cmd.js -k component",
+    "scaffold-gh": "npx simple-scaffold -g chenasraf/simple-scaffold -k component",
+    "scaffold": "npx simple-scaffold@latest -t scaffolds/component/**/* -o src/components -d '{\"myProp\": \"propName\", \"myVal\": 123}'"
+    "scaffold-component":  "npx simple-scaffold -c scaffold.cmd.js -k"
+  }
+}
+```

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.
 
@@ -17,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,
@@ -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
@@ -42,15 +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(" "),
   },
-  beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase()
+  // 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(),
 }
 
 const scaffold = Scaffold(config)

docs/docs/usage/cli.md

@@ -1,90 +0,0 @@
----
-title: CLI Usage
----
-
-## Available flags
-
-```text
-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.                                                                                                                                                                                                                                                           |
-
-## Examples:
-
-> See
-> [Configuration Files](https://chenasraf.github.io/simple-scaffold/docs/usage/configuration_files)
-> for organizing multiple scaffold types into easy-to-maintain files
-
-Usage with config file
-
-```shell
-$ simple-scaffold -c scaffold.cmd.js -k component MyComponent
-```
-
-Usage with GitHub config file
-
-```shell
-$ simple-scaffold -g chenasraf/simple-scaffold -k component MyComponent
-```
-
-Usage with https git URL (for non-GitHub)
-
-```shell
-$ simple-scaffold \
-      -g https://example.com/user/template.git \
-      -c scaffold.cmd.js \
-      -k component \
-      MyComponent
-```
-
-Full syntax with config path and template key (applicable to all above methods)
-
-```shell
-$ simple-scaffold -c scaffold.cmd.js -k component MyComponent
-```
-
-Excluded template key, assumes 'default' key
-
-```shell
-$ simple-scaffold -c scaffold.cmd.js MyComponent
-```
-
-Shortest syntax for GitHub, assumes file 'scaffold.cmd.js' and template key 'default'
-
-```shell
-$ simple-scaffold -g chenasraf/simple-scaffold MyComponent
-```
-
-You can also add this as a script in your `package.json`:
-
-```json
-{
-  "scripts": {
-    "scaffold-cfg": "npx simple-scaffold -c scaffold.cmd.js -k component",
-    "scaffold-gh": "npx simple-scaffold -g chenasraf/simple-scaffold -k component",
-    "scaffold": "npx simple-scaffold@latest -t scaffolds/component/**/* -o src/components -d '{\"myProp\": \"propName\", \"myVal\": 123}'"
-    "scaffold-component":  "npx simple-scaffold -c scaffold.cmd.js -k"
-  }
-}
-```

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: [
         {

examples/test-input/Component/{{pascalCase name}}.tsx

@@ -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}}

package.json

@@ -1,8 +1,8 @@
 {
   "name": "simple-scaffold",
-  "version": "2.0.2",
+  "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",
-    "@types/jest": "^29.5.11",
+    "@semantic-release/release-notes-generator": "^14.0.1",
+    "@types/jest": "^29.5.12",
     "@types/mock-fs": "^4.13.4",
-    "@types/node": "^20.11.14",
+    "@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.0",
+    "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"
   }
 }

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),

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: "---",
+    },
   }
 }

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",
@@ -73,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,
     })
@@ -119,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",
@@ -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",

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,73 @@ 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
+  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")
+  }
+
+  log(output, LogLevel.debug, "Parsed config", output)
   return output
 }
 
@@ -115,8 +135,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 +172,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
+}

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)}`)
+}

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`)
-}

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),
     ),
   )

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>
@@ -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">

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" },
           },

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({