bump version number [publish]

replace node version
windows separator fixes on config [publish]
2026-05-18 01:29:09 +00:00 · 2022-05-23 21:22:17 +03:00 · 2022-05-23 21:17:24 +03:00 · 2022-05-23 20:59:49 +03:00 · 2022-05-18 01:04:10 +03:00 · 2022-05-15 14:32:22 +03:00
27 changed files with 1115 additions and 347 deletions
--- a/.editorconfig
+++ b/.editorconfig
@@ -3,3 +3,6 @@ tab_width = 2
 indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
--- a/.github/workflows/develop.yml
+++ b/.github/workflows/develop.yml
@@ -2,7 +2,9 @@ name: Alpha Releases

 on:
  push:
-    branches: [develop]
+    branches: [develop, fix/*, feature/*]
+  # pull_request:
+  #   branches: [master, develop]
 jobs:
  build:
    runs-on: ubuntu-latest
@@ -11,26 +13,26 @@ jobs:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
-          node-version: "12.x"
+          node-version: "14.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]')"
+        if: "contains(github.event.head_commit.message, '[publish]')"
      - uses: Klemensas/action-autotag@stable
-        if: "!contains(github.event.head_commit.message, '[skip publish]')"
+        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, '[skip publish]')"
+        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, '[skip publish]')
+        if: steps.update_tag.outputs.tagname && contains(github.event.head_commit.message, '[publish]')
        uses: actions/create-release@v1
        id: create_release
        env:
@@ -40,7 +42,7 @@ jobs:
          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]')
+        if: steps.update_tag.outputs.tagname && contains(github.event.head_commit.message, '[publish]')
        id: upload-release-asset
        uses: actions/upload-release-asset@v1
        env:
--- a/.github/workflows/docs.yml
+++ b/.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: "14.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
--- a/.github/workflows/pull_requests.yml
+++ b/.github/workflows/pull_requests.yml
@@ -11,7 +11,7 @@ jobs:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
-          node-version: "12.x"
+          node-version: "14.x"
      - run: yarn install --frozen-lockfile
      - run: yarn build
      - run: yarn test
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -11,7 +11,7 @@ jobs:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
-          node-version: "12.x"
+          node-version: "14.x"
      - run: yarn install --frozen-lockfile
      - run: yarn test
      - run: yarn build
--- a/.gitignore
+++ b/.gitignore
@@ -42,6 +42,9 @@ typings/
 # Optional npm cache directory
 .npm

+# NPM
+.npmrc
+
 # Optional eslint cache
 .eslintcache

@@ -61,3 +64,4 @@ examples/test-output/**/*
 dist/
 .DS_Store
 tmp/
+docs/
--- a/.markdownlint.json
+++ b/.markdownlint.json
@@ -1,8 +1,9 @@
 {
-  "MD013": {
+  "line-length": {
    "line_length": 100,
    "tables": false,
    "code_blocks": false
  },
-  "MD033": false
-}
+  "no-inline-html": false,
+  "first-line-h1": false
+}
--- a/.prettierrc
+++ b/.prettierrc
@@ -1,5 +1,6 @@
 {
  "semi": false,
+  "trailingComma": "all",
  "printWidth": 120,
  "tabWidth": 2
 }
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -10,5 +10,11 @@
    "noext",
    "nonegate",
    "subdir"
-  ]
-}
+  ],
+  "[markdown]": {
+    "editor.rulers": [
+      87,
+      100
+    ],
+  },
+}
--- a/.vscode/tasks.json
+++ b/.vscode/tasks.json
@@ -13,6 +13,12 @@
      "type": "npm",
      "problemMatcher": [],
    },
+    {
+      "command": "yarn typedoc --watch",
+      "label": "typedoc --watch",
+      "type": "shell",
+      "problemMatcher": [],
+    },
    {
      "script": "start",
      "label": "start",
@@ -50,4 +56,4 @@
      "problemMatcher": [],
    },
  ],
-}
+}
--- a/README.md
+++ b/README.md
@@ -1,41 +1,53 @@
-# Simple Scaffold
+<h1 align="center">Simple Scaffold</h1>

-Simple Scaffold allows you to generate any set of files in the easiest way possible with simple commands.
+<h2 align="center">

-It is completely framework agnostic so you can use it for anything from a few simple files to an
-entire app boilerplate setup.
+[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)

-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.
+</h2>
+Generate any set of files in the easiest way possible with simple commands.
+
+It is completely agnostic and un-opinionated 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.
+
+<div align="center">
+
+![sample animation](media/intro.gif)
+
+</div>

 <br />

 <details>
  <summary>Table of contents</summary>

- [Simple Scaffold](#simple-scaffold)
-  - [Install](#install)
-  - [Use as a command line tool](#use-as-a-command-line-tool)
-    - [Command Line Options](#command-line-options)
-  - [Use in Node.js](#use-in-nodejs)
-    - [Node-specific options](#node-specific-options)
-  - [Preparing files](#preparing-files)
-    - [Template files](#template-files)
-    - [Variable/token replacement](#variabletoken-replacement)
+- [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)
+- [Examples](#examples)
+  - [Run](#run)
    - [Command Example](#command-example)
-    - [Example Scaffold Input](#example-scaffold-input)
-      - [Input Directory structure](#input-directory-structure)
-      - [Contents of `project/scaffold/{{Name}}.jsx`](#contents-of-projectscaffoldnamejsx)
-    - [Example Scaffold Output](#example-scaffold-output)
-    - [Output directory structure](#output-directory-structure)
-      - [Contents of `project/scaffold/MyComponent/MyComponent.jsx`](#contents-of-projectscaffoldmycomponentmycomponentjsx)
-  - [Contributing](#contributing)
+    - [Equivalent Node Module Example](#equivalent-node-module-example)
+  - [Files](#files)
+    - [Input](#input)
+    - [Output](#output)
+- [Contributing](#contributing)

 </details>

@@ -54,11 +66,14 @@ yarn [global] add simple-scaffold
 npx simple-scaffold@latest <...args>
 ```

-## Use as a command line tool
+## Command Line Interface (CLI)

-### Command Line Options
+### Available flags

-```plaintext
+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`.
+
+```text
 Usage: simple-scaffold [options]

 Create structured files based on templates.
@@ -67,26 +82,26 @@ 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.
+  --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.
+  --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.
+  --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)
+  --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`.
@@ -101,9 +116,9 @@ Options:
                                  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)
+                                  scaffolds and making sure they don't fail, without
+                                  having to write actual file contents or create
+                                  directories. (default: false)
 ```

 You can also add this as a script in your `package.json`:
@@ -116,7 +131,7 @@ You can also add this as a script in your `package.json`:
 }
 ```

-## Use in Node.js
+## Node module

 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.
@@ -174,8 +189,8 @@ Examples:
 | 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`                               |
+| `./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

@@ -197,7 +212,7 @@ npx simple-scaffold@latest \

 Will output a file with the path:

-```plaintext
+```text
 <working_dir>/src/components/MyComponent.jsx
 ```

@@ -209,19 +224,21 @@ Your `data` will be pre-populated with the following:
 - `{{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
+> 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.

-### Built-in Helpers
+### Helpers

-Simple-Scaffold provides some built-in text transformation filters usable by handleBars.
+#### 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
+##### Capitalization Helpers

 | Helper name  | Example code            | Example output |
 | ------------ | ----------------------- | -------------- |
@@ -235,7 +252,7 @@ replace `My Name` with `my_name` when producing the final value.
 | `upperCase`  | `{{ upperCase name }}`  | MY NAME        |
 | `lowerCase`  | `{{ lowerCase name }}`  | my name        |

-#### Date helpers
+##### Date helpers

 | Helper name                      | Description                                                      | Example code                                                     | Example output     |
 | -------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------ |
@@ -247,29 +264,29 @@ replace `My Name` with `my_name` when producing the final value.

 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
+- 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"
-    )
-    ```
+  ```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.
+- **The now helper** (for current time) takes the same arguments, minus the first one (`date`) as it
+  is implicitly the current date.

-### Custom Helpers
+#### 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:
+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 = {
@@ -285,80 +302,105 @@ All of the above helpers (built in and custom) will also be available to you whe

 ## Examples

-### Command Example
+### Run
+
+#### Command Example

 ```bash
 simple-scaffold MyComponent \
    -t project/scaffold/**/* \
    -o src/components \
-    -d '{"className": "myClassName"}'
+    -d '{"className": "myClassName","author": "Chen Asraf"}'
    MyComponent
 ```

-### Example Scaffold Input
+#### Equivalent Node Module Example

-#### Input Directory structure
+```typescript
+import Scaffold from "simple-scaffold"

-```plaintext
- project
-  - scaffold
-    - {{Name}}.js
-  - src
-    - components
-    - ...
-```
-
-#### Contents of `project/scaffold/{{Name}}.jsx`
-
-```typescriptreact
-import React from 'react'
-
-export default {{camelCase name}}: React.FC = (props) => {
-  return (
-    <div className="{{className}}">{{camelCase name}} Component</div>
-  )
+async function main() {
+  await Scaffold({
+    name: "MyComponent",
+    templates: ["project/scaffold/**/*"],
+    output: ["src/components"],
+    data: {
+      className: "myClassName",
+      author: "Chen Asraf"
+    },
+  })
+  console.log("Done.")
 }
 ```

-### Example Scaffold Output
+### Files

-### Output directory structure
+#### Input

-```plaintext
- project
-  - src
-    - components
-      - MyComponent
-        - MyComponent.js
-    - ...
-```
+- Input file path:

-With `createSubFolder = false`:
+  ```text
+  project → scaffold → {{Name}}.js → src → components
+  ```

-```plaintext
- project
-  - src
-    - components
-      - MyComponent.js
-    - ...
-```
+- Input file contents:

-#### Contents of `project/scaffold/MyComponent/MyComponent.jsx`
+  ```typescript
+  /**
+   * Author: {{ author }}
+   * Date: {{ now "yyyy-MM-dd" }}
+   */
+  import React from 'react'

-```typescriptreact
-import React from 'react'
+  export default {{camelCase name}}: React.FC = (props) => {
+    return (
+      <div className="{{className}}">{{camelCase name}} Component</div>
+    )
+  }
+  ```

-export default MyComponent: React.FC = (props) => {
-  return (
-    <div className="myClassName">MyComponent 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
+  /**
+   * Author: Chen Asraf
+   * Date: 2022-01-01
+   */
+  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
+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'>
@@ -386,9 +428,18 @@ Some tips on getting around the code:
  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.
+- 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.
+  > This requires an updated build, and does not trigger one itself. From here you have several
+  > options:
+  >
+  > - Run `yarn dev` to watch and build automatically
+  > - Run `yarn build` before running this
+  > - Run `yarn build-cmd` which triggers a build right before running `yarn cmd` automatically with
+  >   the rest of the given arguments.
+
+- Use `yarn build-docs` to build the documentation once
+- Use `yarn watch-docs` to start docs in watch mode
+- To see the documentation, currently you have to serve the directory yourself with a static web
+  server (like node's built in serve, VS code's "Go Live" mode, etc)
--- a/doc-theme/.gitignore
+++ b/doc-theme/.gitignore
@@ -0,0 +1,2 @@
+node_modules/
+build/
--- a/doc-theme/package.json
+++ b/doc-theme/package.json
@@ -0,0 +1,18 @@
+{
+  "name": "doc-theme",
+  "version": "1.0.0",
+  "keywords": [
+    "typedocplugin"
+  ],
+  "scripts": {
+    "build": "tsc && yarn copy-files && yarn post-build",
+    "copy-files": "cp package.json build/",
+    "post-build": "rimraf node_modules"
+  },
+  "main": "build/index.js",
+  "devDependencies": {
+    "rimraf": "^3.0.2",
+    "typedoc": "^0.22.15",
+    "typescript": "^4.6.3"
+  }
+}
--- a/doc-theme/src/index.tsx
+++ b/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)
+}
--- a/doc-theme/tsconfig.json
+++ b/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. */
+  }
+}
--- a/doc-theme/yarn.lock
+++ b/doc-theme/yarn.lock
@@ -0,0 +1,146 @@
+# 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.1.3, 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=
+
+rimraf@^3.0.2:
+  version "3.0.2"
+  resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a"
+  integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==
+  dependencies:
+    glob "^7.1.3"
+
+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=
--- a/examples/test-input/Component/button-example.png
+++ b/examples/test-input/Component/button-example.png
--- a/media/intro.gif
+++ b/media/intro.gif
--- a/package.json
+++ b/package.json
@@ -1,7 +1,8 @@
 {
  "name": "simple-scaffold",
-  "version": "1.1.0",
+  "version": "1.1.3-pre.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",
@@ -26,7 +27,11 @@
    "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",
+    "build-docs": "yarn build-docs-theme && yarn install --frozen-lockfile && typedoc",
+    "build-docs-theme": "cd doc-theme && yarn install && yarn build && cd ..",
+    "watch-docs": "yarn typedoc --watch",
+    "audit-fix": "npm_config_yes=true npx yarn-audit-fix --flow=convert"
  },
  "dependencies": {
    "chalk": "^4.1.2",
@@ -43,11 +48,13 @@
    "@types/lodash": "^4.14.171",
    "@types/mock-fs": "^4.13.1",
    "@types/node": "^14.14.22",
+    "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"
  }
-}
+}
--- a/src/cmd.ts
+++ b/src/cmd.ts
@@ -3,8 +3,12 @@ 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())

-export function parseCliArgs(args = process.argv.slice(2)) {
  return (
    massarg<ScaffoldCmdConfig & { help: boolean; extras: string[] }>()
      .main(Scaffold)
@@ -67,7 +71,10 @@ export function parseCliArgs(args = process.argv.slice(2)) {
        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.`,
+        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({
@@ -88,9 +95,12 @@ export function parseCliArgs(args = process.argv.slice(2)) {
        binName: "simple-scaffold",
        useGlobalColumns: true,
        usageExample: "[options]",
-        header: "Create structured files based on templates.",
+        header: [`Create structured files based on templates.`].join("\n"),
        footer: [
-          `Copyright © Chen Asraf 2021`,
+          `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"),
--- a/src/scaffold.ts
+++ b/src/scaffold.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ * Simple Scaffold
+ *
+ * See [readme](README.md)
+ */
 import path from "path"

 import {
@@ -31,46 +37,47 @@ import { LogLevel, ScaffoldConfig } from "./types"
 * 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. Common cases are transforming name-case format
- * (e.g. `MyName` &rarr; `my_name`), so these have been provided as defaults:
- *
- * | Helper name | Example code            | Example output |
- * | ----------- | ----------------------- | -------------- |
- * | 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 }}`  | MYNAME         |
- * | lowerCase   | `{{ lowerCase name }}`  | myname         |
+ * 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 DefaultHelpers}.
+ *
+ * @param {ScaffoldConfig} config The main configuration object
+ *
+ * @see {@link DefaultHelpers}
+ * @see {@link CaseHelpers}
+ * @see {@link DateHelpers}
+ *
+ * @category Main
 */
-export async function Scaffold({ ...options }: ScaffoldConfig): Promise<void> {
-  options.output ??= process.cwd()
+export async function Scaffold(config: ScaffoldConfig): Promise<void> {
+  config.output ??= process.cwd()

-  registerHelpers(options)
+  registerHelpers(config)
  try {
-    options.data = { name: options.name, Name: pascalCase(options.name), ...options.data }
-    logInitStep(options)
-    for (let _template of options.templates) {
+    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(
-          options,
-          _template
+          config,
+          _template,
        )
-        const files = await getFileList(options, 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(options, {
+          logInputFile(config, {
            origTemplate,
            relPath,
            template,
@@ -80,7 +87,7 @@ export async function Scaffold({ ...options }: ScaffoldConfig): Promise<void> {
            isDirOrGlob,
            isGlob,
          })
-          await handleTemplateFile(options, options.data, {
+          await handleTemplateFile(config, {
            templatePath: inputFilePath,
            basePath,
          })
@@ -90,25 +97,24 @@ export async function Scaffold({ ...options }: ScaffoldConfig): Promise<void> {
      }
    }
  } catch (e: any) {
-    log(options, LogLevel.Error, e)
+    log(config, LogLevel.Error, e)
    throw e
  }
 }
 async function handleTemplateFile(
-  options: ScaffoldConfig,
-  data: Record<string, string>,
-  { templatePath, basePath }: { templatePath: string; basePath: string }
+  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(options, data, {
+      const { inputPath, outputPathOpt, outputDir, outputPath, exists } = await getTemplateFileInfo(config, {
        templatePath,
        basePath,
      })
-      const overwrite = getOptionValueForFile(options, inputPath, options.overwrite ?? false)
+      const overwrite = getOptionValueForFile(config, inputPath, config.overwrite ?? false)

      log(
-        options,
+        config,
        LogLevel.Debug,
        `\nParsing ${templatePath}`,
        `\nBase path: ${basePath}`,
@@ -116,13 +122,13 @@ async function handleTemplateFile(
        `\nOutput Path Opt: ${outputPathOpt}`,
        `\nFull output dir: ${outputDir}`,
        `\nFull output path: ${outputPath}`,
-        `\n`
+        `\n`,
      )

-      await createDirIfNotExists(path.dirname(outputPath), options)
+      await createDirIfNotExists(path.dirname(outputPath), config)

-      log(options, LogLevel.Info, `Writing to ${outputPath}`)
-      await copyFileTransformed(options, { exists, overwrite, outputPath, inputPath })
+      log(config, LogLevel.Info, `Writing to ${outputPath}`)
+      await copyFileTransformed(config, { exists, overwrite, outputPath, inputPath })
      resolve()
    } catch (e: any) {
      handleErr(e)
--- a/src/types.ts
+++ b/src/types.ts
@@ -1,33 +1,15 @@
 import { HelperDelegate } from "handlebars/runtime"

-export enum LogLevel {
-  None = 0,
-  Debug = 1,
-  Info = 2,
-  Warning = 3,
-  Error = 4,
-}
-
-export type FileResponseFn<T> = (fullPath: string, basedir: string, basename: string) => T
-
-export type FileResponse<T> = T | FileResponseFn<T>
-
-export type DefaultHelperKeys =
-  | "camelCase"
-  | "date"
-  | "hyphenCase"
-  | "kebabCase"
-  | "lowerCase"
-  | "now"
-  | "pascalCase"
-  | "snakeCase"
-  | "startCase"
-  | "upperCase"
-
-export type HelperKeys<T> = DefaultHelperKeys | T
-
-export type Helper = HelperDelegate
-
+/**
+ * The config object for defining a scaffolding group.
+ *
+ * @see https://github.com/chenasraf/simple-scaffold#readme
+ * @see {@link DefaultHelpers}
+ * @see {@link CaseHelpers}
+ * @see {@link DateHelpers}
+ *
+ * @category Config
+ */
 export interface ScaffoldConfig {
  /**
   * Name to be passed to the generated files. `{{name}}` and `{{Name}}` inside contents and file names will be replaced
@@ -37,46 +19,77 @@ export interface ScaffoldConfig {

  /**
   * 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)
+   * 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. */
+  /**
+   * 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>

  /**
-   * Create subfolder with the input name (default: `false`)
+   * 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, string>
+  data?: Record<string, any>

  /**
-   * Enable to override output files, even if they already exist. (default: `false`)
+   * 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`) */
+  /**
+   * 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. (default: `2 (info)`)
-   * @see LogLevel
+   * 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`)
+   * actual file contents or create directories.
+   *
+   * @default `false`
   */
  dryRun?: boolean

@@ -84,7 +97,7 @@ export interface ScaffoldConfig {
   * 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
+   * (text: string, ...args: any[]) => string
   * ```
   *
   * A full example might be:
@@ -93,20 +106,47 @@ export interface ScaffoldConfig {
   * Scaffold({
   *   //...
   *   helpers: {
-   *     upperCamelCase: (text) => camelCase(text).toUpperCase()
+   *     upperKebabCase: (text) => kebabCase(text).toUpperCase()
   *   }
   * })
   * ```
   *
-   * See the list of all the built-in available helpers, or how to define your own in the [readme](https://github.com/chenasraf/simple-scaffold#built-in-helpers).
+   * Which will allow:
+   *
+   * ```
+   * {{ upperKebabCase "my value" }}
+   * ```
+   *
+   * To transform to:
+   *
+   * ```
+   * MY-VALUE
+   * ```
+   *
+   * See {@link DefaultHelpers} for a list of all the built-in available helpers.
+   *
+   * Simple Scaffold uses Handlebars.js, so all the syntax from there is supported. See
+   * [their docs](https://handlebarsjs.com/guide/#custom-helpers) for more information.
+   *
+   * @see {@link DefaultHelpers}
+   * @see {@link CaseHelpers}
+   * @see {@link DateHelpers}
+   * @see https://casraf.blog/simple-scaffold#helpers
+   * @see https://casraf.blog/simple-scaffold#built-in-helpers
+   * @see https://handlebarsjs.com/guide/#custom-helpers
   */
  helpers?: Record<string, Helper>

  /**
   * Default transformer to apply to subfolder name when using `createSubFolder: true`. Can be one of the default
-   * helpers, or a custom one you provide to `helpers`. Defaults to `undefined`, which means no transformation is done.
+   * capitalization helpers, or a custom one you provide to `helpers`. Defaults to `undefined`, which means no
+   * transformation is done.
+   *
+   * @see {@link createSubFolder}
+   * @see {@link CaseHelpers}
+   * @see {@link DefaultHelpers}
   */
-  subFolderNameHelper?: DefaultHelperKeys | string
+  subFolderNameHelper?: DefaultHelpers | string

  /**
   * This callback runs right before content is being written to the disk. If you supply this function, you may return
@@ -119,15 +159,172 @@ export interface ScaffoldConfig {
   * @param rawContent The original template before token replacement
   * @param outputPath The final output path of the processed file
   *
-   * @returns `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()`)
+   * @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
+    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 DefaultHelpers}
+ * @see {@link DateHelpers}
+ * @see {@link ScaffoldConfig}
+ * @see {@link subFolderNameHelper}
+ *
+ * @category Helpers
+ */
+export type CaseHelpers =
+  | "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` |
+ *
+ * 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.
+ *
+ * @see {@link DefaultHelpers}
+ * @see {@link CaseHelpers}
+ * @see {@link ScaffoldConfig}
+ *
+ * @category Helpers
+ */
+export type DateHelpers = "date" | "now"
+
+/**
+ * The names of all the available helper functions in templates.
+ * Simple-Scaffold provides some built-in text transformation filters usable by Handlebars.js.
+ *
+ * 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 CaseHelpers}
+ * @see {@link DateHelpers}
+ * @see {@link ScaffoldConfig}
+ *
+ * @category Helpers
+ */
+export type DefaultHelpers = CaseHelpers | DateHelpers
+
+/**
+ * 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[]
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -1,6 +1,6 @@
 import path from "path"
 import { F_OK } from "constants"
-import { DefaultHelperKeys, FileResponse, FileResponseFn, Helper, LogLevel, ScaffoldConfig } from "./types"
+import { DefaultHelpers, FileResponse, FileResponseHandler, Helper, LogLevel, ScaffoldConfig } from "./types"
 import camelCase from "lodash/camelCase"
 import snakeCase from "lodash/snakeCase"
 import kebabCase from "lodash/kebabCase"
@@ -23,7 +23,7 @@ import { glob } from "glob"
 import { promisify } from "util"
 const { readFile, writeFile } = fsPromises

-export const defaultHelpers: Record<DefaultHelperKeys, Helper> = {
+export const defaultHelpers: Record<DefaultHelpers, Helper> = {
  camelCase,
  snakeCase,
  startCase,
@@ -41,13 +41,13 @@ export function _dateHelper(
  date: Date,
  formatString: string,
  durationDifference: number,
-  durationType: keyof Duration
+  durationType: keyof Duration,
 ): string
 export function _dateHelper(
  date: Date,
  formatString: string,
  durationDifference?: number,
-  durationType?: keyof Duration
+  durationType?: keyof Duration,
 ): string {
  if (durationType && durationDifference !== undefined) {
    return dateFns.format(dateFns.add(date, { [durationType]: durationDifference }), formatString)
@@ -66,22 +66,22 @@ export function dateHelper(
  date: string,
  formatString: string,
  durationDifference: number,
-  durationType: keyof Duration
+  durationType: keyof Duration,
 ): string

 export function dateHelper(
  date: string,
  formatString: string,
  durationDifference?: number,
-  durationType?: keyof Duration
+  durationType?: keyof Duration,
 ): string {
  return _dateHelper(dateFns.parseISO(date), formatString, durationDifference!, durationType!)
 }

-export function registerHelpers(options: ScaffoldConfig): void {
-  const _helpers = { ...defaultHelpers, ...options.helpers }
+export function registerHelpers(config: ScaffoldConfig): void {
+  const _helpers = { ...defaultHelpers, ...config.helpers }
  for (const helperName in _helpers) {
-    log(options, LogLevel.Debug, `Registering helper: ${helperName}`)
+    log(config, LogLevel.Debug, `Registering helper: ${helperName}`)
    Handlebars.registerHelper(helperName, _helpers[helperName as keyof typeof _helpers])
  }
 }
@@ -90,8 +90,8 @@ export function handleErr(err: NodeJS.ErrnoException | null): void {
  if (err) throw err
 }

-export function log(options: ScaffoldConfig, level: LogLevel, ...obj: any[]): void {
-  if (options.quiet || options.verbose === LogLevel.None || level < (options.verbose ?? LogLevel.Info)) {
+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> = {
@@ -110,21 +110,21 @@ export function log(options: ScaffoldConfig, level: LogLevel, ...obj: any[]): vo
        ? chalkFn(i, JSON.stringify(i, undefined, 1), i.stack)
        : typeof i === "object"
        ? chalkFn(JSON.stringify(i, undefined, 1))
-        : chalkFn(i)
-    )
+        : chalkFn(i),
+    ),
  )
 }

-export async function createDirIfNotExists(dir: string, options: ScaffoldConfig): Promise<void> {
+export async function createDirIfNotExists(dir: string, config: ScaffoldConfig): Promise<void> {
  const parentDir = path.dirname(dir)

  if (!(await pathExists(parentDir))) {
-    await createDirIfNotExists(parentDir, options)
+    await createDirIfNotExists(parentDir, config)
  }

  if (!(await pathExists(dir))) {
    try {
-      log(options, LogLevel.Debug, `Creating dir ${dir}`)
+      log(config, LogLevel.Debug, `Creating dir ${dir}`)
      await mkdir(dir)
      return
    } catch (e: any) {
@@ -136,28 +136,32 @@ export async function createDirIfNotExists(dir: string, options: ScaffoldConfig)
  }
 }

+export function pathSepFix(pathname: string): string {
+  return pathname.replace(/[\\\/]+/g, path.sep)
+}
+
 export function getOptionValueForFile<T>(
-  options: ScaffoldConfig,
+  config: ScaffoldConfig,
  filePath: string,
  fn: FileResponse<T>,
-  defaultValue?: T
+  defaultValue?: T,
 ): T {
  if (typeof fn !== "function") {
    return defaultValue ?? (fn as T)
  }
-  return (fn as FileResponseFn<T>)(
+  return (fn as FileResponseHandler<T>)(
    filePath,
-    path.dirname(handlebarsParse(options, filePath, { isPath: true }).toString()),
-    path.basename(handlebarsParse(options, filePath, { isPath: true }).toString())
+    path.dirname(handlebarsParse(config, filePath, { isPath: true }).toString()),
+    path.basename(handlebarsParse(config, filePath, { isPath: true }).toString()),
  )
 }

 export function handlebarsParse(
-  options: ScaffoldConfig,
+  config: ScaffoldConfig,
  templateBuffer: Buffer | string,
-  { isPath = false }: { isPath?: boolean } = {}
+  { isPath = false }: { isPath?: boolean } = {},
 ): Buffer {
-  const { data } = options
+  const { data } = config
  try {
    let str = templateBuffer.toString()
    if (isPath) {
@@ -165,13 +169,13 @@ export function handlebarsParse(
    }
    const parser = Handlebars.compile(str, { noEscape: true })
    let outputContents = parser(data)
-    if (isPath && path.sep !== "/") {
-      outputContents = outputContents.replace(/\//g, "\\")
+    if (isPath) {
+      outputContents = pathSepFix(outputContents)
    }
    return Buffer.from(outputContents)
  } catch (e) {
-    log(options, LogLevel.Debug, e)
-    log(options, LogLevel.Warning, "Couldn't parse file with handlebars, returning original content")
+    log(config, LogLevel.Debug, e)
+    log(config, LogLevel.Warning, "Couldn't parse file with handlebars, returning original content")
    return Buffer.from(templateBuffer)
  }
 }
@@ -206,17 +210,16 @@ export function makeRelativePath(str: string): string {
 }

 export function getBasePath(relPath: string): string {
-  return path
-    .resolve(process.cwd(), relPath)
+  return pathSepFix(path.resolve(process.cwd(), relPath))
    .replace(process.cwd() + path.sep, "")
    .replace(process.cwd(), "")
 }

-export async function getFileList(options: ScaffoldConfig, template: string): Promise<string[]> {
+export async function getFileList(config: ScaffoldConfig, template: string): Promise<string[]> {
  return (
    await promisify(glob)(template, {
      dot: true,
-      debug: options.verbose === LogLevel.Debug,
+      debug: config.verbose === LogLevel.Debug,
      nodir: true,
    })
  ).map((f) => f.replace(/\//g, path.sep))
@@ -230,13 +233,13 @@ export interface GlobInfo {
  template: string
 }

-export async function getTemplateGlobInfo(options: ScaffoldConfig, template: string): Promise<GlobInfo> {
+export async function getTemplateGlobInfo(config: ScaffoldConfig, template: string): Promise<GlobInfo> {
  const isGlob = glob.hasMagic(template)
-  log(options, LogLevel.Debug, "before isDir", "isGlob:", isGlob, 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(options, LogLevel.Debug, "after isDir", isDirOrGlob)
+  log(config, LogLevel.Debug, "after isDir", isDirOrGlob)
  const _shouldAddGlob = !isGlob && isDirOrGlob
  const origTemplate = template
  if (_shouldAddGlob) {
@@ -254,22 +257,20 @@ export interface OutputFileInfo {
 }

 export async function getTemplateFileInfo(
-  options: ScaffoldConfig,
-  data: Record<string, string>,
-  { templatePath, basePath }: { templatePath: string; basePath: string }
+  config: ScaffoldConfig,
+  { templatePath, basePath }: { templatePath: string; basePath: string },
 ): Promise<OutputFileInfo> {
-  const inputPath = path.resolve(process.cwd(), templatePath)
-  const outputPathOpt = getOptionValueForFile(options, inputPath, options.output)
-  const outputDir = getOutputDir(options, outputPathOpt, basePath)
-  const outputPath = handlebarsParse(options, path.join(outputDir, path.basename(inputPath)), {
-    isPath: true,
-  }).toString()
+  const inputPath = pathSepFix(path.resolve(process.cwd(), templatePath))
+  const outputPathOpt = pathSepFix(getOptionValueForFile(config, inputPath, config.output))
+  const outputDir = pathSepFix(getOutputDir(config, outputPathOpt, basePath))
+  const _rawOutputPath = pathSepFix(path.join(outputDir, path.basename(inputPath)))
+  const outputPath = handlebarsParse(config, _rawOutputPath, { isPath: true }).toString()
  const exists = await pathExists(outputPath)
  return { inputPath, outputPathOpt, outputDir, outputPath, exists }
 }

 export async function copyFileTransformed(
-  options: ScaffoldConfig,
+  config: ScaffoldConfig,
  {
    exists,
    overwrite,
@@ -280,47 +281,46 @@ export async function copyFileTransformed(
    overwrite: boolean
    outputPath: string
    inputPath: string
-  }
+  },
 ): Promise<void> {
  if (!exists || overwrite) {
    if (exists && overwrite) {
-      log(options, LogLevel.Info, `File ${outputPath} exists, overwriting`)
+      log(config, LogLevel.Info, `File ${outputPath} exists, overwriting`)
    }
    const templateBuffer = await readFile(inputPath)
-    const unprocessedOutputContents = handlebarsParse(options, templateBuffer)
-    const finalOutputContents = (
-      (await options.beforeWrite?.(unprocessedOutputContents, templateBuffer, outputPath)) ?? unprocessedOutputContents
-    ).toString()
+    const unprocessedOutputContents = handlebarsParse(config, templateBuffer)
+    const finalOutputContents =
+      (await config.beforeWrite?.(unprocessedOutputContents, templateBuffer, outputPath)) ?? unprocessedOutputContents

-    if (!options.dryRun) {
+    if (!config.dryRun) {
      await writeFile(outputPath, finalOutputContents)
-      log(options, LogLevel.Info, "Done.")
+      log(config, LogLevel.Info, "Done.")
    } else {
-      log(options, LogLevel.Info, "Content output:")
-      log(options, LogLevel.Info, finalOutputContents)
+      log(config, LogLevel.Info, "Content output:")
+      log(config, LogLevel.Info, finalOutputContents)
    }
  } else if (exists) {
-    log(options, LogLevel.Info, `File ${outputPath} already exists, skipping`)
+    log(config, LogLevel.Info, `File ${outputPath} already exists, skipping`)
  }
 }

-export function getOutputDir(options: ScaffoldConfig, outputPathOpt: string, basePath: string): string {
+export function getOutputDir(config: ScaffoldConfig, outputPathOpt: string, basePath: string): string {
  return path.resolve(
    process.cwd(),
    ...([
      outputPathOpt,
      basePath,
-      options.createSubFolder
-        ? options.subFolderNameHelper
-          ? handlebarsParse(options, `{{ ${options.subFolderNameHelper} name }}`).toString()
-          : options.name
+      config.createSubFolder
+        ? config.subFolderNameHelper
+          ? handlebarsParse(config, `{{ ${config.subFolderNameHelper} name }}`).toString()
+          : config.name
        : undefined,
-    ].filter(Boolean) as string[])
+    ].filter(Boolean) as string[]),
  )
 }

 export function logInputFile(
-  options: ScaffoldConfig,
+  config: ScaffoldConfig,
  {
    origTemplate,
    relPath,
@@ -339,10 +339,10 @@ export function logInputFile(
    basePath: string
    isDirOrGlob: boolean
    isGlob: boolean
-  }
+  },
 ): void {
  log(
-    options,
+    config,
    LogLevel.Debug,
    `\nprocess.cwd(): ${process.cwd()}`,
    `\norigTemplate: ${origTemplate}`,
@@ -353,24 +353,24 @@ export function logInputFile(
    `\nbasePath: ${basePath}`,
    `\nisDirOrGlob: ${isDirOrGlob}`,
    `\nisGlob: ${isGlob}`,
-    `\n`
+    `\n`,
  )
 }

-export function logInitStep(options: ScaffoldConfig): void {
-  log(options, LogLevel.Debug, "Full config:", {
-    name: options.name,
-    templates: options.templates,
-    output: options.output,
-    createSubfolder: options.createSubFolder,
-    data: options.data,
-    overwrite: options.overwrite,
-    quiet: options.quiet,
-    subFolderTransformHelper: options.subFolderNameHelper,
-    helpers: Object.keys(options.helpers ?? {}),
-    verbose: `${options.verbose} (${Object.keys(LogLevel).find(
-      (k) => (LogLevel[k as any] as unknown as number) === options.verbose!
+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(options, LogLevel.Info, "Data:", options.data)
+  log(config, LogLevel.Info, "Data:", config.data)
 }
--- a/tests/scaffold.test.ts
+++ b/tests/scaffold.test.ts
@@ -6,6 +6,7 @@ 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: {
@@ -13,6 +14,13 @@ const fileStructNormal = {
  },
  output: {},
 }
+const fileStructWithBinary = {
+  input: {
+    "{{name}}.txt": "Hello, my app is {{name}}",
+    "{{name}}.bin": crypto.randomBytes(10000),
+  },
+  output: {},
+}

 const fileStructWithData = {
  input: {
@@ -45,7 +53,7 @@ const fileStructHelpers = {
  input: {
    defaults: defaultHelperNames.reduce<Record<string, string>>(
      (all, cur) => ({ ...all, [cur + ".txt"]: `{{ ${cur} name }}` }),
-      {}
+      {},
    ),
    custom: {
      "add1.txt": "{{ add1 name }}",
@@ -109,7 +117,25 @@ describe("Scaffold", () => {
        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(
@@ -157,7 +183,7 @@ describe("Scaffold", () => {
        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
        expect(data.toString()).toEqual("Hello, my value is 2")
      })
-    })
+    }),
  )

  describe(
@@ -180,7 +206,7 @@ describe("Scaffold", () => {
            templates: ["non-existing-input"],
            data: { value: "1" },
            verbose: 0,
-          })
+          }),
        ).rejects.toThrow()

        await expect(
@@ -190,12 +216,12 @@ describe("Scaffold", () => {
            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(
@@ -222,7 +248,7 @@ describe("Scaffold", () => {

        expect(() => readFileSync(join(process.cwd(), "output", "app_name.txt"))).toThrow()
      })
-    })
+    }),
  )

  describe(
@@ -239,7 +265,7 @@ describe("Scaffold", () => {
        const data = readFileSync(join(process.cwd(), "/custom-output/app_name/app_name.txt"))
        expect(data.toString()).toEqual("Hello, my app is app_name")
      })
-    })
+    }),
  )

  describe(
@@ -268,7 +294,7 @@ describe("Scaffold", () => {
        expect(oneDeepFile.toString()).toEqual("Hello, my value is 1")
        expect(twoDeepFile.toString()).toEqual("Hi! My value is actually NOT 1!")
      })
-    })
+    }),
  )

  describe(
@@ -302,7 +328,7 @@ describe("Scaffold", () => {
          expect(file.toString()).toEqual(results[key as keyof typeof results])
        }
      })
-    })
+    }),
  )
  describe(
    "date helpers",
@@ -329,19 +355,19 @@ describe("Scaffold", () => {
        // "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")}`
+          `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")}`
+          `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"
-          )}`
+            "HH:mm",
+          )}`,
        )
      })
-    })
+    }),
  )
  describe(
    "custom helpers",
@@ -366,7 +392,7 @@ describe("Scaffold", () => {
          expect(file.toString()).toEqual(results[key as keyof typeof results])
        }
      })
-    })
+    }),
  )
  describe(
    "transform subfolder",
@@ -414,7 +440,7 @@ describe("Scaffold", () => {
        const data = readFileSync(join(process.cwd(), "output", "REPLACED", "app_name.txt"))
        expect(data.toString()).toEqual("Hello, my app is app_name")
      })
-    })
+    }),
  )
  describe(
    "before write",
@@ -453,7 +479,7 @@ describe("Scaffold", () => {
            "Hello, my app is app_name".toUpperCase(),
            fileStructNormal.input["{{name}}.txt"],
            join(process.cwd(), "output", "app_name.txt"),
-          ].join(", ")
+          ].join(", "),
        )
      })
      test("should work with undefined response custom callback", async () => {
@@ -471,6 +497,6 @@ describe("Scaffold", () => {
        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
        expect(data.toString()).toEqual("Hello, my app is app_name")
      })
-    })
+    }),
  )
 })
--- a/tests/utils.test.ts
+++ b/tests/utils.test.ts
@@ -1,4 +1,4 @@
-import { dateHelper, handlebarsParse, nowHelper } from "../src/utils"
+import { dateHelper, getTemplateFileInfo, handlebarsParse, nowHelper, pathSepFix } from "../src/utils"
 import { ScaffoldConfig } from "../src/types"
 import path from "path"
 import * as dateFns from "date-fns"
@@ -12,33 +12,42 @@ const blankConf: ScaffoldConfig = {
 }

 describe("Utils", () => {
+  describe("getTemplateFileInfo", () => {
+    mockPathSep()
+
+    test("should fix paths properly for windows", async () => {
+      const result = await getTemplateFileInfo(
+        {
+          output: "/output",
+          templates: ["/example/template/**/*"],
+          name: "test",
+        },
+        {
+          basePath: "/example/base",
+          templatePath: "/example/template/file.ext",
+        },
+      )
+      const wd = pathSepFix(process.cwd())
+      expect(result).toHaveProperty("inputPath", "\\example\\template\\file.ext")
+      expect(result).toHaveProperty("outputPathOpt", "\\output")
+      expect(result).toHaveProperty("outputDir", "\\example\\base")
+      expect(result).toHaveProperty("outputPath", "\\example\\base\\file.ext")
+    })
+  })
+
  describe("handlebarsParse", () => {
-    let origSep: any
    describe("windows paths", () => {
-      beforeAll(() => {
-        origSep = path.sep
-        Object.defineProperty(path, "sep", { value: "\\" })
-      })
-      afterAll(() => {
-        Object.defineProperty(path, "sep", { value: origSep })
-      })
+      mockPathSep()
      test("should work for windows paths", async () => {
        expect(handlebarsParse(blankConf, "C:\\exports\\{{name}}.txt", { isPath: true })).toEqual(
-          Buffer.from("C:\\exports\\test.txt")
+          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")
+          Buffer.from("/home/test/test.txt"),
        )
      })
    })
@@ -49,8 +58,8 @@ describe("Utils", () => {
          "/home/test/{{name}} \\{{escaped}}.txt",
          {
            isPath: false,
-          }
-        )
+          },
+        ),
      ).toEqual(Buffer.from("/home/test/test {{escaped}}.txt"))
    })
  })
@@ -79,13 +88,29 @@ describe("Utils", () => {
          const fmt = "yyyy-MM-dd HH:mm"

          expect(dateHelper(now.toISOString(), fmt, -1, "days")).toEqual(
-            dateFns.format(dateFns.add(now, { days: -1 }), fmt)
+            dateFns.format(dateFns.add(now, { days: -1 }), fmt),
          )
          expect(dateHelper(now.toISOString(), fmt, 1, "months")).toEqual(
-            dateFns.format(dateFns.add(now, { months: 1 }), fmt)
+            dateFns.format(dateFns.add(now, { months: 1 }), fmt),
          )
        })
      })
    })
  })
 })
+
+function mockPathSep() {
+  let origSep: any
+  const sep = "\\"
+  beforeAll(() => {
+    origSep = path.sep
+    Object.defineProperty(path, "sep", { value: sep })
+    Object.defineProperty(path, "join", { value: (...args: string[]) => args.join(sep) })
+    Object.defineProperty(path, "basename", { value: (arg: string) => arg.split(sep).slice(-1) })
+  })
+  afterAll(() => {
+    Object.defineProperty(path, "sep", { value: origSep })
+    Object.defineProperty(path, "join", { value: (...args: string[]) => args.join(origSep) })
+    Object.defineProperty(path, "basename", { value: (arg: string) => arg.split(origSep).slice(-1) })
+  })
+}
--- a/typedoc.json
+++ b/typedoc.json
@@ -0,0 +1,27 @@
+{
+  "name": "Simple Scaffold",
+  "entryPoints": [
+    "src/index.ts"
+  ],
+  "includeVersion": true,
+  "categorizeByGroup": false,
+  "sort": [
+    "visibility"
+  ],
+  "categoryOrder": [
+    "Main",
+    "*"
+  ],
+  "media": "media",
+  "theme": "doc-theme",
+  "githubPages": true,
+  "entryPointStrategy": "expand",
+  "out": "docs",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "excludeInternal": true,
+  "gaID": "GTM-KHQS9TQ",
+  "validation": {
+    "invalidLink": true
+  }
+}
--- a/yarn.lock
+++ b/yarn.lock
@@ -833,6 +833,13 @@ brace-expansion@^1.1.7:
    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"
+
 braces@^3.0.1:
  version "3.0.2"
  resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107"
@@ -1114,6 +1121,9 @@ diff@^4.0.1:
  resolved "https://registry.yarnpkg.com/diff/-/diff-4.0.2.tgz#60f3aecb89d5fae520c11aa19efc2bb982aade7d"
  integrity sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==

+"doc-theme@file:./doc-theme":
+  version "1.0.0"
+
 domexception@^2.0.1:
  version "2.0.1"
  resolved "https://registry.yarnpkg.com/domexception/-/domexception-2.0.1.tgz#fb44aefba793e1574b0af6aed2801d057529f304"
@@ -1345,6 +1355,18 @@ glob@^7.1.1, glob@^7.1.2, glob@^7.1.3, glob@^7.1.4:
    once "^1.3.0"
    path-is-absolute "^1.0.0"

+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"
+
 globals@^11.1.0:
  version "11.12.0"
  resolved "https://registry.yarnpkg.com/globals/-/globals-11.12.0.tgz#ab8795338868a0babd8525758018c2a7eb95c42e"
@@ -2085,6 +2107,11 @@ json5@2.x, json5@^2.1.2:
  dependencies:
    minimist "^1.2.5"

+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==
+
 kleur@^3.0.3:
  version "3.0.3"
  resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e"
@@ -2122,6 +2149,11 @@ lru-cache@^6.0.0:
  dependencies:
    yallist "^4.0.0"

+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==
+
 make-dir@^3.0.0:
  version "3.1.0"
  resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-3.1.0.tgz#415e967046b3a7f1d185277d84aa58203726a13f"
@@ -2141,6 +2173,11 @@ makeerror@1.0.x:
  dependencies:
    tmpl "1.0.x"

+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==
+
 massarg@^1.0.5:
  version "1.0.5"
  resolved "https://registry.yarnpkg.com/massarg/-/massarg-1.0.5.tgz#3dfd49bb63bfca4b0371a2f0ffc7580a9a6cc7a0"
@@ -2186,6 +2223,13 @@ minimatch@^3.0.4:
  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"
+
 minimist@^1.2.5:
  version "1.2.6"
  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44"
@@ -2492,6 +2536,15 @@ shebang-regex@^3.0.0:
  resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172"
  integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==

+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"
+
 signal-exit@^3.0.2, signal-exit@^3.0.3:
  version "3.0.3"
  resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.3.tgz#a1410c2edd8f077b08b4e253c8eacfcaf057461c"
@@ -2649,9 +2702,9 @@ throat@^6.0.1:
  integrity sha512-8hmiGIJMDlwjg7dlJ4yKGLK8EsYqKgPWbG3b4wjJddKNwc7N7Dpn08Df4szr/sZdMVeOstrdYSsqzX6BYbcB+w==

 tmpl@1.0.x:
-  version "1.0.4"
-  resolved "https://registry.yarnpkg.com/tmpl/-/tmpl-1.0.4.tgz#23640dd7b42d00433911140820e5cf440e521dd1"
-  integrity sha1-I2QN17QtAEM5ERQIIOXPRA5SHdE=
+  version "1.0.5"
+  resolved "https://registry.yarnpkg.com/tmpl/-/tmpl-1.0.5.tgz#8683e0b902bb9c20c4f726e3c0b69f36518c07cc"
+  integrity sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==

 to-fast-properties@^2.0.0:
  version "2.0.0"
@@ -2737,6 +2790,17 @@ typedarray-to-buffer@^3.1.5:
  dependencies:
    is-typedarray "^1.0.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.3.5:
  version "4.3.5"
  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.3.5.tgz#4d1c37cc16e893973c45a06886b7113234f119f4"
@@ -2782,6 +2846,16 @@ v8-to-istanbul@^8.0.0:
    convert-source-map "^1.6.0"
    source-map "^0.7.3"

+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==
+
 w3c-hr-time@^1.0.2:
  version "1.0.2"
  resolved "https://registry.yarnpkg.com/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz#0a89cdf5cc15822df9c360543676963e0cc308cd"
Author	SHA1	Message	Date
Chen Asraf	143519974f	bump version number [publish]	2022-05-23 21:22:17 +03:00
Chen Asraf	faa5788c38	replace node version	2022-05-23 21:17:24 +03:00
Chen Asraf	7c8f4095ad	windows separator fixes on config [publish]	2022-05-23 20:59:49 +03:00
Chen Asraf	adba6490e8	Update README.md	2022-05-18 01:04:10 +03:00
Chen Asraf	1d0c20cba9	docs: fix typo	2022-05-15 14:32:22 +03:00
Chen Asraf	cd68ab41d4	Update README.md	2022-05-15 14:02:42 +03:00
Chen Asraf	1b37a8eb40	update intro gif	2022-05-06 01:25:34 +03:00
Chen Asraf	576798cfeb	update intro gif	2022-05-06 01:24:30 +03:00
Chen Asraf	ac8af8e129	revert docs build in ci	2022-05-03 19:52:23 +03:00
Chen Asraf	96b93d8b60	try fix docs build process	2022-05-03 19:51:12 +03:00
Chen Asraf	11edb0d464	remove unnecessary install	2022-05-03 19:46:00 +03:00
Chen Asraf	35262b5a44	fix docs build process	2022-05-03 19:45:34 +03:00
Chen Asraf	3b77e6938c	improve docs build process	2022-05-03 19:41:16 +03:00
Chen Asraf	3cf93598c3	improve docs build process	2022-05-03 19:38:12 +03:00
Chen Asraf	8957b595da	improve docs build process	2022-05-03 19:35:36 +03:00
Chen Asraf	2841ebd3d2	update docs + formatting update	2022-05-03 19:24:18 +03:00
Chen Asraf	0364247904	fix build	2022-05-01 14:26:14 +03:00
Chen Asraf	ac2c0d7ffb	fix build	2022-05-01 14:24:44 +03:00
Chen Asraf	a002402088	update docs	2022-05-01 14:23:03 +03:00
Chen Asraf	bdc23e7074	Update README.md	2022-05-01 13:56:20 +03:00
Chen Asraf	6160a04009	Update README.md	2022-05-01 13:53:57 +03:00
Chen Asraf	7414baf2ab	Merge pull request #42 from chenasraf/master v1.1.2 back merge	2022-04-29 10:19:26 +03:00
Chen Asraf	c45d870233	v1.1.2 Fix binary file copy	2022-04-29 10:14:48 +03:00
Chen Asraf	8c8cedee48	update help command	2022-04-29 10:10:53 +03:00
Chen Asraf	40606edaee	update test desc	2022-04-29 09:56:59 +03:00
Chen Asraf	e450ad242e	fix: binary files + add tests	2022-04-29 09:54:06 +03:00
Chen Asraf	df60922154	Merge pull request #39 from chenasraf/master Merge pull request #38 from chenasraf/develop	2022-04-24 17:41:55 +03:00
Chen Asraf	256d919253	Merge pull request #38 from chenasraf/develop v1.1.1 - security fix	2022-04-24 17:30:10 +03:00
Chen Asraf	f8c31a1ecf	Merge branch 'master' into develop	2022-04-24 17:28:39 +03:00
Chen Asraf	5571aba8dc	npm audit fix	2022-04-24 17:27:03 +03:00
Chen Asraf	12f8bca7b5	fix doc deps	2022-04-23 11:29:09 +03:00
Chen Asraf	643431d333	fix gtag	2022-04-23 11:24:02 +03:00
Chen Asraf	0042c12ee7	fix docs build	2022-04-23 11:19:41 +03:00
Chen Asraf	869911bba0	update docs GA	2022-04-23 11:18:23 +03:00
Chen Asraf	9bd6219aa5	add gaid to docs	2022-04-23 09:45:48 +03:00
Chen Asraf	27a6ba4dda	update docs	2022-04-22 23:00:11 +03:00
Chen Asraf	923b5316be	update docs	2022-04-21 15:37:44 +03:00
Chen Asraf	bf10fb8ec3	update docs	2022-04-21 15:34:03 +03:00
Chen Asraf	4e2fa01bed	update docs [skip publish]	2022-04-21 14:45:58 +03:00
Chen Asraf	af65ecadb9	try to fix docs [skip publish]	2022-04-21 13:07:19 +03:00
Chen Asraf	0d359b1917	fix workflow [skip publish]	2022-04-21 12:37:01 +03:00
Chen Asraf	f2a75c9fb0	Typdoc (#37 ) [skip publish] * update package.json * generate typedocs * update docs	2022-04-21 12:35:32 +03:00