v1.1.2

Fix binary file copy

.editorconfig

@@ -0,0 +1,8 @@
+[*]
+tab_width = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: casraf
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug, needs-triage
+assignees: chenasraf
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Prepare templates:
+    ```
+    template contents
+    ```
+2. Run with args/config:
+    ```
+    npx simple-scaffold@latest -t ... -o output TplName
+    ```
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, paste your logs to help explain your problem.
+To see more logs, run the scaffold with `-v 1` to enable debug logging.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+- Node.js: [e.g. 16.8]
+ - Simple Scaffold Version [e.g. 1.0.4]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement, needs-triage
+assignees: chenasraf
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/develop.yml

@@ -0,0 +1,52 @@
+name: Alpha Releases
+
+on:
+  push:
+    branches: [develop]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+      - run: yarn install --frozen-lockfile
+      - run: yarn test
+      - run: yarn build
+      - run: cd ./dist && yarn pack --filename=../package.tgz
+        if: "contains(github.event.head_commit.message, '[publish]')"
+      - uses: Klemensas/action-autotag@stable
+        if: "contains(github.event.head_commit.message, '[publish]')"
+        id: update_tag
+        with:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          tag_prefix: "v"
+      - name: Publish on NPM
+        uses: JS-DevTools/npm-publish@v1
+        if: "contains(github.event.head_commit.message, '[publish]')"
+        with:
+          package: ./dist/package.json
+          token: "${{ secrets.NPM_TOKEN }}"
+      - name: Create Release
+        if: steps.update_tag.outputs.tagname && contains(github.event.head_commit.message, '[publish]')
+        uses: actions/create-release@v1
+        id: create_release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          prerelease: true
+          tag_name: ${{ steps.update_tag.outputs.tagname }}
+          release_name: Release ${{ steps.update_tag.outputs.tagname }}
+      - name: Upload Release Asset
+        if: steps.update_tag.outputs.tagname && contains(github.event.head_commit.message, '[publish]')
+        id: upload-release-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./package.tgz
+          asset_name: simple-scaffold ${{ steps.update_tag.outputs.tagname }}.tgz
+          asset_content_type: application/tgz

.github/workflows/docs.yml

@@ -0,0 +1,21 @@
+name: Build Documentation
+
+on:
+  push:
+    branches: [master, develop]
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, '[skip docs]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+      - run: cd doc-theme && yarn install && yarn build && rm -rf node_modules && cd ..
+      - run: yarn install --frozen-lockfile
+      - run: yarn typedoc
+      - uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

.github/workflows/pull_requests.yml

@@ -0,0 +1,17 @@
+name: Pull Requests
+
+on:
+  pull_request:
+    branches: [master, develop]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      - run: yarn test

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  push:
+    branches: [master]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+      - run: yarn install --frozen-lockfile
+      - run: yarn test
+      - run: yarn build
+      - run: cd ./dist && yarn pack --filename=../package.tgz
+        if: "!contains(github.event.head_commit.message, '[skip publish]')"
+      - uses: Klemensas/action-autotag@stable
+        if: "!contains(github.event.head_commit.message, '[skip publish]')"
+        id: update_tag
+        with:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          tag_prefix: "v"
+      - name: Publish on NPM
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          package: ./dist/package.json
+          token: "${{ secrets.NPM_TOKEN }}"
+      - name: Create Release
+        if: steps.update_tag.outputs.tagname && !contains(github.event.head_commit.message, '[skip publish]')
+        uses: actions/create-release@v1
+        id: create_release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.update_tag.outputs.tagname }}
+          release_name: Release ${{ steps.update_tag.outputs.tagname }}
+      - name: Upload Release Asset
+        if: steps.update_tag.outputs.tagname && !contains(github.event.head_commit.message, '[skip publish]')
+        id: upload-release-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./package.tgz
+          asset_name: simple-scaffold ${{ steps.update_tag.outputs.tagname }}.tgz
+          asset_content_type: application/tgz

.gitignore

@@ -58,4 +58,7 @@ typings/
 .env
 
 examples/test-output/**/*
-!examples/test-output/.gitkeep
+dist/
+.DS_Store
+tmp/
+docs/

.markdownlint.json

@@ -0,0 +1,9 @@
+{
+  "line-length": {
+    "line_length": 100,
+    "tables": false,
+    "code_blocks": false
+  },
+  "no-inline-html": false,
+  "first-line-h1": false
+}

.prettierrc

@@ -1,3 +1,5 @@
 {
-    "semi": false
-}
+  "semi": false,
+  "printWidth": 120,
+  "tabWidth": 2
+}

.vscode/settings.json

@@ -1,4 +1,20 @@
 {
   "typescript.tsdk": "./node_modules/typescript/lib",
-  "npm.packageManager": "yarn"
+  "npm.packageManager": "yarn",
+  "cSpell.words": [
+    "massarg",
+    "myname",
+    "nobrace",
+    "nocomment",
+    "nodir",
+    "noext",
+    "nonegate",
+    "subdir"
+  ],
+  "[markdown]": {
+    "editor.rulers": [
+      87,
+      100
+    ],
+  },
 }

.vscode/tasks.json

@@ -13,6 +13,12 @@
       "type": "npm",
       "problemMatcher": [],
     },
+    {
+      "command": "yarn typedoc --watch",
+      "label": "typedoc --watch",
+      "type": "shell",
+      "problemMatcher": [],
+    },
     {
       "script": "start",
       "label": "start",
@@ -25,6 +31,12 @@
       "type": "npm",
       "problemMatcher": [],
     },
+    {
+      "command": "yarn test --watchAll",
+      "label": "yarn test --watchAll",
+      "type": "shell",
+      "problemMatcher": [],
+    },
     {
       "script": "cmd",
       "label": "cmd",

MIGRATION.md

@@ -0,0 +1,21 @@
+# Migrating from 0.x to 1.0
+
+In Simple Scaffold v1.0, the entire codebase was overhauled, yet usage remains mostly the same
+between versions. With these notable exceptions:
+
+- Some of the argument names have changed
+- Template syntax has been improved
+- The command to run Scaffold has been simplified from `new SimpleScaffold(opts).run()` to `SimpleScaffold(opts)`, which now returns a promise that you can await to know when the process has been completed.
+
+## Argument changes
+
+- `locals` has been renamed to `data`. The appropriate command line args have been updated as
+  well to `--data` | `-d`.
+
+## Template syntax changes
+
+Simple Scaffold still uses Handlebars.js to handle template content and file names. However, helpers
+have been added to remove the need for you to pre-process the template data on simple use-cases such
+as case type manipulation (converting to camel case, snake case, etc)
+
+See the readme for the full information on how to use these helpers and which are available.

README.md

@@ -1,6 +1,53 @@
-# simple-scaffold
+<h1 align="center">Simple Scaffold</h1>
 
-Simple Scaffold allows you to create your structured files based on templates.
+<h2 align="center">
+
+[GitHub](https://github.com/chenasraf/simple-scaffold) |
+[Documentation](https://casraf.blog/simple-scaffold) |
+[NPM](https://npmjs.com/package/simple-scaffold) |
+[casraf.blog](https://casraf.blog)
+
+</h2>
+
+Simple Scaffold allows you to generate any set of files in the easiest way possible with simple commands.
+
+It is completely framework agnostic so you can use it for anything from a few simple files to an
+entire app boilerplate setup.
+
+Simply organize your commonly-created files in their original structure, and running Simple Scaffold
+will copy the files to the output path, while replacing values (such as component or app name, or
+other custom data) inside the paths or contents of the files using Handlebars.js syntax.
+
+<br />
+
+<details>
+  <summary>Table of contents</summary>
+
+- [Install](#install)
+- [Command Line Interface (CLI)](#command-line-interface-cli)
+  - [Available flags](#available-flags)
+- [Node module](#node-module)
+  - [Node-specific options](#node-specific-options)
+- [Preparing files](#preparing-files)
+  - [Template files](#template-files)
+  - [Variable/token replacement](#variabletoken-replacement)
+  - [Helpers](#helpers)
+    - [Built-in Helpers](#built-in-helpers)
+      - [Capitalization Helpers](#capitalization-helpers)
+      - [Date helpers](#date-helpers)
+    - [Custom Helpers](#custom-helpers)
+- [Examples](#examples)
+  - [Run](#run)
+    - [Command Example](#command-example)
+    - [Node Module Example](#node-module-example)
+  - [Files](#files)
+    - [Input](#input)
+    - [Output](#output)
+- [Contributing](#contributing)
+
+</details>
+
+---
 
 ## Install
 
@@ -11,154 +58,367 @@ You can either use it as a command line tool or import into your own code and ru
 npm install [-g] simple-scaffold
 # yarn
 yarn [global] add simple-scaffold
+# run without installing
+npx simple-scaffold@latest <...args>
 ```
 
-## Use as a command line tool
+## Command Line Interface (CLI)
 
-### Command Line Options
+### Available flags
 
-```plaintext
-Scaffold Generator
+The following is the help text from the `simple-scaffold` binary. To see this and more
+information anytime, add the `-h` or `--help` flag to your call, e.g.
+`npx simple-scaffold@latest -h`.
 
-  Generate scaffolds for your project based on file templates.
-  Usage: simple-scaffold scaffold-name [options]
+```text
+Usage: simple-scaffold [options]
 
-Options
+Create structured files based on templates.
 
-  -n, --name string                 Component output name                                                         
-  -t, --templates File[]            A glob pattern of template files to load.                                     
-                                    A template file may be of any type and extension, and supports Handlebars as  
-                                    a parsing engine for the file names and contents, so you may customize both   
-                                    with variables from your configuration.                                       
-  -o, --output File                 The output directory to put the new files in. They will attempt to maintain   
-                                    their regular structure as they are found, if possible.                       
-  -l, --locals JSON string          A JSON string for the template to use in parsing.                             
-  -w, --overwrite Boolean           Whether to overwrite files when they are found to already exist. Default=true 
-  -q, --quiet Boolean               When set to true, logs will not output (including warnings and errors).       
-                                    Default=false                                                                 
-  -S, --create-sub-folder Boolean   Whether to create a subdirectory with {{Name}} in the output directory.       
-                                    Default=true                                                                  
-  -h, --help                        Display this help message      
+Options:
+
+  --help|-h                       Display help information
+
+  --name|-n                       Name to be passed to the generated files. {{name}}
+                                  and {{Name}} inside contents and file names will be
+                                  replaced accordingly.
+
+  --output|-o                     Path to output to. If --create-sub-folder is enabled,
+                                  the subfolder will be created inside this path.
+                                  (default: current dir)
+
+  --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. (default: false)
+
+  --data|-d                       Add custom data to the templates. By default, only
+                                  your app name is included.
+
+  --create-sub-folder|-s          Create subfolder with the input name (default: false)
+
+  --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 --verbose 0)
+                                  (default: false)
+
+  --verbose|-v                    Determine amount of logs to display. The values are:
+                                  0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4
+                                  (error). The provided level will display messages of
+                                  the same level or higher. (default:
+                                  2)
+
+  --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)
 ```
 
-You can add this as a script in your `package.json`:
+You can also add this as a script in your `package.json`:
 
 ```json
 {
   "scripts": {
-    "scaffold": "yarn simple-scaffold --template scaffolds/component/**/* --output src/components --locals myProp=\"propname\",myVal=123"
+    "scaffold": "npx simple-scaffold@latest -t scaffolds/component/**/* -o src/components -d '{\"myProp\": \"propName\", \"myVal\": 123}'"
   }
 }
 ```
 
-## Scaffolding
+## Node module
 
-Scaffolding will replace {{vars}} in both the file name and its contents and put the transformed files
-in `<output>/<{{Name}}>`, as per the Handlebars formatting rules.
+You can also build the scaffold yourself, if you want to create more complex arguments or scaffold
+groups - simply pass a config object to the Scaffold function when you are ready to start.
 
-Your context will be pre-populated with the following:
-
-- `{{Name}}`: CapitalizedName of the component
-- `{{name}}`: camelCasedName of the component
-
-Any `locals` you add in the config will populate with their names wrapped in `{{` and `}}`.
-They are all stringified, so be sure to parse them accordingly by creating a script, if necessary.
-
-### Use in Node.js
-
-You can also build the scaffold yourself, if you want to create more complex arguments or scaffold groups.
-Simply pass a config object to the constructor, and invoke `run()` when you are ready to start.
 The config takes similar arguments to the command line:
 
-```javascript
-const SimpleScaffold = require("simple-scaffold").default
+```typescript
+import Scaffold from "simple-scaffold"
 
-const scaffold = new SimpleScaffold({
+const config = {
   name: "component",
   templates: [path.join(__dirname, "scaffolds", "component")],
   output: path.join(__dirname, "src", "components"),
   createSubFolder: true,
-  locals: {
+  subFolderNameHelper: "upperCase"
+  data: {
     property: "value",
   },
-}).run()
+  helpers: {
+    twice: (text) => [text, text].join(" ")
+  },
+  beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase()
+}
+
+const scaffold = Scaffold(config)
 ```
 
-The exception in the config is that `output`, when used in Node directly, may also be passed a
-function for each input file to output into a dynamic path:
+### Node-specific options
 
-```javascript
-config.output = (fullPath, baseDir, baseName) => {
-  console.log({ fullPath, baseDir, baseName })
-  return [baseDir, baseName].join(path.sep)
+In addition to all the options available in the command line, there are some Node/JS-specific
+options available:
+
+| Option        | Type                                                                                                                                   | Description                                                                                                                                                                                                                                                                                                             |
+| ------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `output`      |                                                                                                                                        | In addition to being passed the same as CLI, it may also be passed a function for each input file to output into a dynamic path: `{ output: (fullPath, baseDir, baseName) => path.resolve(baseDir, baseName) }`                                                                                                         |
+| `helpers`     | `Record<string, (string) => string>`                                                                                                   | Helpers are simple functions that transform your `data` variables into other values. See [Helpers](#helpers) for the list of default helpers, or add your own to be loaded into the template parser.                                                                                                                    |
+| `beforeWrite` | `(content: Buffer, rawContent: Buffer, outputPath: string) => Promise<String \| Buffer \| undefined> \| String \| Buffer \| undefined` | Supply this function to override the final output contents of each of your files, allowing you to add more pre-processing to your generator pipeline. The return value of this function will replace the output content of the respective file, which you may discriminate (if needed) using the `outputPath` argument. |
+
+## Preparing files
+
+### Template files
+
+Put your template files anywhere, and fill them with tokens for replacement.
+
+Each template (not file) in the config array is parsed individually, and copied to the output
+directory. If a single template path contains multiple files (e.g. if you use a folder path or a
+glob pattern), the first directory up the tree of that template will become the base inside the
+defined output path for that template, while copying files recursively and maintaining their
+relative structure.
+
+Examples:
+
+> In the following examples, the config `name` is `AppName`, and the config `output` is `src`.
+
+| Input template                | Files in template                                      | Output path(s)                                               |
+| ----------------------------- | ------------------------------------------------------ | ------------------------------------------------------------ |
+| `./templates/{{ name }}.txt`  | `./templates/{{ name }}.txt`                           | `src/AppName.txt`                                            |
+| `./templates/directory`       | `outer/{{name}}.txt`,<br />`outer2/inner/{{name}}.txt` | `src/outer/AppName.txt`,<br />`src/outer2/inner/AppName.txt` |
+| `./templates/others/**/*.txt` | `outer/{{name}}.jpg`,<br />`outer2/inner/{{name}}.txt` | `src/outer2/inner/AppName.txt`                               |
+
+### Variable/token replacement
+
+Scaffolding will replace `{{ varName }}` in both the file name and its contents and put the
+transformed files in the output directory.
+
+The data available for the template parser is the data you pass to the `data` config option (or
+`--data` argument in CLI).
+
+For example, using the following command:
+
+```bash
+npx simple-scaffold@latest \
+  --templates templates/components/{{name}}.jsx \
+  --output src/components \
+  --create-sub-folder true \
+  MyComponent
+```
+
+Will output a file with the path:
+
+```text
+<working_dir>/src/components/MyComponent.jsx
+```
+
+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.
+> Any `data` you add in the config will be available for use with their names wrapped in
+> `{{` and `}}`. Other Handlebars built-ins such as `each`, `if` and `with` are also supported, see
+> [Handlebars.js Language Features](https://handlebarsjs.com/guide/#language-features) for more
+> information.
+
+### Helpers
+
+#### Built-in Helpers
+
+Simple-Scaffold provides some built-in text transformation filters usable by Handlebars.
+
+For example, you may use `{{ snakeCase name }}` inside a template file or filename, and it will
+replace `My Name` with `my_name` when producing the final value.
+
+##### Capitalization Helpers
+
+| Helper name  | Example code            | Example output |
+| ------------ | ----------------------- | -------------- |
+| [None]       | `{{ name }}`            | my name        |
+| `camelCase`  | `{{ camelCase name }}`  | myName         |
+| `snakeCase`  | `{{ snakeCase name }}`  | my_name        |
+| `startCase`  | `{{ startCase name }}`  | My Name        |
+| `kebabCase`  | `{{ kebabCase name }}`  | my-name        |
+| `hyphenCase` | `{{ hyphenCase name }}` | my-name        |
+| `pascalCase` | `{{ pascalCase name }}` | MyName         |
+| `upperCase`  | `{{ upperCase name }}`  | MY NAME        |
+| `lowerCase`  | `{{ lowerCase name }}`  | my name        |
+
+##### Date helpers
+
+| Helper name                      | Description                                                      | Example code                                                     | Example output     |
+| -------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------ |
+| `now`                            | Current date with format                                         | `{{ now "yyyy-MM-dd HH:mm" }}`                                   | `2042-01-01 15:00` |
+| `now` (with offset)              | Current date with format, and with offset                        | `{{ now "yyyy-MM-dd HH:mm" -1 "hours" }}`                        | `2042-01-01 14:00` |
+| `date`                           | Custom date with format                                          | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" }}`           | `2042-01-01 15:00` |
+| `date` (with offset)             | Custom date with format, and with offset                         | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" -1 "days" }}` | `2041-31-12 15:00` |
+| `date` (with date from `--data`) | Custom date with format, with data from the `data` config option | `{{ date myCustomDate "yyyy-MM-dd HH:mm" }}`                     | `2042-01-01 12:00` |
+
+Further details:
+
+- We use [`date-fns`](https://date-fns.org/docs/) for parsing/manipulating the dates.
+  If you want more information on the date tokens to use, refer to
+  [their format documentation](https://date-fns.org/docs/format).
+
+- The date helper format takes the following arguments:
+
+  ```typescript
+  (
+    date: string,
+    format: string,
+    offsetAmount?: number,
+    offsetType?: "years" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds"
+  )
+  ```
+
+- **The now helper** (for current time) takes the same arguments, minus the first one (`date`) as
+  it is implicitly the current date.
+
+#### Custom Helpers
+
+You may also add your own custom helpers using the `helpers` options when using the JS API (rather
+than the CLI). The `helpers` option takes an object whose keys are helper names, and values are
+the transformation functions. For example, `upperCase` is implemented like so:
+
+```typescript
+config.helpers = {
+  upperCase: (text) => text.toUpperCase(),
 }
 ```
 
-## Example Scaffold Input
+All of the above helpers (built in and custom) will also be available to you when using
+`subFolderNameHelper` (`--sub-folder-name-helper`/`-sh`) as a possible value.
 
-### Input directory structure
+> To see more information on how helpers work and more features, see
+> [Handlebars.js docs](https://handlebarsjs.com/guide/#custom-helpers).
 
-```plaintext
-- project
-    - scaffold
-        - {{Name}}.js
-    - src
-        - components
-        - ...
-```
+## Examples
 
-#### project/scaffold/{{Name}}.js
+### Run
 
-```js
-const React = require('react')
-
-module.exports = class {{Name}} extends React.Component {
-  render() {
-    <div className="{{className}}">{{Name}} Component</div>
-  }
-}
-```
-
-### Run Example
+#### Command Example
 
 ```bash
 simple-scaffold MyComponent \
     -t project/scaffold/**/* \
     -o src/components \
-    -l className=my-component
+    -d '{"className": "myClassName"}'
+    MyComponent
 ```
 
-## Example Scaffold Output
+#### Node Module Example
 
-### Output directory structure
+```typescript
+import Scaffold from "simple-scaffold"
 
-```plaintext
-- project
-    - src
-        - components
-            - MyComponent
-                - MyComponent.js
-        - ...
-```
-
-With `createSubfolder = false`:
-
-```plaintext
-- project
-    - src
-        - components
-            - MyComponent.js
-        - ...
-```
-
-#### project/scaffold/MyComponent/MyComponent.js
-
-```js
-const React = require("react")
-
-module.exports = class MyComponent extends React.Component {
-  render() {
-    <div className="my-component">MyComponent Component</div>
-  }
+async function main() {
+  await Scaffold({
+    name: "MyComponent",
+    templates: ["project/scaffold/**/*"],
+    output: ["src/components"],
+    data: {
+      className: "myClassName",
+    },
+  })
+  console.log("Done.")
 }
 ```
+
+### Files
+
+#### Input
+
+Input file path:
+
+```text
+project → scaffold → {{Name}}.js → src → components
+```
+
+Input file contents:
+
+```typescript
+import React from 'react'
+
+export default {{camelCase name}}: React.FC = (props) => {
+  return (
+    <div className="{{className}}">{{camelCase name}} Component</div>
+  )
+}
+```
+
+#### Output
+
+Output file path:
+
+- With `createSubFolder = false` (default):
+
+  ```text
+  project → src → components → MyComponent.js
+  ```
+
+- With `createSubFolder = true`:
+
+  ```text
+  project → src → components → MyComponent → MyComponent.js
+  ```
+
+- With `createSubFolder = true` and `subFolderNameHelper = 'upperCase'`:
+
+  ```text
+  project → src → components → MYCOMPONENT → MyComponent.js
+  ```
+
+Output file contents:
+
+```typescript
+import React from 'react'
+
+export default MyComponent: React.FC = (props) => {
+  return (
+    <div className="myClassName">MyComponent Component</div>
+  )
+}
+```
+
+## Contributing
+
+I am developing this package on my free time, so any support, whether code, issues, or just stars
+is very helpful to sustaining its life. If you would like to donate a bit to help keep the project
+alive, I would be very thankful!
+
+<a href='https://ko-fi.com/casraf' target='_blank'>
+  <img height='36' style='border:0px;height:36px;'
+    src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3'
+    alt='Buy Me a Coffee at ko-fi.com' />
+</a>
+
+I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature,
+don't hesitate to open an appropriate issue and I will do my best to reply promptly.
+
+If you are a developer and want to contribute code, here are some starting tips:
+
+1. Fork this repository
+2. Run `yarn install`
+3. Run `yarn dev` to start file watch mode
+4. Make any changes you would like
+5. Create tests for your changes
+6. Update the relevant documentation (readme, code comments, type comments)
+7. Create a PR on upstream
+
+Some tips on getting around the code:
+
+- Use `yarn dev` for development - it runs TypeScript compile in watch mode, allowing you to make
+  changes and immediately be able to try them using `yarn cmd`.
+- Use `yarn build` to build the output
+- Use `yarn test` to run tests
+- Use `yarn cmd` to use the CLI feature of Simple Scaffold from within the root directory,
+  enabling you to test different behaviors. See `yarn cmd -h` for more information.
+
+  > This requires an updated build, and does not trigger one itself. Either use `yarn dev` to watch
+  > for changes and build, or `yarn build` before running this, or use `yarn build-cmd` instead,
+  > which triggers a build right before running the command with the rest of the given arguments.

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: ["@babel/plugin-proposal-nullish-coalescing-operator"],
+}

cmd.ts

@@ -1,135 +0,0 @@
-import SimpleScaffold from "./scaffold"
-import * as fs from "fs"
-import { IScaffold } from "./index"
-import * as cliArgs from "command-line-args"
-import * as cliUsage from "command-line-usage"
-import * as path from "path"
-
-type Def = cliArgs.OptionDefinition & {
-  description?: string
-  typeLabel?: string
-}
-
-function localsParser(content: string) {
-  return JSON.parse(content)
-}
-
-function filePathParser(content: string) {
-  if (content.startsWith("/")) {
-    return content
-  }
-  return [process.cwd(), content].join(path.sep)
-}
-
-function booleanParser(text: string) {
-  return text && text.trim().length
-    ? ["true", "1", "on"].includes(text.trim())
-    : true
-}
-
-const defs: Def[] = [
-  {
-    name: "name",
-    alias: "n",
-    type: String,
-    description: "Component output name",
-    defaultOption: true,
-  },
-  {
-    name: "templates",
-    alias: "t",
-    type: filePathParser,
-    typeLabel: "{underline File}[]",
-    description: `A glob pattern of template files to load.\nA template file may be of any type and extension, and supports Handlebars as a parsing engine for the file names and contents, so you may customize both with variables from your configuration.`,
-    multiple: true,
-  },
-  {
-    name: "output",
-    alias: "o",
-    type: filePathParser,
-    typeLabel: "{underline File}",
-    description: `The output directory to put the new files in. They will attempt to maintain their regular structure as they are found, if possible.`,
-  },
-  {
-    name: "locals",
-    alias: "l",
-    description: `A JSON string for the template to use in parsing.`,
-    typeLabel: "{underline JSON string}",
-    type: localsParser,
-  },
-  {
-    name: "overwrite",
-    alias: "w",
-    description: `Whether to overwrite files when they are found to already exist. {bold Default=true}`,
-    type: booleanParser,
-    typeLabel: "{underline Boolean}",
-    defaultValue: true,
-  },
-  {
-    name: "quiet",
-    alias: "q",
-    description:
-      "When set to {bold true}, logs will not output (including warnings and errors). {bold Default=false}",
-    type: booleanParser,
-    typeLabel: "{underline Boolean}",
-    defaultValue: false,
-  },
-  {
-    name: "create-sub-folder",
-    alias: "S",
-    typeLabel: "{underline Boolean}",
-    description:
-      "Whether to create a subdirectory with \\{\\{Name\\}\\} in the {underline output} directory. {bold Default=true}",
-    type: booleanParser,
-    defaultValue: true,
-  },
-  {
-    name: "help",
-    alias: "h",
-    type: Boolean,
-    description: "Display this help message",
-  },
-]
-
-const args = cliArgs(defs, { camelCase: true }) as Omit<
-  IScaffold.Config,
-  "createSubFolder"
-> & {
-  help: boolean
-  createSubFolder: boolean
-}
-
-const help = [
-  {
-    header: "Scaffold Generator",
-    content: `Generate scaffolds for your project based on file templates.\nUsage: {bold simple-scaffold} {underline scaffold-name} {underline [options]}`,
-  },
-  { header: "Options", optionList: defs },
-]
-
-if (args.createSubFolder === null) {
-  args.createSubFolder = true
-}
-
-if (args.quiet === null) {
-  args.quiet = true
-}
-
-if (args.help || !args.name) {
-  console.log(cliUsage(help))
-  process.exit(0)
-}
-
-if (!args.quiet) {
-  console.info("Config:", args)
-}
-
-new SimpleScaffold({
-  name: args.name,
-  templates: args.templates,
-  output: args.output,
-  locals: args.locals,
-  createSubfolder: args.createSubFolder,
-  overwrite: args.overwrite,
-  quiet: args.quiet,
-}).run()

dist/cmd.d.ts

@@ -1 +0,0 @@
-export {};

dist/index.d.ts

@@ -1,30 +0,0 @@
-declare namespace IScaffold {
-  class SimpleScaffold {
-    constructor(config: Config)
-    run(): void
-  }
-
-  export interface Config {
-    name?: string
-    templates: string[]
-    output:
-      | string
-      | ((fullPath: string, basedir: string, basename: string) => string)
-    locals?: Locals
-    createSubfolder?: boolean
-    overwrite?: boolean | ((path: string) => boolean)
-    quiet?: boolean
-  }
-
-  export interface Locals {
-    [k: string]: string
-  }
-
-  export interface FileRepr {
-    base: string
-    file: string
-  }
-}
-
-export default IScaffold.SimpleScaffold
-export { IScaffold }

dist/index.js

@@ -1,2 +0,0 @@
-!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.library=e():t.library=e()}(global,(function(){return(()=>{"use strict";var t={493:function(t,e,o){var r=this&&this.__assign||function(){return(r=Object.assign||function(t){for(var e,o=1,r=arguments.length;o<r;o++)for(var i in e=arguments[o])Object.prototype.hasOwnProperty.call(e,i)&&(t[i]=e[i]);return t}).apply(this,arguments)},i=this&&this.__spreadArrays||function(){for(var t=0,e=0,o=arguments.length;e<o;e++)t+=arguments[e].length;var r=Array(t),i=0;for(e=0;e<o;e++)for(var n=arguments[e],s=0,a=n.length;s<a;s++,i++)r[i]=n[s];return r};Object.defineProperty(e,"__esModule",{value:!0});var n=o(747),s=o(622),a=o(878),l=o(778),f=function(){function t(t){this.locals={};var e={name:"scaffold",templates:[],output:process.cwd(),createSubfolder:!0,overwrite:!0,quiet:!1};this.config=r(r({},e),t);var o={Name:this.config.name[0].toUpperCase()+this.config.name.slice(1),name:this.config.name[0].toLowerCase()+this.config.name.slice(1)};this.locals=r(r({},o),t.locals)}return t.prototype.parseLocals=function(t){try{return l.compile(t,{noEscape:!0})(this.locals)}catch(e){return this.warn("Problem using Handlebars, returning unmodified content"),t}},t.prototype.fileList=function(t){for(var e=[],o=0,r=t;o<r.length;o++){var i=r[o],n=a.sync(i,{dot:!0}).map((function(t){return"/"==t[0]?t:s.join(process.cwd(),t)})),l=i.indexOf("*"),f=i;l>=0&&(f=i.slice(0,l-1));for(var c=0,p=n;c<p.length;c++){var u=p[c];e.push({base:f,file:u})}}return e},t.prototype.getFileContents=function(t){return this.log(n.readFileSync(t)),n.readFileSync(t).toString()},t.prototype.getOutputPath=function(t,e){var o;if("function"==typeof this.config.output)o=this.config.output(t,e,s.basename(t));else{var r=this.config.output+(this.config.createSubfolder?"/"+this.config.name+"/":"/"),i=t.indexOf(e),n=t;i>=0&&(n=t!==e?t.slice(i+e.length+1):s.basename(t)),o=r+n}return this.parseLocals(o)},t.prototype.writeFile=function(t,e){var o=s.dirname(t);this.writeDirectory(o,t),n.writeFile(t,e,{encoding:"utf-8"},(function(t){if(t)throw t}))},t.prototype.shouldWriteFile=function(t){var e,o,r="boolean"==typeof this.config.overwrite?this.config.overwrite:null===(o=(e=this.config).overwrite)||void 0===o?void 0:o.call(e,t);return!n.existsSync(t)||!1!==r},t.prototype.run=function(){this.log("Generating scaffold: "+this.config.name+"...");var t,e=this.fileList(this.config.templates),o=0;this.log("Template files:",e);for(var r=0,i=e;r<i.length;r++){t=i[r];var s=void 0,a=void 0,l=void 0,f=void 0,c=void 0;try{if(o++,f=t.file,c=t.base,s=this.getOutputPath(f,c),n.lstatSync(f).isDirectory()){this.writeDirectory(s,f);continue}a=this.getFileContents(f),l=this.parseLocals(a),this.shouldWriteFile(s)?(this.info("Writing:",{file:f,base:c,outputPath:s,outputContents:l.replace("\n","\\n")}),this.writeFile(s,l)):this.log("Skipping file "+s)}catch(t){throw this.error("Error while processing file:",{file:f,base:c,contents:a,outputPath:s,outputContents:l}),t}}if(!o)throw new Error("No files to scaffold!");this.log("Done")},t.prototype.writeDirectory=function(t,e){var o=s.dirname(t);n.existsSync(o)||this.writeDirectory(o,t),n.existsSync(t)||(this.info("Creating directory:",{file:e,outputPath:t}),n.mkdirSync(t))},t.prototype._log=function(t){for(var e=[],o=1;o<arguments.length;o++)e[o-1]=arguments[o];if(!this.config.quiet){var r=console[t];r.apply(void 0,e)}},t.prototype.log=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["log"],t))},t.prototype.info=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["info"],t))},t.prototype.warn=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["warn"],t))},t.prototype.error=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["error"],t))},t}();e.default=f},747:t=>{t.exports=require("fs")},878:t=>{t.exports=require("glob")},778:t=>{t.exports=require("handlebars")},622:t=>{t.exports=require("path")}},e={};return function o(r){if(e[r])return e[r].exports;var i=e[r]={exports:{}};return t[r].call(i.exports,i,i.exports,o),i.exports}(493)})()}));
-//# sourceMappingURL=index.js.map

dist/scaffold.d.ts

@@ -1,21 +0,0 @@
-/// <reference types="node" />
-import { IScaffold } from "./index.d";
-declare class SimpleScaffold {
-    config: IScaffold.Config;
-    locals: IScaffold.Config["locals"];
-    constructor(config: IScaffold.Config);
-    private parseLocals;
-    private fileList;
-    private getFileContents;
-    private getOutputPath;
-    private writeFile;
-    private shouldWriteFile;
-    run(): void;
-    private writeDirectory;
-    _log(method: keyof typeof console, ...args: any[]): void;
-    log(...args: any[]): void;
-    info(...args: any[]): void;
-    warn(...args: any[]): void;
-    error(...args: any[]): void;
-}
-export default SimpleScaffold;

dist/test.d.ts

@@ -1 +0,0 @@
-export {};

dist/test.js

@@ -1,2 +0,0 @@
-!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.library=e():t.library=e()}(global,(function(){return(()=>{"use strict";var t={493:function(t,e,o){var r=this&&this.__assign||function(){return(r=Object.assign||function(t){for(var e,o=1,r=arguments.length;o<r;o++)for(var i in e=arguments[o])Object.prototype.hasOwnProperty.call(e,i)&&(t[i]=e[i]);return t}).apply(this,arguments)},i=this&&this.__spreadArrays||function(){for(var t=0,e=0,o=arguments.length;e<o;e++)t+=arguments[e].length;var r=Array(t),i=0;for(e=0;e<o;e++)for(var n=arguments[e],s=0,a=n.length;s<a;s++,i++)r[i]=n[s];return r};Object.defineProperty(e,"__esModule",{value:!0});var n=o(747),s=o(622),a=o(878),l=o(778),p=function(){function t(t){this.locals={};var e={name:"scaffold",templates:[],output:process.cwd(),createSubfolder:!0,overwrite:!0,quiet:!1};this.config=r(r({},e),t);var o={Name:this.config.name[0].toUpperCase()+this.config.name.slice(1),name:this.config.name[0].toLowerCase()+this.config.name.slice(1)};this.locals=r(r({},o),t.locals)}return t.prototype.parseLocals=function(t){try{return l.compile(t,{noEscape:!0})(this.locals)}catch(e){return this.warn("Problem using Handlebars, returning unmodified content"),t}},t.prototype.fileList=function(t){for(var e=[],o=0,r=t;o<r.length;o++){var i=r[o],n=a.sync(i,{dot:!0}).map((function(t){return"/"==t[0]?t:s.join(process.cwd(),t)})),l=i.indexOf("*"),p=i;l>=0&&(p=i.slice(0,l-1));for(var u=0,c=n;u<c.length;u++){var f=c[u];e.push({base:p,file:f})}}return e},t.prototype.getFileContents=function(t){return this.log(n.readFileSync(t)),n.readFileSync(t).toString()},t.prototype.getOutputPath=function(t,e){var o;if("function"==typeof this.config.output)o=this.config.output(t,e,s.basename(t));else{var r=this.config.output+(this.config.createSubfolder?"/"+this.config.name+"/":"/"),i=t.indexOf(e),n=t;i>=0&&(n=t!==e?t.slice(i+e.length+1):s.basename(t)),o=r+n}return this.parseLocals(o)},t.prototype.writeFile=function(t,e){var o=s.dirname(t);this.writeDirectory(o,t),n.writeFile(t,e,{encoding:"utf-8"},(function(t){if(t)throw t}))},t.prototype.shouldWriteFile=function(t){var e,o,r="boolean"==typeof this.config.overwrite?this.config.overwrite:null===(o=(e=this.config).overwrite)||void 0===o?void 0:o.call(e,t);return!n.existsSync(t)||!1!==r},t.prototype.run=function(){this.log("Generating scaffold: "+this.config.name+"...");var t,e=this.fileList(this.config.templates),o=0;this.log("Template files:",e);for(var r=0,i=e;r<i.length;r++){t=i[r];var s=void 0,a=void 0,l=void 0,p=void 0,u=void 0;try{if(o++,p=t.file,u=t.base,s=this.getOutputPath(p,u),n.lstatSync(p).isDirectory()){this.writeDirectory(s,p);continue}a=this.getFileContents(p),l=this.parseLocals(a),this.shouldWriteFile(s)?(this.info("Writing:",{file:p,base:u,outputPath:s,outputContents:l.replace("\n","\\n")}),this.writeFile(s,l)):this.log("Skipping file "+s)}catch(t){throw this.error("Error while processing file:",{file:p,base:u,contents:a,outputPath:s,outputContents:l}),t}}if(!o)throw new Error("No files to scaffold!");this.log("Done")},t.prototype.writeDirectory=function(t,e){var o=s.dirname(t);n.existsSync(o)||this.writeDirectory(o,t),n.existsSync(t)||(this.info("Creating directory:",{file:e,outputPath:t}),n.mkdirSync(t))},t.prototype._log=function(t){for(var e=[],o=1;o<arguments.length;o++)e[o-1]=arguments[o];if(!this.config.quiet){var r=console[t];r.apply(void 0,e)}},t.prototype.log=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["log"],t))},t.prototype.info=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["info"],t))},t.prototype.warn=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["warn"],t))},t.prototype.error=function(){for(var t=[],e=0;e<arguments.length;e++)t[e]=arguments[e];this._log.apply(this,i(["error"],t))},t}();e.default=p},743:(t,e,o)=>{Object.defineProperty(e,"__esModule",{value:!0});var r=o(493),i=o(622).join(process.cwd(),"examples");new r.default({templates:[i+"/test-input/Component/**/*"],output:i+"/test-output/no-create-subpath",createSubfolder:!1,locals:{property:"myProp",value:'"value"'}}).run(),new r.default({templates:[i+"/test-input/Component/**/*"],output:i+"/test-output",locals:{property:"myProp",value:'"value"'}}).run(),new r.default({templates:[i+"/test-input/Component/**/*"],output:function(t,e,o){return console.log({file:t,basedir:e,basename:o}),t},locals:{property:"myProp",value:'"value"'}}).run()},747:t=>{t.exports=require("fs")},878:t=>{t.exports=require("glob")},778:t=>{t.exports=require("handlebars")},622:t=>{t.exports=require("path")}},e={};return function o(r){if(e[r])return e[r].exports;var i=e[r]={exports:{}};return t[r].call(i.exports,i,i.exports,o),i.exports}(743)})()}));
-//# sourceMappingURL=test.js.map

doc-theme/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+build/

doc-theme/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "doc-theme",
+  "version": "1.0.0",
+  "keywords": [
+    "typedocplugin"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "main": "build/index.js",
+  "devDependencies": {
+    "typedoc": "^0.22.15",
+    "typescript": "^4.6.3"
+  }
+}

doc-theme/src/index.tsx

@@ -0,0 +1,42 @@
+import { Application, DefaultTheme, PageEvent, JSX, DefaultThemeRenderContext } from "typedoc"
+
+class MyThemeContext extends DefaultThemeRenderContext {
+  // Important: If you use `this`, this function MUST be bound! Template functions are free
+  // to destructure the context object to only grab what they care about.
+  override analytics = () => {
+    // Reusing existing option rather than declaring our own for brevity
+    if (!this.options.isSet("gaID")) return
+
+    const gaID = this.options.getValue("gaID")
+
+    const scr = `
+      (function (w, d, s, l, i) {
+        w[l] = w[l] || [];
+        w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
+        var f = d.getElementsByTagName(s)[0],
+          j = d.createElement(s),
+          dl = l != "dataLayer" ? "&l=" + l : "";
+        j.async = true;
+        j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
+        f.parentNode.insertBefore(j, f);
+      })(window, document, "script", "dataLayer", "${gaID}");
+    `
+
+    return (
+      <script>
+        <JSX.Raw html={scr} />
+      </script>
+    )
+  }
+}
+
+class MyTheme extends DefaultTheme {
+  private _contextCache?: MyThemeContext
+  override getRenderContext(): DefaultThemeRenderContext {
+    return (this._contextCache ||= new MyThemeContext(this, this.application.options))
+  }
+}
+
+export function load(app: Application) {
+  app.renderer.defineTheme("doc-theme", MyTheme)
+}

doc-theme/tsconfig.json

@@ -0,0 +1,93 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+    /* Language and Environment */
+    "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    "jsx": "react", //                                   /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    "jsxFactory": "JSX.createElement", //                /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    "jsxFragmentFactory": "JSX.Fragment", //             /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    /* Modules */
+    "module": "commonjs", /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./build", //                              /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    "strict": true, /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}

doc-theme/yarn.lock

@@ -0,0 +1,139 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+balanced-match@^1.0.0:
+  version "1.0.2"
+  resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee"
+  integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==
+
+brace-expansion@^1.1.7:
+  version "1.1.11"
+  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd"
+  integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==
+  dependencies:
+    balanced-match "^1.0.0"
+    concat-map "0.0.1"
+
+brace-expansion@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae"
+  integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==
+  dependencies:
+    balanced-match "^1.0.0"
+
+concat-map@0.0.1:
+  version "0.0.1"
+  resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
+  integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=
+
+fs.realpath@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f"
+  integrity sha1-FQStJSMVjKpA20onh8sBQRmU6k8=
+
+glob@^7.2.0:
+  version "7.2.0"
+  resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.0.tgz#d15535af7732e02e948f4c41628bd910293f6023"
+  integrity sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==
+  dependencies:
+    fs.realpath "^1.0.0"
+    inflight "^1.0.4"
+    inherits "2"
+    minimatch "^3.0.4"
+    once "^1.3.0"
+    path-is-absolute "^1.0.0"
+
+inflight@^1.0.4:
+  version "1.0.6"
+  resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9"
+  integrity sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=
+  dependencies:
+    once "^1.3.0"
+    wrappy "1"
+
+inherits@2:
+  version "2.0.4"
+  resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c"
+  integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==
+
+jsonc-parser@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.0.0.tgz#abdd785701c7e7eaca8a9ec8cf070ca51a745a22"
+  integrity sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==
+
+lunr@^2.3.9:
+  version "2.3.9"
+  resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1"
+  integrity sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==
+
+marked@^4.0.12:
+  version "4.0.14"
+  resolved "https://registry.yarnpkg.com/marked/-/marked-4.0.14.tgz#7a3a5fa5c80580bac78c1ed2e3b84d7bd6fc3870"
+  integrity sha512-HL5sSPE/LP6U9qKgngIIPTthuxC0jrfxpYMZ3LdGDD3vTnLs59m2Z7r6+LNDR3ToqEQdkKd6YaaEfJhodJmijQ==
+
+minimatch@^3.0.4:
+  version "3.1.2"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b"
+  integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==
+  dependencies:
+    brace-expansion "^1.1.7"
+
+minimatch@^5.0.1:
+  version "5.0.1"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.0.1.tgz#fb9022f7528125187c92bd9e9b6366be1cf3415b"
+  integrity sha512-nLDxIFRyhDblz3qMuq+SoRZED4+miJ/G+tdDrjkkkRnjAsBexeGpgjLEQ0blJy7rHhR2b93rhQY4SvyWu9v03g==
+  dependencies:
+    brace-expansion "^2.0.1"
+
+once@^1.3.0:
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1"
+  integrity sha1-WDsap3WWHUsROsF9nFC6753Xa9E=
+  dependencies:
+    wrappy "1"
+
+path-is-absolute@^1.0.0:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f"
+  integrity sha1-F0uSaHNVNP+8es5r9TpanhtcX18=
+
+shiki@^0.10.1:
+  version "0.10.1"
+  resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.10.1.tgz#6f9a16205a823b56c072d0f1a0bcd0f2646bef14"
+  integrity sha512-VsY7QJVzU51j5o1+DguUd+6vmCmZ5v/6gYu4vyYAhzjuNQU6P/vmSy4uQaOhvje031qQMiW0d2BwgMH52vqMng==
+  dependencies:
+    jsonc-parser "^3.0.0"
+    vscode-oniguruma "^1.6.1"
+    vscode-textmate "5.2.0"
+
+typedoc@^0.22.15:
+  version "0.22.15"
+  resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.22.15.tgz#c6ad7ed9d017dc2c3a06c9189cb392bd8e2d8c3f"
+  integrity sha512-CMd1lrqQbFvbx6S9G6fL4HKp3GoIuhujJReWqlIvSb2T26vGai+8Os3Mde7Pn832pXYemd9BMuuYWhFpL5st0Q==
+  dependencies:
+    glob "^7.2.0"
+    lunr "^2.3.9"
+    marked "^4.0.12"
+    minimatch "^5.0.1"
+    shiki "^0.10.1"
+
+typescript@^4.6.3:
+  version "4.6.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.6.3.tgz#eefeafa6afdd31d725584c67a0eaba80f6fc6c6c"
+  integrity sha512-yNIatDa5iaofVozS/uQJEl3JRWLKKGJKh6Yaiv0GLGSuhpFJe7P3SbHZ8/yjAHRQwKRoA6YZqlfjXWmVzoVSMw==
+
+vscode-oniguruma@^1.6.1:
+  version "1.6.2"
+  resolved "https://registry.yarnpkg.com/vscode-oniguruma/-/vscode-oniguruma-1.6.2.tgz#aeb9771a2f1dbfc9083c8a7fdd9cccaa3f386607"
+  integrity sha512-KH8+KKov5eS/9WhofZR8M8dMHWN2gTxjMsG4jd04YhpbPR91fUj7rYQ2/XjeHCJWbg7X++ApRIU9NUwM2vTvLA==
+
+vscode-textmate@5.2.0:
+  version "5.2.0"
+  resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-5.2.0.tgz#01f01760a391e8222fe4f33fbccbd1ad71aed74e"
+  integrity sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==
+
+wrappy@1:
+  version "1.0.2"
+  resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f"
+  integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=

examples/test-input/Component/Scaffold.tsx

@@ -1,19 +0,0 @@
-import * as React from 'react'
-import * as css from './Scaffold.css'
-
-class Scaffold extends React.Component<any> {
-  private myProp
-
-  constructor(props: any) {
-    super(props)
-    this.myProp = "value"
-  }
-
-  public render() {
-    return (
-      <div className={ css.Scaffold } />
-    )
-  }
-}
-
-export default Scaffold

examples/test-input/Component/inner/inner-{{name}}.txt

@@ -0,0 +1 @@
+{{name}}

examples/test-input/Component/{{Name}}.tsx

@@ -1,18 +1,16 @@
-import * as React from 'react'
-import * as css from './{{Name}}.css'
+import * as React from "react"
+import * as css from "./{{Name}}.css"
 
 class {{Name}} extends React.Component<any> {
-  private {{property}}
+  private {{ property }}
 
   constructor(props: any) {
     super(props)
-    this.{{property}} = {{value}}
+    this.{{ property }} = {{ value }}
   }
 
   public render() {
-    return (
-      <div className={ css.{{Name}} } />
-    )
+    return <div className={ css.{{Name}} } />
   }
 }
 

index.d.ts

@@ -1,30 +0,0 @@
-declare namespace IScaffold {
-  class SimpleScaffold {
-    constructor(config: Config)
-    run(): void
-  }
-
-  export interface Config {
-    name?: string
-    templates: string[]
-    output:
-      | string
-      | ((fullPath: string, basedir: string, basename: string) => string)
-    locals?: Locals
-    createSubfolder?: boolean
-    overwrite?: boolean | ((path: string) => boolean)
-    quiet?: boolean
-  }
-
-  export interface Locals {
-    [k: string]: string
-  }
-
-  export interface FileRepr {
-    base: string
-    file: string
-  }
-}
-
-export default IScaffold.SimpleScaffold
-export { IScaffold }

index.js

@@ -1,2 +0,0 @@
-const SimpleScaffold = require('./dist')
-module.exports = SimpleScaffold

jest.config.ts

@@ -0,0 +1,196 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/q9/0mns8fgd00b4t5j5lq2wh2yh0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  modulePathIgnorePatterns: ["<rootDir>/dist"],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: "ts-jest",
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: {},
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+
+  // extensionsToTreatAsEsm: [".ts"],
+}

package.json

@@ -1,47 +1,57 @@
 {
   "name": "simple-scaffold",
-  "version": "0.7.2",
-  "description": "Create files based on templates",
+  "version": "1.1.2",
+  "description": "A simple command to generate any file structure, from single components to entire app boilerplates.",
+  "homepage": "https://casraf.blog/simple-scaffold",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
   "author": "Chen Asraf <inbox@casraf.com>",
   "license": "MIT",
-  "main": "dist/scaffold.js",
-  "bin": "dist/cmd.js",
-  "types": "index.d.ts",
+  "main": "index.js",
+  "bin": "cmd.js",
+  "keywords": [
+    "javascript",
+    "cli",
+    "template",
+    "files",
+    "typescript",
+    "generator",
+    "scaffold",
+    "file",
+    "scaffolding"
+  ],
   "scripts": {
-    "build": "NODE_ENV=${NODE_ENV:-production} webpack && chmod -R +x ./dist",
-    "prepublishOnly": "yarn build",
-    "dev": "webpack --watch",
+    "clean": "rimraf dist/",
+    "build": "yarn clean && tsc && chmod -R +x ./dist && cp ./package.json ./README.md ./dist/",
+    "dev": "tsc --watch",
     "start": "node dist/scaffold.js",
-    "test": "node dist/test.js",
-    "cmd": "dist/cmd.js",
+    "test": "jest --verbose",
+    "cmd": "node --trace-warnings dist/cmd.js",
     "build-test": "yarn build && yarn test",
-    "build-cmd": "yarn build && yarn cmd"
+    "build-cmd": "yarn build && yarn cmd",
+    "audit-fix": "npm_config_yes=true npx yarn-audit-fix --flow=convert"
   },
   "dependencies": {
-    "command-line-args": "^5.0.2",
-    "command-line-usage": "^6.1.1",
+    "chalk": "^4.1.2",
+    "date-fns": "^2.28.0",
     "glob": "^7.1.3",
-    "handlebars": "^4.1.0"
+    "handlebars": "^4.7.7",
+    "lodash": "^4.17.21",
+    "massarg": "^1.0.5",
+    "util.promisify": "^1.1.1"
   },
   "devDependencies": {
-    "@types/command-line-args": "^5.0.0",
-    "@types/command-line-usage": "^5.0.1",
     "@types/glob": "^7.1.1",
+    "@types/jest": "^26.0.24",
+    "@types/lodash": "^4.14.171",
+    "@types/mock-fs": "^4.13.1",
     "@types/node": "^14.14.22",
-    "copy-webpack-plugin": "^7.0.0",
-    "jest": "^26.6.3",
-    "ts-loader": "^8.0.14",
-    "typescript": "^4.1.3",
-    "webpack": "^5.19.0",
-    "webpack-cli": "^4.4.0",
-    "webpack-dev-server": "^3.2.1",
-    "webpack-node-externals": "^2.5.2"
-  },
-  "jest": {
-    "testPathIgnorePatterns": [
-      "node_modules",
-      "dist"
-    ]
+    "doc-theme": "file:./doc-theme",
+    "jest": "^27.0.6",
+    "mock-fs": "^5.0.0",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.0.3",
+    "ts-node": "^10.1.0",
+    "typedoc": "^0.22.15",
+    "typescript": "^4.3.5"
   }
 }

scaffold.ts

@@ -1,198 +0,0 @@
-import * as fs from "fs"
-import * as path from "path"
-import { IScaffold } from "./index.d"
-import * as glob from "glob"
-import * as handlebars from "handlebars"
-
-class SimpleScaffold {
-  public config: IScaffold.Config
-  public locals: IScaffold.Config["locals"] = {} as any
-
-  constructor(config: IScaffold.Config) {
-    const DefaultConfig: IScaffold.Config = {
-      name: "scaffold",
-      templates: [],
-      output: process.cwd(),
-      createSubfolder: true,
-      overwrite: true,
-      quiet: false,
-    }
-
-    this.config = { ...DefaultConfig, ...config }
-
-    const DefaultLocals = {
-      // TODO improve
-      Name: this.config.name![0].toUpperCase() + this.config.name!.slice(1),
-      name: this.config.name![0].toLowerCase() + this.config.name!.slice(1),
-    }
-
-    this.locals = { ...DefaultLocals, ...config.locals }
-  }
-
-  private parseLocals(text: string): string {
-    try {
-      const template = handlebars.compile(text, {
-        noEscape: true,
-      })
-      return template(this.locals)
-    } catch (e) {
-      this.warn("Problem using Handlebars, returning unmodified content")
-      return text
-    }
-  }
-
-  private fileList(input: string[]): IScaffold.FileRepr[] {
-    const output: IScaffold.FileRepr[] = []
-    for (const checkPath of input) {
-      const files = glob
-        .sync(checkPath, { dot: true })
-        .map((g) => (g[0] == "/" ? g : path.join(process.cwd(), g)))
-      const idx = checkPath.indexOf("*")
-      let cleanCheckPath = checkPath
-      if (idx >= 0) {
-        cleanCheckPath = checkPath.slice(0, idx - 1)
-      }
-      for (const file of files) {
-        output.push({ base: cleanCheckPath, file })
-      }
-    }
-    return output
-  }
-
-  private getFileContents(filePath: string): string {
-    this.log(fs.readFileSync(filePath))
-    return fs.readFileSync(filePath).toString()
-  }
-
-  private getOutputPath(file: string, basePath: string): string {
-    let out: string
-
-    if (typeof this.config.output === "function") {
-      out = this.config.output(file, basePath, path.basename(file))
-    } else {
-      const outputDir =
-        this.config.output +
-        (this.config.createSubfolder ? `/${this.config.name}/` : "/")
-      const idx = file.indexOf(basePath)
-      let relativeFilePath = file
-      if (idx >= 0) {
-        if (file !== basePath) {
-          relativeFilePath = file.slice(idx + basePath.length + 1)
-        } else {
-          relativeFilePath = path.basename(file)
-        }
-      }
-      out = outputDir + relativeFilePath
-    }
-
-    return this.parseLocals(out)
-  }
-
-  private writeFile(filePath: string, fileContents: string): void {
-    const baseDir = path.dirname(filePath)
-    this.writeDirectory(baseDir, filePath)
-    fs.writeFile(filePath, fileContents, { encoding: "utf-8" }, (err) => {
-      if (err) {
-        throw err
-      }
-    })
-  }
-
-  private shouldWriteFile(filePath: string) {
-    const overwrite =
-      typeof this.config.overwrite === "boolean"
-        ? this.config.overwrite
-        : this.config.overwrite?.(filePath)
-    const exists = fs.existsSync(filePath)
-
-    return !exists || overwrite !== false
-  }
-
-  public run(): void {
-    this.log(`Generating scaffold: ${this.config.name}...`)
-    const templates = this.fileList(this.config.templates)
-
-    let fileConf,
-      count = 0
-
-    this.log("Template files:", templates)
-    for (fileConf of templates) {
-      let outputPath, contents, outputContents, file, base
-      try {
-        count++
-        file = fileConf.file
-        base = fileConf.base
-        outputPath = this.getOutputPath(file, base)
-        if (fs.lstatSync(file).isDirectory()) {
-          this.writeDirectory(outputPath, file)
-          continue
-        }
-        contents = this.getFileContents(file)
-        outputContents = this.parseLocals(contents)
-        if (this.shouldWriteFile(outputPath)) {
-          this.info("Writing:", {
-            file,
-            base,
-            outputPath,
-            outputContents: outputContents.replace("\n", "\\n"),
-          })
-          this.writeFile(outputPath, outputContents)
-        } else {
-          this.log(`Skipping file ${outputPath}`)
-        }
-      } catch (e) {
-        this.error("Error while processing file:", {
-          file,
-          base,
-          contents,
-          outputPath,
-          outputContents,
-        })
-        throw e
-      }
-    }
-
-    if (!count) {
-      throw new Error("No files to scaffold!")
-    }
-
-    this.log("Done")
-  }
-
-  private writeDirectory(outputPath: string, file: any): void {
-    const parent = path.dirname(outputPath)
-    if (!fs.existsSync(parent)) {
-      this.writeDirectory(parent, outputPath)
-    }
-    if (!fs.existsSync(outputPath)) {
-      this.info("Creating directory:", {
-        file,
-        outputPath,
-      })
-      fs.mkdirSync(outputPath)
-    }
-  }
-
-  _log(method: keyof typeof console, ...args: any[]): void {
-    if (this.config.quiet) {
-      return
-    }
-    const fn = console[method] as (...a: any[]) => void
-    fn(...args)
-  }
-
-  log(...args: any[]): void {
-    this._log("log", ...args)
-  }
-  info(...args: any[]): void {
-    this._log("info", ...args)
-  }
-  warn(...args: any[]): void {
-    this._log("warn", ...args)
-  }
-  error(...args: any[]): void {
-    this._log("error", ...args)
-  }
-}
-
-export default SimpleScaffold

src/cmd.ts

@@ -0,0 +1,109 @@
+#!/usr/bin/env node
+import massarg from "massarg"
+import chalk from "chalk"
+import { LogLevel, ScaffoldCmdConfig } from "./types"
+import { Scaffold } from "./scaffold"
+import path from "path"
+import fs from "fs/promises"
+
+export async function parseCliArgs(args = process.argv.slice(2)) {
+  const pkg = JSON.parse((await fs.readFile(path.join(__dirname, "package.json"))).toString())
+
+  return (
+    massarg<ScaffoldCmdConfig & { help: boolean; extras: string[] }>()
+      .main(Scaffold)
+      .option({
+        name: "name",
+        aliases: ["n"],
+        description:
+          "Name to be passed to the generated files. {{name}} and {{Name}} inside contents and file names will be replaced accordingly.",
+        isDefault: true,
+        required: true,
+      })
+      .option({
+        name: "output",
+        aliases: ["o"],
+        description: `Path to output to. If --create-sub-folder is enabled, the subfolder will be created inside this path. ${chalk.reset`${chalk.white`(default: current dir)`}`}`,
+        required: true,
+      })
+      .option({
+        name: "templates",
+        aliases: ["t"],
+        array: true,
+        description:
+          "Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path, " +
+          "or a glob pattern for multiple file matching easily.",
+        required: true,
+      })
+      .option({
+        name: "overwrite",
+        aliases: ["w"],
+        boolean: true,
+        defaultValue: false,
+        description: "Enable to override output files, even if they already exist.",
+      })
+      .option({
+        name: "data",
+        aliases: ["d"],
+        description: "Add custom data to the templates. By default, only your app name is included.",
+        parse: (v) => JSON.parse(v),
+      })
+      .option({
+        name: "create-sub-folder",
+        aliases: ["s"],
+        boolean: true,
+        defaultValue: false,
+        description: "Create subfolder with the input name",
+      })
+      .option({
+        name: "sub-folder-name-helper",
+        aliases: ["sh"],
+        description: "Default helper to apply to subfolder name when using `--create-sub-folder true`.",
+      })
+      .option({
+        name: "quiet",
+        aliases: ["q"],
+        boolean: true,
+        defaultValue: false,
+        description: "Suppress output logs (Same as --verbose 0)",
+      })
+      .option({
+        name: "verbose",
+        aliases: ["v"],
+        defaultValue: LogLevel.Info,
+        description: `Determine amount of logs to display. The values are: ${chalk.bold`0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`}. The provided level will display messages of the same level or higher.`,
+        parse: Number,
+      })
+      .option({
+        name: "dry-run",
+        aliases: ["dr"],
+        boolean: true,
+        defaultValue: false,
+        description:
+          "Don't emit files. This is good for testing your scaffolds and making sure they " +
+          "don't fail, without having to write actual file contents or create directories.",
+      })
+      // .example({
+      //   input: `yarn cmd -t examples/test-input/Component -o examples/test-output -d '{"property":"myProp","value":"10"}'`,
+      //   description: "Usage",
+      //   output: "",
+      // })
+      .help({
+        binName: "simple-scaffold",
+        useGlobalColumns: true,
+        usageExample: "[options]",
+        header: [`Create structured files based on templates.`].join("\n"),
+        footer: [
+          `Version:  ${pkg.version}`,
+          `Copyright © Chen Asraf 2017-${new Date().getFullYear()}`,
+          ``,
+          `Documentation: ${chalk.underline`https://casraf.blog/simple-scaffold`}`,
+          `NPM: ${chalk.underline`https://npmjs.com/package/simple-scaffold`}`,
+          `GitHub: ${chalk.underline`https://github.com/chenasraf/simple-scaffold`}`,
+        ].join("\n"),
+      })
+      .parse(args)
+  )
+}
+
+parseCliArgs()

src/index.ts

@@ -0,0 +1,4 @@
+export * from "./scaffold"
+export * from "./types"
+import Scaffold from "./scaffold"
+export default Scaffold

src/scaffold.ts

@@ -0,0 +1,138 @@
+/**
+ * @module
+ * Simple Scaffold
+ *
+ * See [readme](README.md)
+ */
+import path from "path"
+
+import {
+  createDirIfNotExists,
+  getOptionValueForFile,
+  handleErr,
+  log,
+  pascalCase,
+  isDir,
+  removeGlob,
+  makeRelativePath,
+  registerHelpers,
+  getTemplateGlobInfo,
+  getFileList,
+  getBasePath,
+  copyFileTransformed,
+  getTemplateFileInfo,
+  logInitStep,
+  logInputFile,
+} from "./utils"
+import { LogLevel, ScaffoldConfig } from "./types"
+
+/**
+ * Create a scaffold using given `options`.
+ *
+ * #### Create files
+ * To create a file structure to output, use any directory and file structure you would like.
+ * Inside folder names, file names or file contents, you may place `{{ var }}` where `var` is either
+ * `name` which is the scaffold name you provided or one of the keys you provided in the `data` option.
+ *
+ * The contents and names will be replaced with the transformed values so you can use your original structure as a
+ * boilerplate for other projects, components, modules, or even single files.
+ *
+ * The files will maintain their structure, starting from the directory containing the template (or the template itself
+ * if it is already a directory), and will output from that directory into the directory defined by `config.output`.
+ *
+ * #### Helpers
+ * Helpers are functions you can use to transform your `{{ var }}` contents into other values without having to
+ * pre-define the data and use a duplicated key.
+ *
+ * Any functions you provide in `helpers` option will also be available to you to make custom formatting as you see fit
+ * (for example, formatting a date)
+ *
+ * For available default values, see {@link DefaultHelperKeys}.
+ *
+ * @param {ScaffoldConfig} config The main configuration object
+ *
+ * @see {@link DefaultHelperKeys}
+ *
+ * @category Main
+ */
+export async function Scaffold(config: ScaffoldConfig): Promise<void> {
+  config.output ??= process.cwd()
+
+  registerHelpers(config)
+  try {
+    config.data = { name: config.name, Name: pascalCase(config.name), ...config.data }
+    logInitStep(config)
+    for (let _template of config.templates) {
+      try {
+        const { nonGlobTemplate, origTemplate, isDirOrGlob, isGlob, template } = await getTemplateGlobInfo(
+          config,
+          _template
+        )
+        const files = await getFileList(config, template)
+        for (const inputFilePath of files) {
+          if (await isDir(inputFilePath)) {
+            continue
+          }
+          const relPath = makeRelativePath(path.dirname(removeGlob(inputFilePath).replace(nonGlobTemplate, "")))
+          const basePath = getBasePath(relPath)
+          logInputFile(config, {
+            origTemplate,
+            relPath,
+            template,
+            inputFilePath,
+            nonGlobTemplate,
+            basePath,
+            isDirOrGlob,
+            isGlob,
+          })
+          await handleTemplateFile(config, {
+            templatePath: inputFilePath,
+            basePath,
+          })
+        }
+      } catch (e: any) {
+        handleErr(e)
+      }
+    }
+  } catch (e: any) {
+    log(config, LogLevel.Error, e)
+    throw e
+  }
+}
+async function handleTemplateFile(
+  config: ScaffoldConfig,
+  { templatePath, basePath }: { templatePath: string; basePath: string }
+): Promise<void> {
+  return new Promise(async (resolve, reject) => {
+    try {
+      const { inputPath, outputPathOpt, outputDir, outputPath, exists } = await getTemplateFileInfo(config, {
+        templatePath,
+        basePath,
+      })
+      const overwrite = getOptionValueForFile(config, inputPath, config.overwrite ?? false)
+
+      log(
+        config,
+        LogLevel.Debug,
+        `\nParsing ${templatePath}`,
+        `\nBase path: ${basePath}`,
+        `\nFull input path: ${inputPath}`,
+        `\nOutput Path Opt: ${outputPathOpt}`,
+        `\nFull output dir: ${outputDir}`,
+        `\nFull output path: ${outputPath}`,
+        `\n`
+      )
+
+      await createDirIfNotExists(path.dirname(outputPath), config)
+
+      log(config, LogLevel.Info, `Writing to ${outputPath}`)
+      await copyFileTransformed(config, { exists, overwrite, outputPath, inputPath })
+      resolve()
+    } catch (e: any) {
+      handleErr(e)
+      reject(e)
+    }
+  })
+}
+
+export default Scaffold

src/types.ts

@@ -0,0 +1,292 @@
+import { HelperDelegate } from "handlebars/runtime"
+
+/**
+ * The config object for defining a scaffolding group.
+ *
+ * @see https://github.com/chenasraf/simple-scaffold#readme
+ * @see {@link DefaultHelperKeys}
+ *
+ * @category Config
+ */
+export interface ScaffoldConfig {
+  /**
+   * Name to be passed to the generated files. `{{name}}` and `{{Name}}` inside contents and file names will be replaced
+   * accordingly.
+   */
+  name: string
+
+  /**
+   * 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.
+   *
+   * @default Current working directory
+   */
+  templates: string[]
+
+  /**
+   * Path to output to. If `createSubFolder` is `true`, the subfolder will be created inside this path.
+   *
+   * May also be a {@link FileResponseHandler} which returns a new output path to override the default one.
+   *
+   * @see {@link FileResponse}
+   * @see {@link FileResponseHandler}
+   */
+  output: FileResponse<string>
+
+  /**
+   * Whether to create subfolder with the input name.
+   *
+   * When `true`, you may also use {@link subFolderNameHelper} to determine a pre-process helper on
+   * the directory name.
+   *
+   * @default `false`
+   */
+  createSubFolder?: boolean
+
+  /**
+   * Add custom data to the templates. By default, only your app name is included as `{{name}}` and `{{Name}}`.
+   *
+   * This can be any object that will be usable by Handlebars.
+   */
+  data?: Record<string, any>
+
+  /**
+   * Enable to override output files, even if they already exist.
+   *
+   * You may supply a function to this option, which can take the arguments `(fullPath, baseDir, baseName)` and returns
+   * a string, to return a dynamic path for each file.
+   *
+   * May also be a {@link FileResponseHandler} which returns a boolean value per file.
+   *
+   * @see {@link FileResponse}
+   * @see {@link FileResponseHandler}
+   *
+   * @default `false`
+   */
+  overwrite?: FileResponse<boolean>
+
+  /**
+   * Suppress output logs (Same as `verbose: 0` or `verbose: LogLevel.None`)
+   *  @see {@link verbose}
+   */
+  quiet?: boolean
+
+  /**
+   * Determine amount of logs to display.
+   *
+   * The values are: `0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`. The provided level will display messages
+   * of the same level or higher.
+   *
+   * @see {@link LogLevel}
+   *
+   * @default `2 (info)`
+   */
+  verbose?: LogLevel
+
+  /**
+   * 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`
+   */
+  dryRun?: boolean
+
+  /**
+   * Additional helpers to add to the template parser. Provide an object whose keys are the name of the function to add,
+   * and the value is the helper function itself. The signature of helpers is as follows:
+   * ```typescript
+   * (text: string) => string
+   * ```
+   *
+   * A full example might be:
+   *
+   * ```typescript
+   * Scaffold({
+   *   //...
+   *   helpers: {
+   *     upperCamelCase: (text) => camelCase(text).toUpperCase()
+   *   }
+   * })
+   * ```
+   *
+   * See {@link DefaultHelperKeys} for a list of all the built-in available helpers.
+   *
+   * @see https://github.com/chenasraf/simple-scaffold#helpers
+   * @see https://github.com/chenasraf/simple-scaffold#built-in-helpers
+   */
+  helpers?: Record<string, Helper>
+
+  /**
+   * Default transformer to apply to subfolder name when using `createSubFolder: 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.
+   *
+   * @see {@link createSubFolder}
+   * @see {@link CapitalizationHelperKeys}
+   * @see {@link DefaultHelperKeys}
+   */
+  subFolderNameHelper?: DefaultHelperKeys | string
+
+  /**
+   * This callback runs right before content is being written to the disk. If you supply this function, you may return
+   * a string that represents the final content of your file, you may process the content as you see fit. For example,
+   * you may run formatters on a file, fix output in edge-cases not supported by helpers or data, etc.
+   *
+   * If the return value of this function is `undefined`, the original content will be used.
+   *
+   * @param content The original template after token replacement
+   * @param rawContent The original template before token replacement
+   * @param outputPath The final output path of the processed file
+   *
+   * @returns {Promise<String | Buffer | undefined> | String | Buffer | undefined} The final output of the file contents-only, after further modifications -
+   * or `undefined` to use the original content (i.e. `content.toString()`)
+   */
+  beforeWrite?(
+    content: Buffer,
+    rawContent: Buffer,
+    outputPath: string
+  ): string | Buffer | undefined | Promise<string | Buffer | undefined>
+}
+
+/**
+ * The names of the available helper functions that relate to text capitalization.
+ *
+ * These are available for `subfolderNameHelper`.
+ *
+ * | Helper name  | Example code            | Example output |
+ * | ------------ | ----------------------- | -------------- |
+ * | [None]       | `{{ name }}`            | my name        |
+ * | `camelCase`  | `{{ camelCase name }}`  | myName         |
+ * | `snakeCase`  | `{{ snakeCase name }}`  | my_name        |
+ * | `startCase`  | `{{ startCase name }}`  | My Name        |
+ * | `kebabCase`  | `{{ kebabCase name }}`  | my-name        |
+ * | `hyphenCase` | `{{ hyphenCase name }}` | my-name        |
+ * | `pascalCase` | `{{ pascalCase name }}` | MyName         |
+ * | `upperCase`  | `{{ upperCase name }}`  | MY NAME        |
+ * | `lowerCase`  | `{{ lowerCase name }}`  | my name        |
+ *
+ * @see {@link ScaffoldConfig}
+ * @see {@link subFolderNameHelper}
+ * @see {@link DefaultHelperKeys}
+ *
+ * @category Helpers
+ */
+export type CapitalizationHelperKeys =
+  | "camelCase"
+  | "hyphenCase"
+  | "kebabCase"
+  | "lowerCase"
+  | "pascalCase"
+  | "snakeCase"
+  | "startCase"
+  | "upperCase"
+
+/**
+ * The names of the available helper functions that relate to dates.
+ *
+ * | Helper name                      | Description                                                      | Example code                                                     | Example output     |
+ * | -------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------ |
+ * | `now`                            | Current date with format                                         | `{{ now "yyyy-MM-dd HH:mm" }}`                                   | `2042-01-01 15:00` |
+ * | `now` (with offset)              | Current date with format, and with offset                        | `{{ now "yyyy-MM-dd HH:mm" -1 "hours" }}`                        | `2042-01-01 14:00` |
+ * | `date`                           | Custom date with format                                          | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" }}`           | `2042-01-01 15:00` |
+ * | `date` (with offset)             | Custom date with format, and with offset                         | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" -1 "days" }}` | `2041-31-12 15:00` |
+ * | `date` (with date from `--data`) | Custom date with format, with data from the `data` config option | `{{ date myCustomDate "yyyy-MM-dd HH:mm" }}`                     | `2042-01-01 12:00` |
+ *
+ * @see {@link DefaultHelperKeys}
+ *
+ * @category Helpers
+ */
+export type DateHelperKeys = "date" | "now"
+
+/**
+ * The names of all the available helper functions in templates.
+ * Simple-Scaffold provides some built-in text transformation filters usable by handleBars.
+ *
+ * For example, you may use `{{ snakeCase name }}` inside a template file or filename, and it will
+ * replace `My Name` with `my_name` when producing the final value.
+ *
+ * @see {@link CapitalizationHelperKeys}
+ * @see {@link DateHelperKeys}
+ *
+ * @category Helpers
+ */
+export type DefaultHelperKeys = CapitalizationHelperKeys | DateHelperKeys
+
+/**
+ * Helper function, see https://handlebarsjs.com/guide/#custom-helpers
+ *
+ * @category Helpers
+ */
+export type Helper = HelperDelegate
+
+/**
+ * The amount of information to log when generating scaffold.
+ * When not `None`, the selected level will be the lowest level included.
+ *
+ * For example, level `Info` (2) will include `Info`, `Warning` and `Error`, but not `Debug`; and `Warning` will only
+ * show `Warning` and `Error`.
+ *
+ * @default `2 (info)`
+ *
+ * @category Logging
+ */
+export enum LogLevel {
+  /** Silent output */
+  None = 0,
+  /** Debugging information. Very verbose and only recommended for troubleshooting. */
+  Debug = 1,
+  /**
+   * The regular level of logging. Major actions are logged to show the scaffold progress.
+   *
+   * @default
+   */
+  Info = 2,
+  /** Warnings such as when file fails to replace token values properly in template. */
+  Warning = 3,
+  /** Errors, such as missing files, bad replacement token syntax, or un-writable directories. */
+  Error = 4,
+}
+
+/**
+ * A function that takes path information about file, and returns a value of type `T`
+ *
+ * @template T The return type for the function
+ * @param {string} fullPath The full path of the current file
+ * @param {string} basedir The directory containing the current file
+ * @param {string} basename The name of the file
+ *
+ * @returns {T} A return value
+ *
+ * @category Config
+ */
+export type FileResponseHandler<T> = (fullPath: string, basedir: string, basename: string) => T
+
+/**
+ * Represents a response for file path information.
+ * Can either be:
+ *
+ * 1. `T` - static value
+ * 2. A function with the following signature which returns `T`:
+ *    ```typescript
+ *    (fullPath: string, basedir: string, basename: string) => T
+ *    ```
+ *
+ * @typedef T The return type
+ *
+ * @see {@link FileResponseHandler}
+ *
+ * @category Config
+ * */
+export type FileResponse<T> = T | FileResponseHandler<T>
+
+/** @internal */
+export interface ScaffoldCmdConfig {
+  name: string
+  templates: string[]
+  output: string
+  createSubFolder: boolean
+  data?: Record<string, string>
+  overwrite: boolean
+  quiet: boolean
+  verbose: LogLevel
+  dryRun: boolean
+}

src/utils.ts

@@ -0,0 +1,374 @@
+import path from "path"
+import { F_OK } from "constants"
+import { DefaultHelperKeys, FileResponse, FileResponseHandler, Helper, LogLevel, ScaffoldConfig } from "./types"
+import camelCase from "lodash/camelCase"
+import snakeCase from "lodash/snakeCase"
+import kebabCase from "lodash/kebabCase"
+import startCase from "lodash/startCase"
+import Handlebars from "handlebars"
+import { promises as fsPromises } from "fs"
+import chalk from "chalk"
+const { stat, access, mkdir } = fsPromises
+import dtAdd from "date-fns/add"
+import dtFormat from "date-fns/format"
+import dtParseISO from "date-fns/parseISO"
+
+const dateFns = {
+  add: dtAdd,
+  format: dtFormat,
+  parseISO: dtParseISO,
+}
+
+import { glob } from "glob"
+import { promisify } from "util"
+const { readFile, writeFile } = fsPromises
+
+export const defaultHelpers: Record<DefaultHelperKeys, Helper> = {
+  camelCase,
+  snakeCase,
+  startCase,
+  kebabCase,
+  hyphenCase: kebabCase,
+  pascalCase,
+  lowerCase: (text) => text.toLowerCase(),
+  upperCase: (text) => text.toUpperCase(),
+  now: nowHelper,
+  date: dateHelper,
+}
+
+export function _dateHelper(date: Date, formatString: string): string
+export function _dateHelper(
+  date: Date,
+  formatString: string,
+  durationDifference: number,
+  durationType: keyof Duration
+): string
+export function _dateHelper(
+  date: Date,
+  formatString: string,
+  durationDifference?: number,
+  durationType?: keyof Duration
+): string {
+  if (durationType && durationDifference !== undefined) {
+    return dateFns.format(dateFns.add(date, { [durationType]: durationDifference }), formatString)
+  }
+  return dateFns.format(date, formatString)
+}
+
+export function nowHelper(formatString: string): string
+export function nowHelper(formatString: string, durationDifference: number, durationType: keyof Duration): string
+export function nowHelper(formatString: string, durationDifference?: number, durationType?: keyof Duration): string {
+  return _dateHelper(new Date(), formatString, durationDifference!, durationType!)
+}
+
+export function dateHelper(date: string, formatString: string): string
+export function dateHelper(
+  date: string,
+  formatString: string,
+  durationDifference: number,
+  durationType: keyof Duration
+): string
+
+export function dateHelper(
+  date: string,
+  formatString: string,
+  durationDifference?: number,
+  durationType?: keyof Duration
+): string {
+  return _dateHelper(dateFns.parseISO(date), formatString, durationDifference!, durationType!)
+}
+
+export function registerHelpers(config: ScaffoldConfig): void {
+  const _helpers = { ...defaultHelpers, ...config.helpers }
+  for (const helperName in _helpers) {
+    log(config, LogLevel.Debug, `Registering helper: ${helperName}`)
+    Handlebars.registerHelper(helperName, _helpers[helperName as keyof typeof _helpers])
+  }
+}
+
+export function handleErr(err: NodeJS.ErrnoException | null): void {
+  if (err) throw err
+}
+
+export function log(config: ScaffoldConfig, level: LogLevel, ...obj: any[]): void {
+  if (config.quiet || config.verbose === LogLevel.None || level < (config.verbose ?? LogLevel.Info)) {
+    return
+  }
+  const levelColor: Record<LogLevel, keyof typeof chalk> = {
+    [LogLevel.None]: "reset",
+    [LogLevel.Debug]: "blue",
+    [LogLevel.Info]: "dim",
+    [LogLevel.Warning]: "yellow",
+    [LogLevel.Error]: "red",
+  }
+  const chalkFn: any = chalk[levelColor[level]]
+  const key: "log" | "warn" | "error" = level === LogLevel.Error ? "error" : level === LogLevel.Warning ? "warn" : "log"
+  const logFn: any = console[key]
+  logFn(
+    ...obj.map((i) =>
+      i instanceof Error
+        ? chalkFn(i, JSON.stringify(i, undefined, 1), i.stack)
+        : typeof i === "object"
+        ? chalkFn(JSON.stringify(i, undefined, 1))
+        : chalkFn(i)
+    )
+  )
+}
+
+export async function createDirIfNotExists(dir: string, config: ScaffoldConfig): Promise<void> {
+  const parentDir = path.dirname(dir)
+
+  if (!(await pathExists(parentDir))) {
+    await createDirIfNotExists(parentDir, config)
+  }
+
+  if (!(await pathExists(dir))) {
+    try {
+      log(config, LogLevel.Debug, `Creating dir ${dir}`)
+      await mkdir(dir)
+      return
+    } catch (e: any) {
+      if (e.code !== "EEXIST") {
+        throw e
+      }
+      return
+    }
+  }
+}
+
+export function getOptionValueForFile<T>(
+  config: ScaffoldConfig,
+  filePath: string,
+  fn: FileResponse<T>,
+  defaultValue?: T
+): T {
+  if (typeof fn !== "function") {
+    return defaultValue ?? (fn as T)
+  }
+  return (fn as FileResponseHandler<T>)(
+    filePath,
+    path.dirname(handlebarsParse(config, filePath, { isPath: true }).toString()),
+    path.basename(handlebarsParse(config, filePath, { isPath: true }).toString())
+  )
+}
+
+export function handlebarsParse(
+  config: ScaffoldConfig,
+  templateBuffer: Buffer | string,
+  { isPath = false }: { isPath?: boolean } = {}
+): Buffer {
+  const { data } = config
+  try {
+    let str = templateBuffer.toString()
+    if (isPath) {
+      str = str.replace(/\\/g, "/")
+    }
+    const parser = Handlebars.compile(str, { noEscape: true })
+    let outputContents = parser(data)
+    if (isPath && path.sep !== "/") {
+      outputContents = outputContents.replace(/\//g, "\\")
+    }
+    return Buffer.from(outputContents)
+  } catch (e) {
+    log(config, LogLevel.Debug, e)
+    log(config, LogLevel.Warning, "Couldn't parse file with handlebars, returning original content")
+    return Buffer.from(templateBuffer)
+  }
+}
+
+export async function pathExists(filePath: string): Promise<boolean> {
+  try {
+    await access(filePath, F_OK)
+    return true
+  } catch (e: any) {
+    if (e.code === "ENOENT") {
+      return false
+    }
+    throw e
+  }
+}
+
+export function pascalCase(s: string): string {
+  return startCase(s).replace(/\s+/g, "")
+}
+
+export async function isDir(path: string): Promise<boolean> {
+  const tplStat = await stat(path)
+  return tplStat.isDirectory()
+}
+
+export function removeGlob(template: string): string {
+  return template.replace(/\*/g, "").replace(/(\/\/|\\\\)/g, path.sep)
+}
+
+export function makeRelativePath(str: string): string {
+  return str.startsWith(path.sep) ? str.slice(1) : str
+}
+
+export function getBasePath(relPath: string): string {
+  return path
+    .resolve(process.cwd(), relPath)
+    .replace(process.cwd() + path.sep, "")
+    .replace(process.cwd(), "")
+}
+
+export async function getFileList(config: ScaffoldConfig, template: string): Promise<string[]> {
+  return (
+    await promisify(glob)(template, {
+      dot: true,
+      debug: config.verbose === LogLevel.Debug,
+      nodir: true,
+    })
+  ).map((f) => f.replace(/\//g, path.sep))
+}
+
+export interface GlobInfo {
+  nonGlobTemplate: string
+  origTemplate: string
+  isDirOrGlob: boolean
+  isGlob: boolean
+  template: string
+}
+
+export async function getTemplateGlobInfo(config: ScaffoldConfig, template: string): Promise<GlobInfo> {
+  const isGlob = glob.hasMagic(template)
+  log(config, LogLevel.Debug, "before isDir", "isGlob:", isGlob, template)
+  let _template = template
+  const nonGlobTemplate = isGlob ? removeGlob(template) : template
+  const isDirOrGlob = isGlob ? true : await isDir(template)
+  log(config, LogLevel.Debug, "after isDir", isDirOrGlob)
+  const _shouldAddGlob = !isGlob && isDirOrGlob
+  const origTemplate = template
+  if (_shouldAddGlob) {
+    _template = path.join(template, "**", "*")
+  }
+  return { nonGlobTemplate, origTemplate, isDirOrGlob, isGlob, template: _template }
+}
+
+export interface OutputFileInfo {
+  inputPath: string
+  outputPathOpt: string
+  outputDir: string
+  outputPath: string
+  exists: boolean
+}
+
+export async function getTemplateFileInfo(
+  config: ScaffoldConfig,
+  { templatePath, basePath }: { templatePath: string; basePath: string }
+): Promise<OutputFileInfo> {
+  const inputPath = path.resolve(process.cwd(), templatePath)
+  const outputPathOpt = getOptionValueForFile(config, inputPath, config.output)
+  const outputDir = getOutputDir(config, outputPathOpt, basePath)
+  const outputPath = handlebarsParse(config, path.join(outputDir, path.basename(inputPath)), {
+    isPath: true,
+  }).toString()
+  const exists = await pathExists(outputPath)
+  return { inputPath, outputPathOpt, outputDir, outputPath, exists }
+}
+
+export async function copyFileTransformed(
+  config: ScaffoldConfig,
+  {
+    exists,
+    overwrite,
+    outputPath,
+    inputPath,
+  }: {
+    exists: boolean
+    overwrite: boolean
+    outputPath: string
+    inputPath: string
+  }
+): Promise<void> {
+  if (!exists || overwrite) {
+    if (exists && overwrite) {
+      log(config, LogLevel.Info, `File ${outputPath} exists, overwriting`)
+    }
+    const templateBuffer = await readFile(inputPath)
+    const unprocessedOutputContents = handlebarsParse(config, templateBuffer)
+    const finalOutputContents =
+      (await config.beforeWrite?.(unprocessedOutputContents, templateBuffer, outputPath)) ?? unprocessedOutputContents
+
+    if (!config.dryRun) {
+      await writeFile(outputPath, finalOutputContents)
+      log(config, LogLevel.Info, "Done.")
+    } else {
+      log(config, LogLevel.Info, "Content output:")
+      log(config, LogLevel.Info, finalOutputContents)
+    }
+  } else if (exists) {
+    log(config, LogLevel.Info, `File ${outputPath} already exists, skipping`)
+  }
+}
+
+export function getOutputDir(config: ScaffoldConfig, outputPathOpt: string, basePath: string): string {
+  return path.resolve(
+    process.cwd(),
+    ...([
+      outputPathOpt,
+      basePath,
+      config.createSubFolder
+        ? config.subFolderNameHelper
+          ? handlebarsParse(config, `{{ ${config.subFolderNameHelper} name }}`).toString()
+          : config.name
+        : undefined,
+    ].filter(Boolean) as string[])
+  )
+}
+
+export function logInputFile(
+  config: ScaffoldConfig,
+  {
+    origTemplate,
+    relPath,
+    template,
+    inputFilePath,
+    nonGlobTemplate,
+    basePath,
+    isDirOrGlob,
+    isGlob,
+  }: {
+    origTemplate: string
+    relPath: string
+    template: string
+    inputFilePath: string
+    nonGlobTemplate: string
+    basePath: string
+    isDirOrGlob: boolean
+    isGlob: boolean
+  }
+): void {
+  log(
+    config,
+    LogLevel.Debug,
+    `\nprocess.cwd(): ${process.cwd()}`,
+    `\norigTemplate: ${origTemplate}`,
+    `\nrelPath: ${relPath}`,
+    `\ntemplate: ${template}`,
+    `\ninputFilePath: ${inputFilePath}`,
+    `\nnonGlobTemplate: ${nonGlobTemplate}`,
+    `\nbasePath: ${basePath}`,
+    `\nisDirOrGlob: ${isDirOrGlob}`,
+    `\nisGlob: ${isGlob}`,
+    `\n`
+  )
+}
+
+export function logInitStep(config: ScaffoldConfig): void {
+  log(config, LogLevel.Debug, "Full config:", {
+    name: config.name,
+    templates: config.templates,
+    output: config.output,
+    createSubfolder: config.createSubFolder,
+    data: config.data,
+    overwrite: config.overwrite,
+    quiet: config.quiet,
+    subFolderTransformHelper: config.subFolderNameHelper,
+    helpers: Object.keys(config.helpers ?? {}),
+    verbose: `${config.verbose} (${Object.keys(LogLevel).find(
+      (k) => (LogLevel[k as any] as unknown as number) === config.verbose!
+    )})`,
+  })
+  log(config, LogLevel.Info, "Data:", config.data)
+}

test.ts

@@ -1,35 +0,0 @@
-import SimpleScaffold from "./scaffold"
-import * as path from "path"
-
-const templateDir = path.join(process.cwd(), "examples")
-
-new SimpleScaffold({
-  templates: [templateDir + "/test-input/Component/**/*"],
-  output: templateDir + "/test-output/no-create-subpath",
-  createSubfolder: false,
-  locals: {
-    property: "myProp",
-    value: '"value"',
-  },
-}).run()
-
-new SimpleScaffold({
-  templates: [templateDir + "/test-input/Component/**/*"],
-  output: templateDir + "/test-output",
-  locals: {
-    property: "myProp",
-    value: '"value"',
-  },
-}).run()
-
-new SimpleScaffold({
-  templates: [templateDir + "/test-input/Component/**/*"],
-  output: (file, basedir, basename) => {
-    console.log({ file, basedir, basename })
-    return file
-  },
-  locals: {
-    property: "myProp",
-    value: '"value"',
-  },
-}).run()

tests/scaffold.test.ts

@@ -0,0 +1,502 @@
+import mockFs from "mock-fs"
+import FileSystem from "mock-fs/lib/filesystem"
+import Scaffold from "../src/scaffold"
+import { readdirSync, readFileSync } from "fs"
+import { Console } from "console"
+import { defaultHelpers } from "../src/utils"
+import { join } from "path"
+import * as dateFns from "date-fns"
+import crypto from "crypto"
+
+const fileStructNormal = {
+  input: {
+    "{{name}}.txt": "Hello, my app is {{name}}",
+  },
+  output: {},
+}
+const fileStructWithBinary = {
+  input: {
+    "{{name}}.txt": "Hello, my app is {{name}}",
+    "{{name}}.bin": crypto.randomBytes(10000),
+  },
+  output: {},
+}
+
+const fileStructWithData = {
+  input: {
+    "{{name}}.txt": "Hello, my value is {{value}}",
+  },
+  output: {},
+}
+
+const fileStructNested = {
+  input: {
+    "{{name}}-1.txt": "This should be in root",
+    "{{Name}}": {
+      "{{name}}-2.txt": "Hello, my value is {{value}}",
+      moreNesting: {
+        "{{name}}-3.txt": "Hi! My value is actually NOT {{value}}!",
+      },
+    },
+  },
+  output: {},
+}
+const fileStructSubdirTransformer = {
+  input: {
+    "{{name}}.txt": "Hello, my app is {{name}}",
+  },
+  output: {},
+}
+
+const defaultHelperNames = Object.keys(defaultHelpers)
+const fileStructHelpers = {
+  input: {
+    defaults: defaultHelperNames.reduce<Record<string, string>>(
+      (all, cur) => ({ ...all, [cur + ".txt"]: `{{ ${cur} name }}` }),
+      {}
+    ),
+    custom: {
+      "add1.txt": "{{ add1 name }}",
+    },
+  },
+  output: {},
+}
+
+const fileStructDates = {
+  input: {
+    "now.txt": "Today is {{ now 'mmm' }}, time is {{ now 'HH:mm' }}",
+    "offset.txt": "Yesterday was {{ now 'mmm' -1 'days' }}, time is {{ now 'HH:mm' -1 'days' }}",
+    "custom.txt": "Custom date is {{ date customDate 'mmm' }}, time is {{ date customDate 'HH:mm' }}",
+  },
+  output: {},
+}
+
+function withMock(fileStruct: FileSystem.DirectoryItems, testFn: jest.EmptyFunction): jest.EmptyFunction {
+  return () => {
+    beforeEach(() => {
+      // console.log("Mocking:", fileStruct)
+      console = new Console(process.stdout, process.stderr)
+
+      mockFs(fileStruct)
+      // logMock = jest.spyOn(console, 'log').mockImplementation((...args) => {
+      //   logsTemp.push(args)
+      // })
+    })
+    testFn()
+    afterEach(() => {
+      // console.log("Restoring mock")
+      mockFs.restore()
+    })
+  }
+}
+
+describe("Scaffold", () => {
+  describe(
+    "create subfolder",
+    withMock(fileStructNormal, () => {
+      test("should not create by default", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+        })
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
+
+      test("should create with config", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          createSubFolder: true,
+          verbose: 0,
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
+    })
+  )
+
+  describe(
+    "binary files",
+    withMock(fileStructWithBinary, () => {
+      test("should copy as-is", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+        })
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+        const dataBin = readFileSync(join(process.cwd(), "output", "app_name.bin"))
+        expect(dataBin).toEqual(fileStructWithBinary.input["{{name}}.bin"])
+      })
+    })
+  )
+
+  describe(
+    "overwrite",
+    withMock(fileStructWithData, () => {
+      test("should not overwrite by default", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          data: { value: "1" },
+          verbose: 0,
+        })
+
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          data: { value: "2" },
+          verbose: 0,
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my value is 1")
+      })
+
+      test("should overwrite with config", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          data: { value: "1" },
+          verbose: 0,
+        })
+
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          data: { value: "2" },
+          overwrite: true,
+          verbose: 0,
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my value is 2")
+      })
+    })
+  )
+
+  describe(
+    "errors",
+    withMock(fileStructNormal, () => {
+      let consoleMock1: jest.SpyInstance
+      beforeAll(() => {
+        consoleMock1 = jest.spyOn(console, "error").mockImplementation(() => void 0)
+      })
+
+      afterAll(() => {
+        consoleMock1.mockRestore()
+      })
+
+      test("should throw for bad input", async () => {
+        await expect(
+          Scaffold({
+            name: "app_name",
+            output: "output",
+            templates: ["non-existing-input"],
+            data: { value: "1" },
+            verbose: 0,
+          })
+        ).rejects.toThrow()
+
+        await expect(
+          Scaffold({
+            name: "app_name",
+            output: "output",
+            templates: ["non-existing-input/non-existing-file.txt"],
+            data: { value: "1" },
+            verbose: 0,
+          })
+        ).rejects.toThrow()
+
+        expect(() => readFileSync(join(process.cwd(), "output", "app_name.txt"))).toThrow()
+      })
+    })
+  )
+
+  describe(
+    "dry run",
+    withMock(fileStructNormal, () => {
+      let consoleMock1: jest.SpyInstance
+      beforeAll(() => {
+        consoleMock1 = jest.spyOn(console, "error").mockImplementation(() => void 0)
+      })
+
+      afterAll(() => {
+        consoleMock1.mockRestore()
+      })
+
+      test("should not write to disk", async () => {
+        Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          data: { value: "1" },
+          verbose: 0,
+          dryRun: true,
+        })
+
+        expect(() => readFileSync(join(process.cwd(), "output", "app_name.txt"))).toThrow()
+      })
+    })
+  )
+
+  describe(
+    "outputPath override",
+    withMock(fileStructNormal, () => {
+      test("should allow override function", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: (fullPath, basedir, basename) => join("custom-output", `${basename.split(".")[0]}`),
+          templates: ["input"],
+          data: { value: "1" },
+          verbose: 0,
+        })
+        const data = readFileSync(join(process.cwd(), "/custom-output/app_name/app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
+    })
+  )
+
+  describe(
+    "output structure",
+    withMock(fileStructNested, () => {
+      test("should maintain input structure on output", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          data: { value: "1" },
+          verbose: 0,
+        })
+
+        const rootDir = readdirSync(join(process.cwd(), "output"))
+        const dir = readdirSync(join(process.cwd(), "output", "AppName"))
+        const nestedDir = readdirSync(join(process.cwd(), "output", "AppName", "moreNesting"))
+        expect(rootDir).toHaveProperty("length")
+        expect(dir).toHaveProperty("length")
+        expect(nestedDir).toHaveProperty("length")
+
+        const rootFile = readFileSync(join(process.cwd(), "output", "app_name-1.txt"))
+        const oneDeepFile = readFileSync(join(process.cwd(), "output", "AppName/app_name-2.txt"))
+        const twoDeepFile = readFileSync(join(process.cwd(), "output", "AppName/moreNesting/app_name-3.txt"))
+        expect(rootFile.toString()).toEqual("This should be in root")
+        expect(oneDeepFile.toString()).toEqual("Hello, my value is 1")
+        expect(twoDeepFile.toString()).toEqual("Hi! My value is actually NOT 1!")
+      })
+    })
+  )
+
+  describe(
+    "capitalization helpers",
+    withMock(fileStructHelpers, () => {
+      const _helpers: Record<string, (text: string) => string> = {
+        add1: (text) => text + " 1",
+      }
+
+      test("should work", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          helpers: _helpers,
+        })
+
+        const results = {
+          camelCase: "appName",
+          snakeCase: "app_name",
+          startCase: "App Name",
+          kebabCase: "app-name",
+          hyphenCase: "app-name",
+          pascalCase: "AppName",
+          lowerCase: "app_name",
+          upperCase: "APP_NAME",
+        }
+        for (const key in results) {
+          const file = readFileSync(join(process.cwd(), "output", "defaults", `${key}.txt`))
+          expect(file.toString()).toEqual(results[key as keyof typeof results])
+        }
+      })
+    })
+  )
+  describe(
+    "date helpers",
+    withMock(fileStructDates, () => {
+      test("should work", async () => {
+        const now = new Date()
+        const yesterday = dateFns.add(new Date(), { days: -1 })
+        const customDate = dateFns.formatISO(dateFns.add(new Date(), { days: -1 }))
+
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          data: { customDate },
+        })
+
+        const nowFile = readFileSync(join(process.cwd(), "output", "now.txt"))
+        const offsetFile = readFileSync(join(process.cwd(), "output", "offset.txt"))
+        const customFile = readFileSync(join(process.cwd(), "output", "custom.txt"))
+
+        // "now.txt": "Today is {{ now 'mmm' }}, time is {{ now 'HH:mm' }}",
+        // "offset.txt": "Yesterday was {{ now 'mmm' -1 'days' }}, time is {{ now 'HH:mm' -1 'days' }}",
+        // "custom.txt": "Custom date is {{ date customDate 'mmm' }}, time is {{ date customDate 'HH:mm' }}",
+
+        expect(nowFile.toString()).toEqual(
+          `Today is ${dateFns.format(now, "mmm")}, time is ${dateFns.format(now, "HH:mm")}`
+        )
+        expect(offsetFile.toString()).toEqual(
+          `Yesterday was ${dateFns.format(yesterday, "mmm")}, time is ${dateFns.format(yesterday, "HH:mm")}`
+        )
+        expect(customFile.toString()).toEqual(
+          `Custom date is ${dateFns.format(dateFns.parseISO(customDate), "mmm")}, time is ${dateFns.format(
+            dateFns.parseISO(customDate),
+            "HH:mm"
+          )}`
+        )
+      })
+    })
+  )
+  describe(
+    "custom helpers",
+    withMock(fileStructHelpers, () => {
+      const _helpers: Record<string, (text: string) => string> = {
+        add1: (text) => text + " 1",
+      }
+      test("should work", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          helpers: _helpers,
+        })
+
+        const results = {
+          add1: "app_name 1",
+        }
+        for (const key in results) {
+          const file = readFileSync(join(process.cwd(), "output", "custom", `${key}.txt`))
+          expect(file.toString()).toEqual(results[key as keyof typeof results])
+        }
+      })
+    })
+  )
+  describe(
+    "transform subfolder",
+    withMock(fileStructSubdirTransformer, () => {
+      test("should work with no helper", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          createSubFolder: true,
+          verbose: 0,
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
+
+      test("should work with default helper", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          createSubFolder: true,
+          verbose: 0,
+          subFolderNameHelper: "upperCase",
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "APP_NAME", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
+
+      test("should work with custom helper", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          createSubFolder: true,
+          verbose: 0,
+          subFolderNameHelper: "test",
+          helpers: {
+            test: () => "REPLACED",
+          },
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "REPLACED", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
+    })
+  )
+  describe(
+    "before write",
+    withMock(fileStructNormal, () => {
+      test("should work with no callback", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          data: {
+            value: "value",
+          },
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
+
+      test("should work with custom callback", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          data: {
+            value: "value",
+          },
+          beforeWrite: (content, beforeContent, outputPath) =>
+            [content.toString().toUpperCase(), beforeContent, outputPath].join(", "),
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toEqual(
+          [
+            "Hello, my app is app_name".toUpperCase(),
+            fileStructNormal.input["{{name}}.txt"],
+            join(process.cwd(), "output", "app_name.txt"),
+          ].join(", ")
+        )
+      })
+      test("should work with undefined response custom callback", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          data: {
+            value: "value",
+          },
+          beforeWrite: () => undefined,
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
+    })
+  )
+})

tests/utils.test.ts

@@ -0,0 +1,91 @@
+import { dateHelper, handlebarsParse, nowHelper } from "../src/utils"
+import { ScaffoldConfig } from "../src/types"
+import path from "path"
+import * as dateFns from "date-fns"
+
+const blankConf: ScaffoldConfig = {
+  verbose: 0,
+  name: "",
+  output: "",
+  templates: [],
+  data: { name: "test" },
+}
+
+describe("Utils", () => {
+  describe("handlebarsParse", () => {
+    let origSep: any
+    describe("windows paths", () => {
+      beforeAll(() => {
+        origSep = path.sep
+        Object.defineProperty(path, "sep", { value: "\\" })
+      })
+      afterAll(() => {
+        Object.defineProperty(path, "sep", { value: origSep })
+      })
+      test("should work for windows paths", async () => {
+        expect(handlebarsParse(blankConf, "C:\\exports\\{{name}}.txt", { isPath: true })).toEqual(
+          Buffer.from("C:\\exports\\test.txt")
+        )
+      })
+    })
+    describe("non-windows paths", () => {
+      beforeAll(() => {
+        origSep = path.sep
+        Object.defineProperty(path, "sep", { value: "/" })
+      })
+      afterAll(() => {
+        Object.defineProperty(path, "sep", { value: origSep })
+      })
+      test("should work for non-windows paths", async () => {
+        expect(handlebarsParse(blankConf, "/home/test/{{name}}.txt", { isPath: true })).toEqual(
+          Buffer.from("/home/test/test.txt")
+        )
+      })
+    })
+    test("should not do path escaping on non-path compiles", async () => {
+      expect(
+        handlebarsParse(
+          { ...blankConf, data: { ...blankConf.data, escaped: "value" } },
+          "/home/test/{{name}} \\{{escaped}}.txt",
+          {
+            isPath: false,
+          }
+        )
+      ).toEqual(Buffer.from("/home/test/test {{escaped}}.txt"))
+    })
+  })
+
+  describe("Helpers", () => {
+    describe("date helpers", () => {
+      describe("now", () => {
+        test("should work without extra params", () => {
+          const now = new Date()
+          const fmt = "yyyy-MM-dd HH:mm"
+
+          expect(nowHelper(fmt)).toEqual(dateFns.format(now, fmt))
+        })
+      })
+
+      describe("date", () => {
+        test("should work with no offset params", () => {
+          const now = new Date()
+          const fmt = "yyyy-MM-dd HH:mm"
+
+          expect(dateHelper(now.toISOString(), fmt)).toEqual(dateFns.format(now, fmt))
+        })
+
+        test("should work with offset params", () => {
+          const now = new Date()
+          const fmt = "yyyy-MM-dd HH:mm"
+
+          expect(dateHelper(now.toISOString(), fmt, -1, "days")).toEqual(
+            dateFns.format(dateFns.add(now, { days: -1 }), fmt)
+          )
+          expect(dateHelper(now.toISOString(), fmt, 1, "months")).toEqual(
+            dateFns.format(dateFns.add(now, { months: 1 }), fmt)
+          )
+        })
+      })
+    })
+  })
+})

tsconfig.json

@@ -1,14 +1,23 @@
 {
   "compilerOptions": {
-    "target": "es5",
+    "target": "ES2019",
     "module": "commonjs",
-    "lib": ["es2017", "es6"],
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "lib": [
+      "ES2019",
+    ],
     "declaration": true,
     "outDir": "dist",
     "strict": true,
-    "sourceMap": true
+    "sourceMap": true,
+    "removeComments": false,
   },
+  "include": [
+    "src/index.ts",
+    "src/cmd.ts",
+  ],
   "exclude": [
-    "examples"
+    "tests/*"
   ]
 }

typedoc.json

@@ -0,0 +1,26 @@
+{
+  "name": "Simple Scaffold",
+  "entryPoints": [
+    "src/index.ts"
+  ],
+  "includeVersion": true,
+  "categorizeByGroup": false,
+  "sort": [
+    "visibility"
+  ],
+  "categoryOrder": [
+    "Main",
+    "*"
+  ],
+  "theme": "doc-theme",
+  "githubPages": true,
+  "entryPointStrategy": "expand",
+  "out": "docs",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "excludeInternal": true,
+  "gaID": "GTM-KHQS9TQ",
+  "validation": {
+    "invalidLink": true
+  }
+}

webpack.config.js

@@ -1,46 +0,0 @@
-const path = require("path")
-const webpack = require("webpack")
-const nodeExternals = require("webpack-node-externals")
-const CopyPlugin = require("copy-webpack-plugin")
-
-module.exports = {
-  devtool:
-    process.env.NODE_ENV === "develop" ? "inline-source-map" : "source-map",
-  target: "node",
-  entry: {
-    index: "./scaffold.ts",
-    test: "./test.ts",
-    cmd: "./cmd.ts",
-  },
-  output: {
-    filename: "[name].js",
-    path: path.resolve(__dirname, "dist"),
-    devtoolModuleFilenameTemplate: "[absolute-resource-path]",
-    library: "library",
-    libraryTarget: "umd",
-  },
-  resolve: {
-    extensions: [".ts"],
-  },
-  externals: [nodeExternals()],
-  module: {
-    rules: [
-      {
-        test: [/\.tsx?$/],
-        loader: "ts-loader",
-        exclude: [/\/examples\//, /\/node_modules\//],
-      },
-    ],
-  },
-  plugins: [
-    new webpack.DefinePlugin({
-      __dirname: "__dirname",
-    }),
-    new webpack.BannerPlugin({
-      banner: "#!/usr/bin/env node",
-      raw: true,
-      include: [/cmd\.js/],
-    }),
-    new CopyPlugin({ patterns: ["index.d.ts"] }),
-  ],
-}