fix copyright

v1.0

.editorconfig

@@ -3,6 +3,3 @@ tab_width = 2
 indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
-
-[*.md]
-trim_trailing_whitespace = false

.github/FUNDING.yml

@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: chenasraf
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: casraf
@@ -9,5 +9,4 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl
 liberapay: # Replace with a single Liberapay username
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
-custom:
-  - "https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=TSH3C3ABGQM22&currency_code=ILS&source=url"
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,47 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: "[BUG] "
-labels: bug, needs-triage
-assignees: chenasraf
----
-
-#### Describe the bug
-
-A clear and concise description of what the bug is.
-
-#### How To Reproduce
-
-Steps to reproduce the behavior:
-
-1. Prepare templates:
-
-   ```text
-   This is my {{ template }}
-   ```
-
-2. Run with args/config:
-
-   ```shell
-   npx simple-scaffold@latest -t input -o output TplName
-   ```
-
-#### Expected behavior\*\*
-
-A clear and concise description of what you expected to happen.
-
-#### Logs
-
-If applicable, paste your logs to help explain your problem. To see more logs, run the scaffold with
-`-v 1` to enable debug logging.
-
-#### Desktop (please complete the following information):
-
-- OS: [e.g. macOS, Windows, Linux]
-- OS Version: [e.g. Big Sur, 11, Ubuntu 20.04]
-- Node.js: [e.g. 16.8]
-- Simple Scaffold Version [e.g. 1.1.2]
-
-#### Additional context
-
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

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

.github/workflows/alpha.yml

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

.github/workflows/docs.yml

@@ -1,21 +0,0 @@
-name: Documentation
-
-on:
-  push:
-    branches: [master]
-jobs:
-  docs:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip docs]')"
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2
-        with:
-          run_install: |
-            - recursive: true
-              args: [--frozen-lockfile, --strict-peer-dependencies]
-      - run: pnpm build-docs
-      - uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs

.github/workflows/main.yml

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

.github/workflows/pull_requests.yml

@@ -2,17 +2,16 @@ name: Pull Requests
 
 on:
   pull_request:
-    branches: [master, develop]
+    branches: [master, alpha, beta]
 jobs:
   build:
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
         with:
-          run_install: |
-            - recursive: true
-              args: [--frozen-lockfile, --strict-peer-dependencies]
-      - run: pnpm build
-      - run: pnpm test
+          node-version: "12.x"
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      - run: yarn test

.github/workflows/release.yml

@@ -1,36 +0,0 @@
-name: Test & Build
-
-on:
-  push:
-    branches: [master, develop, feat/*, fix/*]
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2
-        with:
-          run_install: |
-            - recursive: true
-              args: [--frozen-lockfile, --strict-peer-dependencies]
-      - run: pnpm test
-        if: "!contains(github.event.head_commit.message, '[skip test]')"
-  build:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
-    needs: test
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2
-        with:
-          run_install: |
-            - recursive: true
-              args: [--frozen-lockfile, --strict-peer-dependencies]
-      - run: pnpm build
-      - run: cd ./dist && pnpm pack --pack-destination=../
-      - run: pnpm semantic-release
-        if: "!contains(github.event.head_commit.message, '[skip publish]')"
-        env:
-          NPM_TOKEN: "${{ secrets.NPM_TOKEN }}"
-          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.gitignore

@@ -42,9 +42,6 @@ typings/
 # Optional npm cache directory
 .npm
 
-# NPM
-.npmrc
-
 # Optional eslint cache
 .eslintcache
 
@@ -64,5 +61,3 @@ examples/test-output/**/*
 dist/
 .DS_Store
 tmp/
-docs/
-.nvmrc

.markdownlint.json

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

.prettierrc

@@ -1,15 +1,5 @@
 {
   "semi": false,
-  "trailingComma": "all",
   "printWidth": 120,
-  "tabWidth": 2,
-  "overrides": [
-    {
-      "files": "*.md",
-      "options": {
-        "printWidth": 100,
-        "proseWrap": "always"
-      }
-    }
-  ]
+  "tabWidth": 2
 }

.vscode/launch.json

@@ -1,27 +1,29 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Debug Scaffold",
-      "type": "node",
-      "request": "launch",
-      "protocol": "inspector",
-      "cwd": "${workspaceFolder}",
-      "program": "${workspaceFolder}/test.ts",
-      "outFiles": ["${workspaceRoot}/dist/test.js"],
-      "env": {
-        "NODE_ENV": "develop"
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+      {
+          "name": "Debug Scaffold",
+          "type": "node",
+          "request": "launch",
+          "protocol": "inspector",
+          "cwd": "${workspaceFolder}",
+          "program": "${workspaceFolder}/test.ts",
+          "outFiles": [
+            "${workspaceRoot}/dist/test.js"
+          ],
+          "env": {
+            "NODE_ENV": "develop"
+          },
+          "sourceMaps": true,
       },
-      "sourceMaps": true
-    },
-    {
-      "type": "node",
-      "request": "attach",
-      "name": "Attach by Process ID",
-      "processId": "${command:PickProcess}"
-    }
-  ]
+      {
+        "type": "node",
+        "request": "attach",
+        "name": "Attach by Process ID",
+        "processId": "${command:PickProcess}"
+      }
+    ]
 }

.vscode/settings.json

@@ -3,20 +3,10 @@
   "npm.packageManager": "yarn",
   "cSpell.words": [
     "massarg",
-    "MYCOMPONENT",
-    "myname",
-    "nobrace",
-    "nocomment",
     "nodir",
+    "nobrace",
     "noext",
-    "nonegate",
-    "subdir",
-    "variabletoken"
-  ],
-  "[markdown]": {
-    "editor.rulers": [
-      87,
-      100
-    ],
-  },
+    "nocomment",
+    "nonegate"
+  ]
 }

.vscode/tasks.json

@@ -5,55 +5,49 @@
       "script": "build",
       "label": "build",
       "type": "npm",
-      "problemMatcher": []
+      "problemMatcher": [],
     },
     {
       "script": "dev",
       "label": "dev",
       "type": "npm",
-      "problemMatcher": []
-    },
-    {
-      "command": "yarn typedoc --watch",
-      "label": "typedoc --watch",
-      "type": "shell",
-      "problemMatcher": []
+      "problemMatcher": [],
     },
     {
       "script": "start",
       "label": "start",
       "type": "npm",
-      "problemMatcher": []
+      "problemMatcher": [],
     },
     {
       "script": "test",
       "label": "test",
       "type": "npm",
-      "problemMatcher": []
+      "problemMatcher": [],
     },
     {
       "command": "yarn test --watchAll",
       "label": "yarn test --watchAll",
       "type": "shell",
-      "problemMatcher": []
+      "problemMatcher": [],
     },
     {
       "script": "cmd",
       "label": "cmd",
       "type": "npm",
-      "problemMatcher": []
+      "problemMatcher": [],
     },
     {
       "script": "build-test",
       "label": "build-test",
       "type": "npm",
-      "problemMatcher": []
+      "problemMatcher": [],
     },
     {
       "script": "build-cmd",
       "label": "build-cmd",
       "type": "npm",
-      "problemMatcher": []
-    }
-  ]
+      "problemMatcher": [],
+    },
+  ],
 }

CHANGELOG.md

@@ -1,198 +0,0 @@
-# Change Log
-
-## [1.7.1-develop.1](https://github.com/chenasraf/simple-scaffold/compare/v1.7.0...v1.7.1-develop.1) (2023-06-07)
-
-
-### Bug Fixes
-
-* local config file load error ([2b74239](https://github.com/chenasraf/simple-scaffold/commit/2b7423993be06b2375631642455c801ae2acf75f))
-
-## [1.7.0-develop.7](https://github.com/chenasraf/simple-scaffold/compare/v1.7.0-develop.6...v1.7.0-develop.7) (2023-06-07)
-
-
-### Bug Fixes
-
-* local config file load error ([2b74239](https://github.com/chenasraf/simple-scaffold/commit/2b7423993be06b2375631642455c801ae2acf75f))
-
-## [1.7.0-develop.6](https://github.com/chenasraf/simple-scaffold/compare/v1.7.0-develop.5...v1.7.0-develop.6) (2023-05-27)
-
-## [1.7.0-develop.5](https://github.com/chenasraf/simple-scaffold/compare/v1.7.0-develop.4...v1.7.0-develop.5) (2023-05-12)
-
-## [1.7.0-develop.4](https://github.com/chenasraf/simple-scaffold/compare/v1.7.0-develop.3...v1.7.0-develop.4) (2023-05-11)
-
-## [1.7.0-develop.3](https://github.com/chenasraf/simple-scaffold/compare/v1.7.0-develop.2...v1.7.0-develop.3) (2023-05-11)
-
-## [1.7.0-develop.2](https://github.com/chenasraf/simple-scaffold/compare/v1.7.0-develop.1...v1.7.0-develop.2) (2023-05-10)
-
-## [1.7.0-develop.1](https://github.com/chenasraf/simple-scaffold/compare/v1.6.0...v1.7.0-develop.1) (2023-05-09)
-
-
-### Features
-
-* function config file ([02a8ba1](https://github.com/chenasraf/simple-scaffold/commit/02a8ba16cd6ee31806532845cb5ddbe0f5abf7de))
-
-
-### Bug Fixes
-
-* use path.normalize ([565090a](https://github.com/chenasraf/simple-scaffold/commit/565090a951e13dd222f2f802df717e7cb6ca0a73))
-
-## [1.6.0](https://github.com/chenasraf/simple-scaffold/compare/v1.5.0...v1.6.0) (2023-05-05)
-
-
-### Features
-
-* node.js function for remote configs ([ce5adbe](https://github.com/chenasraf/simple-scaffold/commit/ce5adbe0f898a86db6046d7f66d83dfcaa519ad2))
-
-
-### Bug Fixes
-
-* move dependency to dev dependency ([d916d88](https://github.com/chenasraf/simple-scaffold/commit/d916d88384054e6c6b40e6299073f1d1acb4d29d))
-
-## Change Log
-
-# [1.5.0](https://github.com/chenasraf/simple-scaffold/compare/v1.6.0-develop.1...v1.5.0) (2023-05-04)
-
-## [1.6.0-develop.1](https://github.com/chenasraf/simple-scaffold/compare/v1.5.0...v1.6.0-develop.1) (2023-05-04)
-
-### Features
-
-- node.js function for remote configs
-  ([ce5adbe](https://github.com/chenasraf/simple-scaffold/commit/ce5adbe0f898a86db6046d7f66d83dfcaa519ad2))
-
-### Bug Fixes
-
-- move dependency to dev dependency
-  ([d916d88](https://github.com/chenasraf/simple-scaffold/commit/d916d88384054e6c6b40e6299073f1d1acb4d29d))
-
-## [1.5.0](https://github.com/chenasraf/simple-scaffold/compare/v1.5.0-develop.1...v1.5.0) (2023-05-02)
-
-## [1.5.0-develop.1](https://github.com/chenasraf/simple-scaffold/compare/v1.4.0...v1.5.0-develop.1) (2023-05-02)
-
-### Features
-
-- add github remote templates
-  ([f961c13](https://github.com/chenasraf/simple-scaffold/commit/f961c13da15320b42540773ed958cdc3f97e4502))
-- support for remote template configs
-  ([05487f4](https://github.com/chenasraf/simple-scaffold/commit/05487f4d1e3b05f1d695242bb54427ee2fbdf247))
-
-## [1.4.0](https://github.com/chenasraf/simple-scaffold/compare/v1.3.2...v1.4.0) (2023-04-28)
-
-### Features
-
-- add `--key` | `-k` to config loader
-  ([6c5ba0b](https://github.com/chenasraf/simple-scaffold/commit/6c5ba0bc916fb1d59240d2eaa1abedc74527a974))
-
-## [1.3.2](https://github.com/chenasraf/simple-scaffold/compare/v1.3.1...v1.3.2) (2023-04-28)
-
-### Bug Fixes
-
-- release build
-  ([2c23fa9](https://github.com/chenasraf/simple-scaffold/commit/2c23fa9dbb310cd0a31f09606798f96b95d66779))
-- release build asset
-  ([0bef2df](https://github.com/chenasraf/simple-scaffold/commit/0bef2df5f3aa800ad5f1094c0996108db9acce51))
-
-## [1.3.1](https://github.com/chenasraf/simple-scaffold/compare/v1.3.0...v1.3.1) (2023-04-28)
-
-### Bug Fixes
-
-- docs
-  ([6e19a86](https://github.com/chenasraf/simple-scaffold/commit/6e19a86190dd924058a48448aa6463569ef1125f))
-- remove old peer-dep
-  ([c7e2ef8](https://github.com/chenasraf/simple-scaffold/commit/c7e2ef862cb658feb1071ac120b185d8b34d6dd3))
-
-## [1.3.0](https://github.com/chenasraf/simple-scaffold/compare/v1.2.0...v1.3.0) (2023-04-25)
-
-### Features
-
-- load scaffold config from files
-  ([c398976](https://github.com/chenasraf/simple-scaffold/commit/c3989769fee445c9183ff5e5b3892c4e9fb66a9e))
-
-### Bug Fixes
-
-- config option should not be mandatory
-  ([3db6a91](https://github.com/chenasraf/simple-scaffold/commit/3db6a918f13d9300efa2fcb4a356d004475ab91c))
-- export config file type
-  ([4302eb5](https://github.com/chenasraf/simple-scaffold/commit/4302eb5ce35ed6cf1dc80dfb92790c3fdd96f963))
-
-## [1.2.0](https://github.com/chenasraf/simple-scaffold/compare/v1.1.4...v1.2.0) (2023-04-24)
-
-### Features
-
-- append-data cli flag
-  ([3c5c2de](https://github.com/chenasraf/simple-scaffold/commit/3c5c2ded02f61ff086e81ea4a7f40529bdff1c9d))
-
-### Bug Fixes
-
-- ci node version
-  ([767d34c](https://github.com/chenasraf/simple-scaffold/commit/767d34c684516d4cea865b25e87c27c779bb79ce))
-- github action node version
-  ([7c19c53](https://github.com/chenasraf/simple-scaffold/commit/7c19c533376dc6904231e5cc51c7a4b2658c66e0))
-- github action node version
-  ([94fec76](https://github.com/chenasraf/simple-scaffold/commit/94fec766165f7540c578dbf2d0aeeb6ea3969ad8))
-- semantic-release build dir
-  ([f7956dd](https://github.com/chenasraf/simple-scaffold/commit/f7956ddc786018905c48ccf1f21a3bb4657c3d75))
-- support quote wrapping in append-data
-  ([4fecca8](https://github.com/chenasraf/simple-scaffold/commit/4fecca848347312d45d704f82f2bcb3822da9b06))
-
-## [1.1.3](https://github.com/chenasraf/simple-scaffold/compare/v1.1.2...v1.1.3) (2023-03-11)
-
-### Bug Fixes
-
-- base path
-  ([943717a](https://github.com/chenasraf/simple-scaffold/commit/943717a76998ec0609f2072c886df6b4775f2ea2))
-- binary files + add tests
-  ([e450ad2](https://github.com/chenasraf/simple-scaffold/commit/e450ad242ed70ae928b19964da38cdcb1b6cf659))
-
-## [1.1.0](https://github.com/chenasraf/simple-scaffold/compare/v1.0.4...v1.1.0) (2022-04-21)
-
-## [1.0.3](https://github.com/chenasraf/simple-scaffold/compare/v1.0.2...v1.0.3) (2022-03-03)
-
-## [1.0.1-pre.1](https://github.com/chenasraf/simple-scaffold/compare/v1.0.0...v1.0.1-pre.1) (2022-02-17)
-
-## [0.7.5](https://github.com/chenasraf/simple-scaffold/compare/v0.7.4...v0.7.5) (2021-09-26)
-
-## [0.7.4](https://github.com/chenasraf/simple-scaffold/compare/v0.7.3...v0.7.4) (2021-09-26)
-
-## [0.7.3](https://github.com/chenasraf/simple-scaffold/compare/v0.7.2...v0.7.3) (2021-09-26)
-
-## [0.7.2](https://github.com/chenasraf/simple-scaffold/compare/v0.6.1...v0.7.2) (2021-04-19)
-
-## [0.6.1](https://github.com/chenasraf/simple-scaffold/compare/v0.6.0...v0.6.1) (2021-02-01)
-
-### Bug Fixes
-
-- binary files
-  ([7c0c347](https://github.com/chenasraf/simple-scaffold/commit/7c0c3470020d7c166ea68a8effa6df65ec38f2c8))
-
-## [0.6.0](https://github.com/chenasraf/simple-scaffold/compare/v0.5.0...v0.6.0) (2021-02-01)
-
-### Bug Fixes
-
-- support deeper file structure
-  ([4afafa5](https://github.com/chenasraf/simple-scaffold/commit/4afafa5a4af2e3f4b0af54f20811ecb2c8d98560))
-
-## [0.5.0](https://github.com/chenasraf/simple-scaffold/compare/v0.4.5...v0.5.0) (2019-02-27)
-
-## [0.4.5](https://github.com/chenasraf/simple-scaffold/compare/v0.4.4...v0.4.5) (2019-02-27)
-
-## [0.4.4](https://github.com/chenasraf/simple-scaffold/compare/v0.4.3...v0.4.4) (2019-02-27)
-
-## [0.4.3](https://github.com/chenasraf/simple-scaffold/compare/v0.4.2...v0.4.3) (2019-02-27)
-
-## [0.4.2](https://github.com/chenasraf/simple-scaffold/compare/v0.4.1...v0.4.2) (2019-02-25)
-
-## [0.4.1](https://github.com/chenasraf/simple-scaffold/compare/v0.3.1...v0.4.1) (2019-02-25)
-
-## [0.3.1](https://github.com/chenasraf/simple-scaffold/compare/v0.3.0...v0.3.1) (2018-01-15)
-
-## [0.3.0](https://github.com/chenasraf/simple-scaffold/compare/v0.2.0...v0.3.0) (2018-01-15)
-
-## [0.2.0](https://github.com/chenasraf/simple-scaffold/compare/v0.1.5...v0.2.0) (2018-01-05)
-
-## [0.1.5](https://github.com/chenasraf/simple-scaffold/compare/v0.1.4...v0.1.5) (2018-01-01)
-
-## [0.1.4](https://github.com/chenasraf/simple-scaffold/compare/v0.1.3...v0.1.4) (2018-01-01)
-
-## [0.1.3](https://github.com/chenasraf/simple-scaffold/compare/v0.1.2...v0.1.3) (2018-01-01)
-
-## 0.1.2 (2018-01-01)

MIGRATION.md

@@ -1,20 +1,15 @@
+# Migrating from 0.x to 1.0
+
 In Simple Scaffold v1.0, the entire codebase was overhauled, yet usage remains mostly the same
 between versions. With these notable exceptions:
 
 - Some of the argument names have changed
 - Template syntax has been improved
-- The command to run Scaffold has been simplified from `new SimpleScaffold(opts).run()` to
-  `SimpleScaffold(opts)`, which now returns a promise that you can await to know when the process
-  has been completed.
 
 ## Argument changes
 
-- `locals` has been renamed to `data`. The appropriate command line args have been updated as well
-  to `--data` | `-d`.
-- Additional options have been added to both CLI and Node interfaces. See
-  [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
-  and [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html) for more
-  information.
+- `locals` has been renamed to `data`. The appropriate command line args have been updated as
+  well to `--data` | `-d`.
 
 ## Template syntax changes
 

README.md

@@ -1,171 +1,262 @@
-<h1 align="center">Simple Scaffold</h1>
+# simple-scaffold
 
-<h2 align="center">
+Simple Scaffold allows you to create your structured files based on templates.
 
-[GitHub](https://github.com/chenasraf/simple-scaffold) |
-[Documentation](https://chenasraf.github.io/simple-scaffold) |
-[NPM](https://npmjs.com/package/simple-scaffold) | [casraf.dev](https://casraf.dev)
+Simply organize your commonly-created files in their original structure, and replace any variable
+values (such as component or app name) inside the paths or contents of the files with tokens to be
+populated upon scaffolding.
 
-![version](https://img.shields.io/github/package-json/v/chenasraf/simple-scaffold/master?label=version)
-![build](https://img.shields.io/github/actions/workflow/status/chenasraf/simple-scaffold/release.yml?branch=master)
+Then, run Simple Scaffold and it will generate your files for you in the desired structure,
+with file names and contents that contain your dynamic information.
 
-</h2>
+It's a simple way to easily create reusable components, common class files to start writing from,
+or even entire app structures.
 
-Looking to streamline your workflow and get your projects up and running quickly? Look no further
-than Simple Scaffold - the easy-to-use NPM package that simplifies the process of organizing and
-copying your commonly-created files.
+## Install
 
-With its agnostic and un-opinionated approach, Simple Scaffold can handle anything from a few simple
-files to an entire app boilerplate setup. Plus, with the power of **Handlebars.js** syntax, you can
-easily replace custom data and personalize your files to fit your exact needs. But that's not all -
-you can also use it to loop through data, use conditions, and write custom functions using helpers.
+You can either use it as a command line tool or import into your own code and run from there.
 
-Don't waste any more time manually copying and pasting files - let Simple Scaffold do the heavy
-lifting for you and start building your projects faster and more efficiently today!
+```bash
+# npm
+npm install [-g] simple-scaffold
+# yarn
+yarn [global] add simple-scaffold
+# run without installing
+npx simple-scaffold <...args>
+```
 
-<div align="center">
+## Use as a command line tool
 
-![sample animation](media/intro.gif)
+### Command Line Options
 
-</div>
+```plaintext
+Usage: simple-scaffold [options]
 
----
+Create structured files based on templates.
 
-## Quick Start
+Options:
 
-### Local Templates
+  --help|-h                 Display help information
 
-The fastest way to get started is to use `npx` to immediately start a scaffold process.
+  --name|-n                 Name to be passed to the generated files. {{name}} and
+                            {{Name}} inside contents and file names will be replaced
+                            accordingly.
 
-Prepare any templates you want to use - for example, in the directory `templates/component`; and use
-that in the CLI args. Here is a simple example file:
+  --output|-o               Path to output to. If --create-sub-folder is enabled, the
+                            subfolder will be created inside this path.
 
-Simple Scaffold will maintain any file and directory structure you try to generate.
+  --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. (default:
+                            )
 
-`templates/component/{{ pascalName name }}.tsx`
+  --overwrite|-w            Enable to override output files, even if they already exist.
+                            (default: false)
 
-```tsx
-// Created: {{ now 'yyyy-MM-dd' }}
-import React from 'react'
+  --data|-d                 Add custom data to the templates. By default, only your app
+                            name is included.
 
-export default {{pascalCase name}}: React.FC = (props) => {
-  return (
-    <div className="{{camelCase name}}">{{pascalCase name}} Component</div>
-  )
+  --create-sub-folder|-s    Create subfolder with the input name (default:
+                            false)
+
+  --quiet|-q                Suppress output logs (Same as --verbose 0)
+                            (default: false)
+
+  --verbose|-v              Determine amount of logs to display. The values are: 0
+                            (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error). The
+                            provided level will display messages of the same level or higher.
+                            (default: 2)
+
+  --dry-run|-dr             Don't emit files. This is good for testing your scaffolds and
+                            making sure they don't fail, without having to write actual file
+                            contents or create directories. (default:
+                            false)
+```
+
+You can also add this as a script in your `package.json`:
+
+```json
+{
+  ...
+  "scripts": {
+    ...
+    "scaffold": "yarn simple-scaffold --templates scaffolds/component/**/* --output src/components --data '{\"myProp\": \"propName\", \"myVal\": \"123\"}'"
+  }
 }
 ```
 
-To generate the template output, run:
+## Use in Node.js
 
-```shell
-# generate single component
-$ npx simple-scaffold@latest \
-  -t templates/component -o src/components PageWrapper
+You can also build the scaffold yourself, if you want to create more complex arguments or scaffold groups.
+Simply pass a config object to the constructor, and invoke `run()` when you are ready to start.
+The config takes similar arguments to the command line:
+
+```typescript
+import Scaffold from "simple-scaffold"
+
+const scaffold = SimpleScaffold({
+  name: "component",
+  templates: [path.join(__dirname, "scaffolds", "component")],
+  output: path.join(__dirname, "src", "components"),
+  createSubFolder: true,
+  locals: {
+    property: "value",
+  },
+  helpers: {
+    twice: (text) => [text, text].join(" ")
+  }
+})
 ```
 
-This will immediately create the following file: `src/components/PageWrapper.tsx`
+### Additional Node.js options
 
-```tsx
-// Created: 2077-01-01
-import React from 'react'
+In addition to all the options available in the command line, there are some JS-specific options
+available:
 
-export default PageWrapper: React.FC = (props) => {
-  return (
-    <div className="pageWrapper">PageWrapper Component</div>
-  )
+1. When `output` is used in Node directly, it may also be passed a function for each input file to
+   output into a dynamic path:
+
+    ```typescript
+    config.output = (fullPath, baseDir, baseName) => {
+      console.log({ fullPath, baseDir, baseName })
+      return path.resolve(baseDir, baseName)
+    }
+    ```
+
+2. You may add custom `helpers` to your scaffolds. Helpers are simple `(string) => string` functions
+   that transform your `data` variables into other values. See [Helpers](#helpers) for the list of
+   default helpers, or add your own to be loaded into the template parser.
+
+## Preparing files
+
+### Template files
+
+Put your template files anywhere, and fill them with tokens for replacement.
+
+### Variable/token replacement
+
+Scaffolding will replace `{{ varName }}` in both the file name and its contents and put the
+transformed files in the output directory.
+
+The data available for the template parser is the data you pass to the `data` config option (or
+`--data` argument in CLI).
+
+Your `data` will be pre-populated with the following:
+
+- `{{Name}}`: PascalCase of the component name
+- `{{name}}`: raw name of the component
+
+> Simple-Scaffold uses [Handlebars.js](https://handlebarsjs.com/) for outputting the file contents,
+> see their documentation for more information on syntax.
+> Any `data` you add in the config will be available for use with their names wrapped in
+> `{{` and `}}`.
+
+#### 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.
+
+Here are the built-in helpers available for use:
+
+| 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         |
+
+> These helpers are available for any data property, not exclusive to `name`.
+
+You may also add your own custom helpers using the `helpers` options when using the JS API (rather
+than the CLI). The `helpers` option takes an object whose keys are helper names, and values are
+the transformation functions. For example, `upperCase` is implemented like so:
+
+```typescript
+config.helpers = {
+  upperCase: (text) => text.toUpperCase(),
 }
 ```
 
-### Configuration Files
+## Examples
 
-You can also use a config file to more easily maintain all your scaffold definitions.
+### Command Example
 
-`scaffold.config.js`
+```bash
+simple-scaffold MyComponent \
+    -t project/scaffold/**/* \
+    -o src/components \
+    -d '{"className": "myClassName"}'
+    MyComponent
+```
+
+### Example Scaffold Input
+
+#### Input Directory structure
+
+```plaintext
+- project
+  - scaffold
+    - {{Name}}.js
+  - src
+    - components
+    - ...
+```
+
+#### Contents of `project/scaffold/{{Name}}.jsx`
 
 ```js
-module.exports = {
-  // use "default" to avoid needing to specify key
-  // in this case the key is "component"
-  component: {
-    templates: ["templates/component"],
-    output: "src/components",
-    data: {
-      // ...
-    },
-  },
+const React = require('react')
+
+module.exports = function {{Name}}(props) {
+  return (
+    <div className="{{className}}">{{Name}} Component</div>
+  )
 }
 ```
 
-Then call your scaffold like this:
+### Example Scaffold Output
 
-```shell
-$ npx simple-scaffold@latest -c scaffold.config.js PageWrapper
+### Output directory structure
+
+```plaintext
+- project
+  - src
+    - components
+      - MyComponent
+        - MyComponent.js
+    - ...
 ```
 
-This will allow you to avoid needing to remember which configs are needed or to store them in a
-1-liner in `packqge.json` which can get pretty long and messy, which is harder to maintain.
+With `createSubFolder = false`:
 
-Also, this allows you to define more complex scaffolds with logic without having to use the Node.js
-API directly. (Of course you always have the option to still do so if you wish)
-
-See more at the [CLI documentation](https://chenasraf.github.io/simple-scaffold/pages/cli.html) and
-[Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/configuration_files.html).
-
-### Remote Configurations
-
-Another quick way to start is to re-use someone else's (or your own) work using a template
-repository.
-
-A remote config can be loaded in one of these ways:
-
-- If it's on GitHub, you can use `-gh user/repository_name`
-- If it's on another git server (such as GitLab), you can use
-  `-c https://example.com/user/repository_name.git`
-
-Configurations can hold multiple scaffold groups. Each group can be accessed using its key by
-supplying the `--key` or `-k` argument, or by appending a hash and then the key name, like so:
-`-gh user/repository_name#key_name` - this also works for the `-c` flag.
-
-Here is an example for loading the example component templates in this very repository:
-
-```shell
-$ npx simple-scaffold@latest \
-  -gh chenasraf/simple-scaffold#scaffold.config.js:component \
-  PageWrapper
-
-# equivalent to:
-$ npx simple-scaffold@latest \
-  -c https://github.com/chenasraf/simple-scaffold.git#scaffold.config.js:component \
-  PageWrapper
+```plaintext
+- project
+  - src
+    - components
+      - MyComponent.js
+    - ...
 ```
 
-When template name (`:component`) is omitted, `default` is used.
+#### Contents of `project/scaffold/MyComponent/MyComponent.jsx`
 
-See more at the [CLI documentation](https://chenasraf.github.io/simple-scaffold/pages/cli.html) and
-[Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/configuration_files.html).
+```js
+const React = require("react")
 
-## Documentation
-
-See full documentation [here](https://chenasraf.github.io/simple-scaffold).
-
-- [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
-- [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html)
-- [Templates](https://chenasraf.github.io/simple-scaffold/pages/templates.html)
-- [Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/configuration_files.html)
-- [Migrating v0.x to v1.x](https://chenasraf.github.io/simple-scaffold/pages/migration.html)
+module.exports = function MyComponent(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 are feeling incredibly generous and would like to donate
-just a small amount to help sustain this project, I would be very very thankful!
-
-<a href='https://ko-fi.com/casraf' target='_blank'>
-  <img height='36' style='border:0px;height:36px;'
-    src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3'
-    alt='Buy Me a Coffee at ko-fi.com' />
-</a>
-
 I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature,
 don't hesitate to open an appropriate issue and I will do my best to reply promptly.
 
@@ -183,20 +274,11 @@ Some tips on getting around the code:
 
 - Use `yarn dev` for development - it runs TypeScript compile in watch mode, allowing you to make
   changes and immediately be able to try them using `yarn cmd`.
-- Use `yarn build` to build the output once
+- 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. From here you have several
-  > options:
-  >
-  > - Run `yarn dev` to watch for file changes and build automatically
-  > - Run `yarn build` before running this to trigger a one-time build
-  > - 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)
+  > This requires an updated build, and does not trigger one itself. Either use `yarn dev` or
+  > `yarn build` before running this, or use `yarn build-cmd` instead, which triggers a build right
+  > before running the command with the rest of the given arguments.

babel.config.js

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

jest.config.ts

@@ -13,7 +13,7 @@ export default {
   // The directory where Jest should store its cached dependency information
   // cacheDirectory: "/private/var/folders/q9/0mns8fgd00b4t5j5lq2wh2yh0000gn/T/jest_dx",
 
-  // Automatically clear mock calls, instances, contexts and results before every test
+  // Automatically clear mock calls and instances between every test
   clearMocks: true,
 
   // Indicates whether the coverage information should be collected while executing the test
@@ -50,11 +50,6 @@ export default {
   // Make calling deprecated APIs throw helpful error messages
   // errorOnDeprecated: false,
 
-  // The default configuration for fake timers
-  // fakeTimers: {
-  //   "enableGlobally": false
-  // },
-
   // Force coverage collection from ignored files using an array of glob patterns
   // forceCoverageMatch: [],
 
@@ -78,8 +73,6 @@ export default {
   // An array of file extensions your modules use
   // moduleFileExtensions: [
   //   "js",
-  //   "mjs",
-  //   "cjs",
   //   "jsx",
   //   "ts",
   //   "tsx",
@@ -89,11 +82,6 @@ export default {
 
   // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
   // moduleNameMapper: {},
-  // moduleNameMapper: {
-  //   chalk: "<rootDir>/node_modules/chalk/source/index.js",
-  //   "#ansi-styles": "<rootDir>/node_modules/chalk/source/vendor/ansi-styles/index.js",
-  //   "#supports-color": "<rootDir>/node_modules/chalk/source/vendor/supports-color/index.js",
-  // },
 
   // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
   modulePathIgnorePatterns: ["<rootDir>/dist"],
@@ -113,7 +101,7 @@ export default {
   // Use this configuration option to add custom reporters to Jest
   // reporters: undefined,
 
-  // Automatically reset mock state before every test
+  // Automatically reset mock state between every test
   // resetMocks: false,
 
   // Reset the module registry before running each individual test
@@ -122,7 +110,7 @@ export default {
   // A path to a custom resolver
   // resolver: undefined,
 
-  // Automatically restore mock state and implementation before every test
+  // Automatically restore mock state between every test
   // restoreMocks: false,
 
   // The root directory that Jest should scan for tests and modules within
@@ -149,7 +137,7 @@ export default {
   // snapshotSerializers: [],
 
   // The test environment that will be used for testing
-  // testEnvironment: "jest-environment-node",
+  testEnvironment: "node",
 
   // Options that will be passed to the testEnvironment
   // testEnvironmentOptions: {},
@@ -177,8 +165,14 @@ export default {
   // This option allows use of a custom test runner
   // testRunner: "jest-circus/runner",
 
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
   // A map from regular expressions to paths to transformers
-  // transform: undefined,
+  // transform: {},
 
   // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
   // transformIgnorePatterns: [
@@ -186,11 +180,6 @@ export default {
   //   "\\.pnp\\.[^\\/]+$"
   // ],
 
-  // transform: {
-  //   "^.+\\.ts?$": "ts-jest",
-  // },
-  // transformIgnorePatterns: ["<rootDir>/node_modules/"],
-
   // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
   // unmockedModulePathPatterns: undefined,
 
@@ -202,4 +191,6 @@ export default {
 
   // Whether to use watchman for file crawling
   // watchman: true,
+
+  // extensionsToTreatAsEsm: [".ts"],
 }

package.json

@@ -1,65 +1,42 @@
 {
   "name": "simple-scaffold",
-  "version": "1.7.1-develop.1",
-  "description": "Generate any file structure - from single components to entire app boilerplates, with a single command.",
-  "homepage": "https://chenasraf.github.io/simple-scaffold",
+  "version": "1.0.0-alpha.14",
+  "description": "Create files based on templates",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
-  "author": "Chen Asraf <contact@casraf.dev>",
+  "author": "Chen Asraf <inbox@casraf.com>",
   "license": "MIT",
   "main": "index.js",
   "bin": "cmd.js",
-  "packageManager": "pnpm@8.5.0",
-  "keywords": [
-    "javascript",
-    "cli",
-    "template",
-    "files",
-    "typescript",
-    "generator",
-    "scaffold",
-    "file",
-    "scaffolding"
-  ],
   "scripts": {
-    "clean": "rimraf dist/",
-    "build": "pnpm clean && tsc && chmod -R +x ./dist && cp ./package.json ./README.md ./dist/",
+    "clean": "rm -rf dist/",
+    "build": "yarn clean && tsc && chmod -R +x ./dist && cp ./package.json ./dist/ && cp ./README.md ./dist/",
     "dev": "tsc --watch",
     "start": "node dist/scaffold.js",
-    "test": "jest",
+    "test": "jest --verbose",
     "cmd": "node --trace-warnings dist/cmd.js",
-    "build-test": "pnpm build && pnpm test",
-    "build-cmd": "pnpm build && pnpm cmd",
-    "build-docs": "typedoc",
-    "watch-docs": "pnpm typedoc --watch",
-    "audit-fix": "pnpm audit --fix",
-    "changelog": "conventional-changelog -p conventionalcommits -i CHANGELOG.md -s -r 0; echo \"# Change Log\n\n$(cat CHANGELOG.md)\" > CHANGELOG.md"
+    "build-test": "yarn build && yarn test",
+    "build-cmd": "yarn build && yarn cmd"
   },
   "dependencies": {
+    "args": "^5.0.1",
     "chalk": "^4.1.2",
-    "date-fns": "^2.30.0",
-    "glob": "^10.2.3",
+    "glob": "^7.1.3",
     "handlebars": "^4.7.7",
-    "massarg": "^1.0.7-pre.1"
+    "lodash": "^4.17.21",
+    "massarg": "^1.0.5",
+    "util.promisify": "^1.1.1"
   },
   "devDependencies": {
-    "@knodes/typedoc-plugin-pages": "^0.23.4",
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
-    "@semantic-release/release-notes-generator": "^10.0.3",
-    "@types/jest": "^29.5.1",
+    "@types/args": "^3.0.1",
+    "@types/glob": "^7.1.1",
+    "@types/jest": "^26.0.24",
+    "@types/lodash": "^4.14.171",
     "@types/mock-fs": "^4.13.1",
-    "@types/node": "^18.16.0",
-    "conventional-changelog": "^3.1.25",
-    "conventional-changelog-cli": "^2.2.2",
-    "conventional-changelog-conventionalcommits": "^5.0.0",
-    "jest": "^29.5.0",
-    "mock-fs": "^5.2.0",
-    "rimraf": "^5.0.0",
-    "semantic-release": "^21.0.1",
-    "semantic-release-conventional-commits": "^3.0.0",
-    "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
-    "typedoc": "^0.24.6",
-    "typescript": "^5.0.4"
+    "@types/node": "^14.14.22",
+    "jest": "^27.0.6",
+    "mock-fs": "^5.0.0",
+    "ts-jest": "^27.0.3",
+    "ts-node": "^10.1.0",
+    "typescript": "^4.3.5"
   }
 }

pages/README.md

@@ -1,7 +0,0 @@
-See full documentation [here](https://chenasraf.github.io/simple-scaffold).
-
-- [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
-- [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html)
-- [Templates](https://chenasraf.github.io/simple-scaffold/pages/templates.html)
-- [Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/configuration_files.html)
-- [Migrating v0.x to v1.x](https://chenasraf.github.io/simple-scaffold/pages/migration.html)

pages/cli.md

@@ -1,79 +0,0 @@
-## Available flags
-
-```text
-Usage: simple-scaffold [options]
-```
-
-To see this and more information anytime, add the `-h` or `--help` flag to your call, e.g.
-`npx simple-scaffold@latest -h`.
-
-| Command \| alias                  |                                                                                                                                                                                                     |
-| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--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.                                                                        |
-| `--config`\|`-c`                  | Filename or HTTPS git URL to load config from instead of passing arguments to CLI or using a Node.js script.                                                                                        |
-| `--github`\|`-gh`                 | GitHub path to load config from instead of passing arguments to CLI or using a Node.js script.                                                                                                      |
-| `--key`\|`-k`                     | Key to load inside the config file. This overwrites the config key provided after the colon in --config (e.g. --config scaffold.cmd.js:component)                                                   |
-| `--output`\|`-o`                  | Path to output to. If --create-sub-folder is enabled, the subfolder will be created inside this path. (default: current dir)                                                                        |
-| `--templates`\|`-t`               | Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path, or a glob pattern for multiple file matching easily.                              |
-| `--overwrite`\|`-w`               | Enable to override output files, even if they already exist. (default: false)                                                                                                                       |
-| `--data`\|`-d`                    | Add custom data to the templates. By default, only your app name is included.                                                                                                                       |
-| `--append-data`\|`-D`             | Append additional custom data to the templates, which will overwrite --data, using an alternate syntax, which is easier to use with CLI: -D key1=string -D key2:=raw                                |
-| `--create-sub-folder`\|`-s`       | Create subfolder with the input name (default: false)                                                                                                                                               |
-| `--sub-folder-name-helper`\|`-sh` | Default helper to apply to subfolder name when using `--create-sub-folder true`.                                                                                                                    |
-| `--quiet`\|`-q`                   | Suppress output logs (Same as --verbose 0) (default: false)                                                                                                                                         |
-| `--verbose`\|`-v`                 | Determine amount of logs to display. The values are: 0 (none) \| 1 (debug) \| 2 (info) \| 3 (warn) \| 4 (error). The provided level will display messages of the same level or higher. (default: 2) |
-| `--dry-run`\|`-dr`                | Don't emit files. This is good for testing your scaffolds and making sure they don't fail, without having to write actual file contents or create directories. (default: false)                     |
-
-## Examples:
-
-> See
-> [Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/docs/configuration_files.md)
-> for organizing multiple scaffold types into easy-to-maintain files
-
-Usage with config file
-
-```shell
-$ simple-scaffold -c scaffold.cmd.js --key component
-```
-
-Usage with GitHub config file
-
-```shell
-$ simple-scaffold -gh chenasraf/simple-scaffold --key component
-```
-
-Usage with https git URL (for non-GitHub)
-
-```shell
-$ simple-scaffold -c \
-      https://example.com/user/template.git#scaffold.cmd.js --key component
-```
-
-Full syntax with config path and template key (applicable to all above methods)
-
-```shell
-$ simple-scaffold -c scaffold.cmd.js:component MyComponent
-```
-
-Excluded template key, assumes 'default' key
-
-```shell
-$ simple-scaffold -c scaffold.cmd.js MyComponent
-```
-
-Shortest syntax for GitHub, assumes file 'scaffold.cmd.js' and template key 'default'
-
-```shell
-$ simple-scaffold -gh chenasraf/simple-scaffold MyComponent
-```
-
-You can also add this as a script in your `package.json`:
-
-```json
-{
-  "scripts": {
-    "scaffold": "npx simple-scaffold@latest -t scaffolds/component/**/* -o src/components -d '{\"myProp\": \"propName\", \"myVal\": 123}'"
-  }
-}
-```

pages/configuration_files.md

@@ -1,155 +0,0 @@
-If you want to have reusable configurations which are complex and don't fit into command lines
-easily, or just want to manage your templates easier, you can use configuration files to load your
-scaffolding configurations.
-
-## Creating config files
-
-Configuration files should be valid `.js`/`.json` files that contain valid Scaffold configurations.
-
-Each file hold multiple scaffolds. Each scaffold is a key, and its value is the configuration. For
-example:
-
-```json
-{
-  "component": {
-    "templates": ["templates/component"],
-    "output": "src/components"
-  }
-}
-```
-
-The configuration contents are identical to the
-[Node.js configuration structure](https://chenasraf.github.io/simple-scaffold/pages/node.md):
-
-```ts
-interface ScaffoldConfig {
-  name: string
-  templates: string[]
-  output: FileResponse<string>
-  createSubFolder?: boolean
-  data?: Record<string, any>
-  overwrite?: FileResponse<boolean>
-  quiet?: boolean
-  verbose?: LogLevel
-  dryRun?: boolean
-  helpers?: Record<string, Helper>
-  subFolderNameHelper?: DefaultHelpers | string
-  beforeWrite?(
-    content: Buffer,
-    rawContent: Buffer,
-    outputPath: string,
-  ): string | Buffer | undefined | Promise<string | Buffer | undefined>
-}
-```
-
-If you want to supply functions inside the configurations, you must use a `.js` file as JSON does
-not support non-primitives.
-
-A `.js` file is just like a `.json` file, make sure to export the final configuration:
-
-```js
-/** @type {import('simple-scaffold').ScaffoldConfigFile} */
-module.exports = {
-  component: {
-    templates: ["templates/component"],
-    output: "src/components",
-  },
-}
-```
-
-## Using a config file
-
-Once your config is created, you can use it by providing the file name to the `--config` (or `-c`
-for brevity), optionally followed by a colon, then your scaffold config name.
-
-```shell
-simple-scaffold -c <file>[:<template_key>]
-```
-
-For example:
-
-```shell
-simple-scaffold -c scaffold.json:component MyComponentName
-```
-
-If you don't want to supply a template/config name (e.g. `component`), you can omit the colon and
-the name, and it will use the configuration named `default`:
-
-```js
-/** @type {import('simple-scaffold').ScaffoldConfigFile} */
-module.exports = {
-  default: {
-    // ...
-  },
-}
-```
-
-And then:
-
-```shell
-# will use 'default' template
-simple-scaffold -c scaffold.json MyComponentName
-```
-
-## Remote Templates
-
-You can load template groups remotely, similar to how you would pass a config normally.
-
-The main difference is the templates will be hosted on a remote location such as a git server, and
-not locally in your project. This can be done to easily share & reuse templates.
-
-When passing a git URL to `--config`, you will clone that repo and use the files there as template.
-
-The syntax is as follows:
-
-```shell
-simple-scaffold -c <git_url>[#<git_file>][:<template_key>]
-```
-
-For example, to use this repository's example as base:
-
-```shell
-simple-scaffold -c https://github.com/chenasraf/simple-scaffold.git#examples/test-input/scaffold.config.js:component
-```
-
-When the filename is omitted, `/scaffold.config.js` will be used as default.
-
-When the template_key is ommitted, `default` will be used as default.
-
-### GitHub Templates
-
-As a shorter alternative to the above example, you can use `--github` or `-gh` to reference a GitHub
-URL without specifying the whole path.
-
-The syntax is as follows:
-
-```shell
-simple-scaffold -gh <username>/<project_name>[#<git_file>][:<template_key>]
-```
-
-This example is equivalent to the above, just shorter to write:
-
-```shell
-simple-scaffold -c chenasraf/simple-scaffold#examples/test-input/scaffold.config.js:component
-```
-
-## Use In Node.js
-
-You can also start a scaffold from Node.js with a remote file or URL config.
-
-Just use the `Scaffold.fromConfig` function:
-
-```ts
-Scaffold.fromConfig(
-  "scaffold.config.js", // file or HTTPS git URL
-  {
-    // name of the generated component
-    name: "My Component",
-    // key to load from the config
-    key: "component",
-  },
-  {
-    // other config overrides
-  },
-)
-```

pages/node.md

@@ -1,53 +0,0 @@
-You can build the scaffold yourself, if you want to create more complex arguments, scaffold groups,
-etc - simply pass a config object to the Scaffold function when you are ready to start.
-
-The config takes similar arguments to the command line. The full type definitions can be found in
-[src/types.ts](https://github.com/chenasraf/simple-scaffold/blob/develop/src/types.ts#L13).
-
-See the full
-[documentation](https://chenasraf.github.io/simple-scaffold/interfaces/ScaffoldConfig.html) for the
-configuration options and their behavior.
-
-```ts
-interface ScaffoldConfig {
-  name: string
-  templates: string[]
-  output: FileResponse<string>
-  createSubFolder?: boolean
-  data?: Record<string, any>
-  overwrite?: FileResponse<boolean>
-  quiet?: boolean
-  verbose?: LogLevel
-  dryRun?: boolean
-  helpers?: Record<string, Helper>
-  subFolderNameHelper?: DefaultHelpers | string
-  beforeWrite?(
-    content: Buffer,
-    rawContent: Buffer,
-    outputPath: string,
-  ): string | Buffer | undefined | Promise<string | Buffer | undefined>
-}
-```
-
-This is an example of loading a complete scaffold via Node.js:
-
-```typescript
-import Scaffold from "simple-scaffold"
-
-const config = {
-  name: "component",
-  templates: [path.join(__dirname, "scaffolds", "component")],
-  output: path.join(__dirname, "src", "components"),
-  createSubFolder: true,
-  subFolderNameHelper: "upperCase"
-  data: {
-    property: "value",
-  },
-  helpers: {
-    twice: (text) => [text, text].join(" ")
-  },
-  beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase()
-}
-
-const scaffold = Scaffold(config)
-```

pages/templates.md

@@ -1,224 +0,0 @@
-# Preparing template files
-
-Put your template files anywhere, and fill them with tokens for replacement.
-
-Each template (not file) in the config array is parsed individually, and copied to the output
-directory. If a single template path contains multiple files (e.g. if you use a folder path or a
-glob pattern), the first directory up the tree of that template will become the base inside the
-defined output path for that template, while copying files recursively and maintaining their
-relative structure.
-
-Examples:
-
-> In the following examples, the config `name` is `AppName`, and the config `output` is `src`.
-
-| Input template                | Files in template                                      | Output path(s)                                               |
-| ----------------------------- | ------------------------------------------------------ | ------------------------------------------------------------ |
-| `./templates/{{ name }}.txt`  | `./templates/{{ name }}.txt`                           | `src/AppName.txt`                                            |
-| `./templates/directory`       | `outer/{{name}}.txt`,<br />`outer2/inner/{{name}}.txt` | `src/outer/AppName.txt`,<br />`src/outer2/inner/AppName.txt` |
-| `./templates/others/**/*.txt` | `outer/{{name}}.jpg`,<br />`outer2/inner/{{name}}.txt` | `src/outer2/inner/AppName.txt`                               |
-
-## Variable/token replacement
-
-Scaffolding will replace `{{ varName }}` in both the file name and its contents and put the
-transformed files in the output directory.
-
-The data available for the template parser is the data you pass to the `data` config option (or
-`--data` argument in CLI).
-
-For example, using the following command:
-
-```bash
-npx simple-scaffold@latest \
-  --templates templates/components/{{name}}.jsx \
-  --output src/components \
-  --create-sub-folder true \
-  MyComponent
-```
-
-Will output a file with the path:
-
-```text
-<working_dir>/src/components/MyComponent.jsx
-```
-
-The contents of the file will be transformed in a similar fashion.
-
-Your `data` will be pre-populated with the following:
-
-- `{{Name}}`: PascalCase of the component name
-- `{{name}}`: raw name of the component as you entered it
-
-> Simple-Scaffold uses [Handlebars.js](https://handlebarsjs.com/) for outputting the file contents.
-> Any `data` you add in the config will be available for use with their names wrapped in `{{` and
-> `}}`. Other Handlebars built-ins such as `each`, `if` and `with` are also supported, see
-> [Handlebars.js Language Features](https://handlebarsjs.com/guide/#language-features) for more
-> information.
-
-## Helpers
-
-### Built-in Helpers
-
-Simple-Scaffold provides some built-in text transformation filters usable by Handlebars.
-
-For example, you may use `{{ snakeCase name }}` inside a template file or filename, and it will
-replace `My Name` with `my_name` when producing the final value.
-
-#### Capitalization Helpers
-
-| Helper name  | Example code            | Example output |
-| ------------ | ----------------------- | -------------- |
-| [None]       | `{{ name }}`            | my name        |
-| `camelCase`  | `{{ camelCase name }}`  | myName         |
-| `snakeCase`  | `{{ snakeCase name }}`  | my_name        |
-| `startCase`  | `{{ startCase name }}`  | My Name        |
-| `kebabCase`  | `{{ kebabCase name }}`  | my-name        |
-| `hyphenCase` | `{{ hyphenCase name }}` | my-name        |
-| `pascalCase` | `{{ pascalCase name }}` | MyName         |
-| `upperCase`  | `{{ upperCase name }}`  | MY NAME        |
-| `lowerCase`  | `{{ lowerCase name }}`  | my name        |
-
-#### Date helpers
-
-| Helper name                      | Description                                                      | Example code                                                     | Example output     |
-| -------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------ |
-| `now`                            | Current date with format                                         | `{{ now "yyyy-MM-dd HH:mm" }}`                                   | `2042-01-01 15:00` |
-| `now` (with offset)              | Current date with format, and with offset                        | `{{ now "yyyy-MM-dd HH:mm" -1 "hours" }}`                        | `2042-01-01 14:00` |
-| `date`                           | Custom date with format                                          | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" }}`           | `2042-01-01 15:00` |
-| `date` (with offset)             | Custom date with format, and with offset                         | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" -1 "days" }}` | `2041-31-12 15:00` |
-| `date` (with date from `--data`) | Custom date with format, with data from the `data` config option | `{{ date myCustomDate "yyyy-MM-dd HH:mm" }}`                     | `2042-01-01 12:00` |
-
-Further details:
-
-- We use [`date-fns`](https://date-fns.org/docs/) for parsing/manipulating the dates. If you want
-  more information on the date tokens to use, refer to
-  [their format documentation](https://date-fns.org/docs/format).
-
-- The date helper format takes the following arguments:
-
-  ```typescript
-  (
-    date: string,
-    format: string,
-    offsetAmount?: number,
-    offsetType?: "years" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds"
-  )
-  ```
-
-- **The now helper** (for current time) takes the same arguments, minus the first one (`date`) as it
-  is implicitly the current date.
-
-### Custom Helpers
-
-You may also add your own custom helpers using the `helpers` options when using the JS API (rather
-than the CLI). The `helpers` option takes an object whose keys are helper names, and values are the
-transformation functions. For example, `upperCase` is implemented like so:
-
-```typescript
-config.helpers = {
-  upperCase: (text) => text.toUpperCase(),
-}
-```
-
-All of the above helpers (built in and custom) will also be available to you when using
-`subFolderNameHelper` (`--sub-folder-name-helper`/`-sh`) as a possible value.
-
-> To see more information on how helpers work and more features, see
-> [Handlebars.js docs](https://handlebarsjs.com/guide/#custom-helpers).
-
-# Examples
-
-## Run
-
-### Command Example
-
-```bash
-simple-scaffold MyComponent \
-    -t project/scaffold/**/* \
-    -o src/components \
-    -d '{"className": "myClassName","author": "Chen Asraf"}'
-    MyComponent
-```
-
-### Equivalent Node Module Example
-
-```typescript
-import Scaffold from "simple-scaffold"
-
-async function main() {
-  await Scaffold({
-    name: "MyComponent",
-    templates: ["project/scaffold/**/*"],
-    output: ["src/components"],
-    data: {
-      className: "myClassName",
-      author: "Chen Asraf",
-    },
-  })
-  console.log("Done.")
-}
-```
-
-## Files
-
-### Input
-
-- Input file path:
-
-  ```text
-  project → scaffold → {{Name}}.js → src → components
-  ```
-
-- Input file contents:
-
-  ```typescript
-  /**
-   * Author: {{ author }}
-   * Date: {{ now "yyyy-MM-dd" }}
-   */
-  import React from 'react'
-
-  export default {{camelCase name}}: React.FC = (props) => {
-    return (
-      <div className="{{className}}">{{camelCase name}} Component</div>
-    )
-  }
-  ```
-
-### Output
-
-- Output file path:
-
-  - With `createSubFolder = false` (default):
-
-    ```text
-    project → src → components → MyComponent.js
-    ```
-
-  - With `createSubFolder = true`:
-
-    ```text
-    project → src → components → MyComponent → MyComponent.js
-    ```
-
-  - With `createSubFolder = true` and `subFolderNameHelper = 'upperCase'`:
-
-    ```text
-    project → src → components → MYCOMPONENT → MyComponent.js
-    ```
-
-- Output file contents:
-
-  ```typescript
-  /**
-   * Author: Chen Asraf
-   * Date: 2077-01-01
-   */
-  import React from 'react'
-
-  export default MyComponent: React.FC = (props) => {
-    return (
-      <div className="myClassName">MyComponent Component</div>
-    )
-  }
-  ```

release.config.js

@@ -1,89 +0,0 @@
-const releaseRules = [
-  { type: "feat", section: "Features", release: "minor" },
-  { type: "revert", section: "Features", release: "minor" },
-  { type: "fix", section: "Bug Fixes", release: "patch" },
-  { type: "chore", section: "Misc", release: "patch" },
-  { type: "refactor", section: "Misc", release: "patch" },
-  { type: "perf", section: "Misc", release: "patch" },
-  { type: "build", section: "Build", release: "patch" },
-  { type: "docs", section: "Build", release: false },
-  { type: "test", section: "Tests", release: "patch" },
-]
-
-/** @type {import('semantic-release').Options} */
-module.exports = {
-  branches: [
-    "+([0-9])?(.{+([0-9]),x}).x",
-    "master",
-    "next",
-    "next-major",
-    { name: "develop", prerelease: true },
-    { name: "beta", prerelease: true },
-    { name: "alpha", prerelease: true },
-  ],
-  analyzeCommits: {
-    path: "semantic-release-conventional-commits",
-    majorTypes: releaseRules.filter((x) => x.release === "major").map((x) => x.type),
-    minorTypes: releaseRules.filter((x) => x.release === "minor").map((x) => x.type),
-    patchTypes: releaseRules.filter((x) => x.release === "patch").map((x) => x.type),
-  },
-  plugins: [
-    [
-      "@semantic-release/commit-analyzer",
-      {
-        preset: "conventionalcommits",
-        parserOpts: {
-          noteKeywords: ["breaking:", "breaking-fix:", "breaking-feat:"],
-        },
-        releaseRules: releaseRules,
-      },
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        preset: "conventionalcommits",
-        parserOpts: {
-          noteKeywords: ["breaking", "major"],
-          types: releaseRules,
-        },
-      },
-    ],
-    [
-      "@semantic-release/changelog",
-      {
-        changelogFile: "CHANGELOG.md",
-        changelogTitle: "# Change Log",
-      },
-    ],
-    [
-      "@semantic-release/npm",
-      {
-        npmPublish: false,
-      },
-    ],
-    [
-      "@semantic-release/npm",
-      {
-        npmPublish: true,
-        pkgRoot: "dist",
-      },
-    ],
-    [
-      "@semantic-release/git",
-      {
-        assets: ["CHANGELOG.md", "package.json"],
-      },
-    ],
-    [
-      "@semantic-release/github",
-      {
-        assets: [
-          {
-            path: "*.tgz",
-            name: "simple-scaffold.tgz",
-          },
-        ],
-      },
-    ],
-  ],
-}

scaffold.config.js

@@ -1,13 +0,0 @@
-/** @type {import('simple-scaffold').ScaffoldConfigFile} */
-module.exports = {
-  default: {
-    templates: ["examples/test-input/Component"],
-    output: "examples/test-output",
-    data: { property: "myProp", value: "10" },
-  },
-  component: {
-    templates: ["examples/test-input/Component"],
-    output: "examples/test-output/component",
-    data: { property: "myProp", value: "10" },
-  },
-}

src/cmd.ts

@@ -1,169 +1,2 @@
-#!/usr/bin/env node
-import massarg from "massarg"
-import chalk from "chalk"
-import { LogLevel, ScaffoldCmdConfig } from "./types"
-import { Scaffold } from "./scaffold"
-import path from "path"
-import fs from "fs/promises"
-import { parseAppendData, parseConfig } from "./config"
-
-export async function parseCliArgs(args = process.argv.slice(2)) {
-  const pkgFile = await fs.readFile(path.join(__dirname, "package.json"))
-  const pkg = JSON.parse(pkgFile.toString())
-  const isConfigProvided =
-    args.includes("--config") || args.includes("-c") || args.includes("--github") || args.includes("-gh")
-
-  return (
-    massarg<ScaffoldCmdConfig>()
-      .main(async (config) => {
-        const _config = await parseConfig(config)
-        return Scaffold(_config)
-      })
-      .option({
-        name: "name",
-        aliases: ["n"],
-        description:
-          "Name to be passed to the generated files. {{name}} and {{Name}} inside contents and file names will be replaced accordingly.",
-        isDefault: true,
-        required: true,
-      })
-      .option({
-        name: "config",
-        aliases: ["c"],
-        description:
-          "Filename or https git URL to load config from instead of passing arguments to CLI or using a Node.js script. See examples for syntax.",
-      })
-      .option({
-        name: "github",
-        aliases: ["gh"],
-        description:
-          "GitHub path to load config from instead of passing arguments to CLI or using a Node.js script. See examples for syntax.",
-      })
-      .option({
-        name: "key",
-        aliases: ["k"],
-        description:
-          "Key to load inside the config file. This overwrites the config key provided after the colon in --config (e.g. --config scaffold.cmd.js:component)",
-      })
-      .option({
-        name: "output",
-        aliases: ["o"],
-        description: `Path to output to. If --create-sub-folder is enabled, the subfolder will be created inside this path. ${chalk.reset`${chalk.white`(default: current dir)`}`}`,
-        required: !isConfigProvided,
-      })
-      .option({
-        name: "templates",
-        aliases: ["t"],
-        array: true,
-        description:
-          "Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path, " +
-          "or a glob pattern for multiple file matching easily.",
-        required: !isConfigProvided,
-      })
-      .option({
-        name: "overwrite",
-        aliases: ["w"],
-        boolean: true,
-        defaultValue: false,
-        description: "Enable to override output files, even if they already exist.",
-      })
-      .option({
-        name: "data",
-        aliases: ["d"],
-        description: "Add custom data to the templates. By default, only your app name is included.",
-        parse: (v) => JSON.parse(v),
-      })
-      .option({
-        name: "append-data",
-        aliases: ["D"],
-        description:
-          "Append additional custom data to the templates, which will overwrite --data, using an alternate syntax, which is easier to use with CLI: -D key1=string -D key2:=raw",
-        parse: parseAppendData,
-      })
-      .option({
-        name: "create-sub-folder",
-        aliases: ["s"],
-        boolean: true,
-        defaultValue: false,
-        description: "Create subfolder with the input name",
-      })
-      .option({
-        name: "sub-folder-name-helper",
-        aliases: ["sh"],
-        description: "Default helper to apply to subfolder name when using `--create-sub-folder true`.",
-      })
-      .option({
-        name: "quiet",
-        aliases: ["q"],
-        boolean: true,
-        defaultValue: false,
-        description: "Suppress output logs (Same as --verbose 0)",
-      })
-      .option({
-        name: "verbose",
-        aliases: ["v"],
-        defaultValue: LogLevel.Info,
-        description:
-          "Determine amount of logs to display. The values are: " +
-          `${chalk.bold`0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`}. ` +
-          "The provided level will display messages of the same level or higher.",
-        parse: Number,
-      })
-      .option({
-        name: "dry-run",
-        aliases: ["dr"],
-        boolean: true,
-        defaultValue: false,
-        description:
-          "Don't emit files. This is good for testing your scaffolds and making sure they " +
-          "don't fail, without having to write actual file contents or create directories.",
-      })
-      // .example({
-      //   input: `yarn cmd -t examples/test-input/Component -o examples/test-output -d '{"property":"myProp","value":"10"}'`,
-      //   description: "Usage",
-      //   output: "",
-      // })
-      .example({
-        description: "Usage with config file",
-        input: "simple-scaffold -c scaffold.cmd.js --key component",
-      })
-      .example({
-        description: "Usage with GitHub config file",
-        input: "simple-scaffold -gh chenasraf/simple-scaffold --key component",
-      })
-      .example({
-        description: "Usage with https git URL (for non-GitHub)",
-        input: "simple-scaffold -c https://example.com/user/template.git#scaffold.cmd.js --key component",
-      })
-      .example({
-        description: "Full syntax with config path and template key (applicable to all above methods)",
-        input: "simple-scaffold -c scaffold.cmd.js:component MyComponent",
-      })
-      .example({
-        description: "Excluded template key, assumes 'default' key",
-        input: "simple-scaffold -c scaffold.cmd.js MyComponent",
-      })
-      .example({
-        description: "Shortest syntax for GitHub, assumes file 'scaffold.cmd.js' and template key 'default'",
-        input: "simple-scaffold -gh chenasraf/simple-scaffold MyComponent",
-      })
-      .help({
-        binName: "simple-scaffold",
-        useGlobalColumns: true,
-        usageExample: "[options]",
-        printWidth: 100,
-        header: [`Create structured files based on templates.`].join("\n"),
-        footer: [
-          `Version:  ${pkg.version}`,
-          `Copyright © Chen Asraf 2017-${new Date().getFullYear()}`,
-          ``,
-          `Documentation: ${chalk.underline`https://chenasraf.github.io/simple-scaffold`}`,
-          `NPM: ${chalk.underline`https://npmjs.com/package/simple-scaffold`}`,
-          `GitHub: ${chalk.underline`https://github.com/chenasraf/simple-scaffold`}`,
-        ].join("\n"),
-      })
-      .parse(args)
-  )
-}
-
+import { parseCliArgs } from "./cmd_util"
 parseCliArgs()

src/cmd_util.ts

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

src/config.ts

@@ -1,177 +0,0 @@
-import path from "path"
-import {
-  AsyncResolver,
-  ConfigLoadConfig,
-  FileResponse,
-  FileResponseHandler,
-  LogConfig,
-  LogLevel,
-  Resolver,
-  ScaffoldCmdConfig,
-  ScaffoldConfig,
-  ScaffoldConfigFile,
-  ScaffoldConfigMap,
-} from "./types"
-import { OptionsBase } from "massarg/types"
-import { spawn } from "node:child_process"
-import os from "node:os"
-import { handlebarsParse } from "./parser"
-import { log } from "./logger"
-import { resolve } from "./utils"
-
-export function getOptionValueForFile<T>(
-  config: ScaffoldConfig,
-  filePath: string,
-  fn: FileResponse<T>,
-  defaultValue?: T,
-): T {
-  if (typeof fn !== "function") {
-    return defaultValue ?? (fn as T)
-  }
-  return (fn as FileResponseHandler<T>)(
-    filePath,
-    path.dirname(handlebarsParse(config, filePath, { isPath: true }).toString()),
-    path.basename(handlebarsParse(config, filePath, { isPath: true }).toString()),
-  )
-}
-
-export function parseAppendData(value: string, options: ScaffoldCmdConfig & OptionsBase): unknown {
-  const data = options.data ?? {}
-  const [key, val] = value.split(/\:?=/)
-  // raw
-  if (value.includes(":=") && !val.includes(":=")) {
-    return { ...data, [key]: JSON.parse(val) }
-  }
-  return { ...data, [key]: isWrappedWithQuotes(val) ? val.substring(1, val.length - 1) : val }
-}
-
-function isWrappedWithQuotes(string: string): boolean {
-  return (string.startsWith('"') && string.endsWith('"')) || (string.startsWith("'") && string.endsWith("'"))
-}
-
-/** @internal */
-export async function parseConfig(config: ScaffoldCmdConfig & OptionsBase): Promise<ScaffoldConfig> {
-  let c: ScaffoldConfig = config
-  if (config.github) {
-    log(config, LogLevel.Info, `Loading config from github ${config.github}`)
-    config.config = githubPartToUrl(config.github)
-  }
-
-  if (config.config) {
-    const { configFile, key } = parseConfigSelection(config.config, config.key)
-    log(config, LogLevel.Info, `Loading config from ${configFile} with key ${key}`)
-    const configPromise = await getConfig({ config: configFile, quiet: config.quiet, verbose: config.verbose })
-    const configImport = await resolve(configPromise, config)
-
-    if (!configImport[key]) {
-      throw new Error(`Template "${key}" not found in ${configFile}`)
-    }
-    c = {
-      ...config,
-      ...configImport[key],
-      data: {
-        ...configImport[key].data,
-        ...config.data,
-      },
-    }
-  }
-
-  c.data = { ...c.data, ...config.appendData }
-  delete config.appendData
-  return c
-}
-
-export function parseConfigSelection(config: string, key?: string): { configFile: string; key: string } {
-  const isUrl = config.includes("://")
-
-  const hasColonToken = (!isUrl && config.includes(":")) || (isUrl && count(config, ":") > 1)
-  const colonIndex = config.lastIndexOf(":")
-  const [configFile, templateKey = "default"] = hasColonToken
-    ? [config.substring(0, colonIndex), config.substring(colonIndex + 1)]
-    : [config, undefined]
-  const _key = (key ?? templateKey) || "default"
-  return { configFile, key: _key }
-}
-
-export function githubPartToUrl(part: string): string {
-  const gitUrl = new URL(`https://github.com/${part}`)
-  if (!gitUrl.pathname.endsWith(".git")) {
-    gitUrl.pathname += ".git"
-  }
-  return gitUrl.toString()
-}
-
-function wrapNoopResolver<T, R = T>(value: Resolver<T, R>): Resolver<T, R> {
-  if (typeof value === "function") {
-    return value
-  }
-
-  return (_) => value
-}
-
-/** @internal */
-export async function getConfig(config: ConfigLoadConfig): Promise<ScaffoldConfigFile> {
-  const { config: configFile, ...logConfig } = config as Required<typeof config>
-  const url = configFile.includes("://") ? new URL(configFile) : new URL(`file://${configFile}`)
-
-  if (url.protocol === "file:") {
-    log(logConfig, LogLevel.Info, `Loading config from file ${configFile}`)
-    const absolutePath = path.resolve(process.cwd(), configFile)
-    return wrapNoopResolver(import(absolutePath))
-  }
-
-  const isHttp = url.protocol === "http:" || url.protocol === "https:"
-  const isGit = url.protocol === "git:" || (isHttp && url.pathname.endsWith(".git"))
-
-  if (isGit) {
-    return getGitConfig(url, logConfig)
-  }
-
-  if (!isHttp) {
-    throw new Error(`Unsupported protocol ${url.protocol}`)
-  }
-
-  return wrapNoopResolver(import(path.resolve(process.cwd(), configFile)))
-}
-
-async function getGitConfig(
-  url: URL,
-  logConfig: LogConfig,
-): Promise<AsyncResolver<ScaffoldCmdConfig, ScaffoldConfigMap>> {
-  const repoUrl = `${url.protocol}//${url.host}${url.pathname}`
-
-  log(logConfig, LogLevel.Info, `Cloning git repo ${repoUrl}`)
-
-  const tmpPath = path.resolve(os.tmpdir(), `scaffold-config-${Date.now()}`)
-
-  return new Promise((resolve, reject) => {
-    const clone = spawn("git", ["clone", "--depth", "1", repoUrl, tmpPath])
-
-    clone.on("error", reject)
-    clone.on("close", async (code) => {
-      if (code === 0) {
-        log(logConfig, LogLevel.Info, `Loading config from git repo: ${repoUrl}`)
-        const hashPath = url.hash?.replace("#", "") || "scaffold.config.js"
-        const absolutePath = path.resolve(tmpPath, hashPath)
-        const loadedConfig = (await import(absolutePath)).default as ScaffoldConfigMap
-        log(logConfig, LogLevel.Info, `Loaded config from git`)
-        log(logConfig, LogLevel.Debug, `Raw config:`, loadedConfig)
-        const fixedConfig: ScaffoldConfigMap = Object.fromEntries(
-          Object.entries(loadedConfig).map(([k, v]) => [
-            k,
-            // use absolute paths for template as config is necessarily in another directory
-            { ...v, templates: v.templates.map((t) => path.resolve(tmpPath, t)) },
-          ]),
-        )
-
-        resolve(wrapNoopResolver(fixedConfig))
-      } else {
-        reject(new Error(`Git clone failed with code ${code}`))
-      }
-    })
-  })
-}
-
-function count(string: string, substring: string): number {
-  return string.split(substring).length - 1
-}

src/docs.css

@@ -1,55 +0,0 @@
-.tsd-typography table {
-  border-collapse: collapse;
-  width: 100%;
-}
-
-.tsd-typography table td,
-.tsd-typography table th {
-  vertical-align: top;
-  border: 1px solid var(--color-accent);
-  padding: 6px;
-}
-.tsd-typography h1 + pre,
-.tsd-typography h2 + pre,
-.tsd-typography h3 + pre,
-.tsd-typography h4 + pre,
-.tsd-typography h5 + pre,
-.tsd-typography h6 + pre,
-/*  */
-.tsd-typography h1 + table,
-.tsd-typography h2 + table,
-.tsd-typography h3 + table,
-.tsd-typography h4 + table,
-.tsd-typography h5 + table,
-.tsd-typography h6 + table {
-  margin-top: 1em;
-}
-
-.tsd-typography pre + a + h1,
-.tsd-typography pre + a + h2,
-.tsd-typography pre + a + h3,
-.tsd-typography pre + a + h4,
-.tsd-typography pre + a + h5,
-.tsd-typography pre + a + h6,
-/*  */
-.tsd-typography table + a + h1,
-.tsd-typography table + a + h2,
-.tsd-typography table + a + h3,
-.tsd-typography table + a + h4,
-.tsd-typography table + a + h5,
-.tsd-typography table + a + h6 {
-  margin-top: 2em;
-}
-
-.tsd-index-accordion[data-key*="Configuration."] ul.tsd-nested-navigation,
-.tsd-index-accordion[data-key*="Configuration."] .tsd-accordion-summary > svg,
-.tsd-index-accordion[data-key="Changelog"] ul.tsd-nested-navigation,
-.tsd-index-accordion[data-key="Changelog"] .tsd-accordion-summary > svg,
-.tsd-index-accordion[data-key="Configuration"] li:nth-child(n + 6) {
-  display: none;
-}
-
-.tsd-index-accordion[data-key*="Configuration."],
-.tsd-index-accordion[data-key="Changelog"] {
-  margin-left: 0;
-}

src/file.ts

@@ -1,207 +0,0 @@
-import path from "path"
-import { F_OK } from "constants"
-import { LogLevel, ScaffoldConfig } from "./types"
-import { promises as fsPromises } from "fs"
-const { stat, access, mkdir } = fsPromises
-import { glob, hasMagic } from "glob"
-import { log } from "./logger"
-import { getOptionValueForFile } from "./config"
-import { handlebarsParse } from "./parser"
-import { handleErr } from "./utils"
-
-const { readFile, writeFile } = fsPromises
-
-export async function createDirIfNotExists(dir: string, config: ScaffoldConfig): Promise<void> {
-  const parentDir = path.dirname(dir)
-
-  if (!(await pathExists(parentDir))) {
-    await createDirIfNotExists(parentDir, config)
-  }
-
-  if (!(await pathExists(dir))) {
-    try {
-      log(config, LogLevel.Debug, `Creating dir ${dir}`)
-      await mkdir(dir)
-      return
-    } catch (e: any) {
-      if (e.code !== "EEXIST") {
-        throw e
-      }
-      return
-    }
-  }
-}
-
-export async function pathExists(filePath: string): Promise<boolean> {
-  try {
-    await access(filePath, F_OK)
-    return true
-  } catch (e: any) {
-    if (e.code === "ENOENT") {
-      return false
-    }
-    throw e
-  }
-}
-
-export async function isDir(path: string): Promise<boolean> {
-  const tplStat = await stat(path)
-  return tplStat.isDirectory()
-}
-
-export function removeGlob(template: string): string {
-  return template.replace(/\*/g, "").replace(/(\/\/|\\\\)/g, path.sep)
-}
-
-export function makeRelativePath(str: string): string {
-  return str.startsWith(path.sep) ? str.slice(1) : str
-}
-
-export function getBasePath(relPath: string): string {
-  return path
-    .resolve(process.cwd(), relPath)
-    .replace(process.cwd() + path.sep, "")
-    .replace(process.cwd(), "")
-}
-
-export async function getFileList(_config: ScaffoldConfig, template: string): Promise<string[]> {
-  return (
-    await glob(template, {
-      dot: true,
-      nodir: true,
-      // debug: config.verbose === LogLevel.Debug,
-    })
-  ).map(path.normalize)
-}
-
-export interface GlobInfo {
-  nonGlobTemplate: string
-  origTemplate: string
-  isDirOrGlob: boolean
-  isGlob: boolean
-  template: string
-}
-
-export async function getTemplateGlobInfo(config: ScaffoldConfig, template: string): Promise<GlobInfo> {
-  const isGlob = hasMagic(template)
-  log(config, LogLevel.Debug, "before isDir", "isGlob:", isGlob, template)
-  let _template = template
-  let nonGlobTemplate = isGlob ? removeGlob(template) : template
-  nonGlobTemplate = path.normalize(nonGlobTemplate)
-  const isDirOrGlob = isGlob ? true : await isDir(template)
-  log(config, LogLevel.Debug, "after isDir", isDirOrGlob)
-  const _shouldAddGlob = !isGlob && isDirOrGlob
-  const origTemplate = template
-  if (_shouldAddGlob) {
-    _template = path.join(template, "**", "*")
-  }
-  return { nonGlobTemplate, origTemplate, isDirOrGlob, isGlob, template: _template }
-}
-
-export interface OutputFileInfo {
-  inputPath: string
-  outputPathOpt: string
-  outputDir: string
-  outputPath: string
-  exists: boolean
-}
-
-export async function getTemplateFileInfo(
-  config: ScaffoldConfig,
-  { templatePath, basePath }: { templatePath: string; basePath: string },
-): Promise<OutputFileInfo> {
-  const inputPath = path.resolve(process.cwd(), templatePath)
-  const outputPathOpt = getOptionValueForFile(config, inputPath, config.output)
-  const outputDir = getOutputDir(config, outputPathOpt, basePath)
-  const outputPath = handlebarsParse(config, path.join(outputDir, path.basename(inputPath)), {
-    isPath: true,
-  }).toString()
-  const exists = await pathExists(outputPath)
-  return { inputPath, outputPathOpt, outputDir, outputPath, exists }
-}
-
-export async function copyFileTransformed(
-  config: ScaffoldConfig,
-  {
-    exists,
-    overwrite,
-    outputPath,
-    inputPath,
-  }: {
-    exists: boolean
-    overwrite: boolean
-    outputPath: string
-    inputPath: string
-  },
-): Promise<void> {
-  if (!exists || overwrite) {
-    if (exists && overwrite) {
-      log(config, LogLevel.Info, `File ${outputPath} exists, overwriting`)
-    }
-    const templateBuffer = await readFile(inputPath)
-    const unprocessedOutputContents = handlebarsParse(config, templateBuffer)
-    const finalOutputContents =
-      (await config.beforeWrite?.(unprocessedOutputContents, templateBuffer, outputPath)) ?? unprocessedOutputContents
-
-    if (!config.dryRun) {
-      await writeFile(outputPath, finalOutputContents)
-      log(config, LogLevel.Info, "Done.")
-    } else {
-      log(config, LogLevel.Info, "Dry Run. Output should be:")
-      log(config, LogLevel.Info, finalOutputContents)
-    }
-  } else if (exists) {
-    log(config, LogLevel.Info, `File ${outputPath} already exists, skipping`)
-  }
-}
-
-export function getOutputDir(config: ScaffoldConfig, outputPathOpt: string, basePath: string): string {
-  return path.resolve(
-    process.cwd(),
-    ...([
-      outputPathOpt,
-      basePath,
-      config.createSubFolder
-        ? config.subFolderNameHelper
-          ? handlebarsParse(config, `{{ ${config.subFolderNameHelper} name }}`).toString()
-          : config.name
-        : undefined,
-    ].filter(Boolean) as string[]),
-  )
-}
-
-export async function handleTemplateFile(
-  config: ScaffoldConfig,
-  { templatePath, basePath }: { templatePath: string; basePath: string },
-): Promise<void> {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const { inputPath, outputPathOpt, outputDir, outputPath, exists } = await getTemplateFileInfo(config, {
-        templatePath,
-        basePath,
-      })
-      const overwrite = getOptionValueForFile(config, inputPath, config.overwrite ?? false)
-
-      log(
-        config,
-        LogLevel.Debug,
-        `\nParsing ${templatePath}`,
-        `\nBase path: ${basePath}`,
-        `\nFull input path: ${inputPath}`,
-        `\nOutput Path Opt: ${outputPathOpt}`,
-        `\nFull output dir: ${outputDir}`,
-        `\nFull output path: ${outputPath}`,
-        `\n`,
-      )
-
-      await createDirIfNotExists(path.dirname(outputPath), config)
-
-      log(config, LogLevel.Info, `Writing to ${outputPath}`)
-      await copyFileTransformed(config, { exists, overwrite, outputPath, inputPath })
-      resolve()
-    } catch (e: any) {
-      handleErr(e)
-      reject(e)
-    }
-  })
-}

src/logger.ts

@@ -1,65 +0,0 @@
-import { LogConfig, LogLevel, ScaffoldConfig } from "./types"
-import chalk from "chalk"
-
-export function log(config: LogConfig, level: LogLevel, ...obj: any[]): void {
-  if (config.quiet || config.verbose === LogLevel.None || level < (config.verbose ?? LogLevel.Info)) {
-    return
-  }
-
-  const levelColor: Record<LogLevel, keyof typeof chalk> = {
-    [LogLevel.None]: "reset",
-    [LogLevel.Debug]: "blue",
-    [LogLevel.Info]: "dim",
-    [LogLevel.Warning]: "yellow",
-    [LogLevel.Error]: "red",
-  }
-
-  const chalkFn: any = chalk[levelColor[level]]
-  const key: "log" | "warn" | "error" = level === LogLevel.Error ? "error" : level === LogLevel.Warning ? "warn" : "log"
-  const logFn: any = console[key]
-  logFn(
-    ...obj.map((i) =>
-      i instanceof Error
-        ? chalkFn(i, JSON.stringify(i, undefined, 1), i.stack)
-        : typeof i === "object"
-        ? chalkFn(JSON.stringify(i, undefined, 1))
-        : chalkFn(i),
-    ),
-  )
-}
-
-export function logInputFile(
-  config: ScaffoldConfig,
-  data: {
-    originalTemplate: string
-    relativePath: string
-    parsedTemplate: string
-    inputFilePath: string
-    nonGlobTemplate: string
-    basePath: string
-    isDirOrGlob: boolean
-    isGlob: boolean
-  },
-): void {
-  log(config, LogLevel.Debug, data)
-}
-
-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,
-    subFolderNameHelper: 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!,
-    )})`,
-    dryRun: config.dryRun,
-    beforeWrite: config.beforeWrite,
-  } as Record<keyof ScaffoldConfig, unknown>)
-  log(config, LogLevel.Info, "Data:", config.data)
-}

src/parser.ts

@@ -1,126 +0,0 @@
-import path from "path"
-import { DefaultHelpers, Helper, LogLevel, ScaffoldConfig } from "./types"
-import Handlebars from "handlebars"
-import dtAdd from "date-fns/add"
-import dtFormat from "date-fns/format"
-import dtParseISO from "date-fns/parseISO"
-import { log } from "./logger"
-
-const dateFns = {
-  add: dtAdd,
-  format: dtFormat,
-  parseISO: dtParseISO,
-}
-
-export const defaultHelpers: Record<DefaultHelpers, Helper> = {
-  camelCase,
-  snakeCase,
-  startCase,
-  kebabCase,
-  hyphenCase: kebabCase,
-  pascalCase,
-  lowerCase: (text) => text.toLowerCase(),
-  upperCase: (text) => text.toUpperCase(),
-  now: nowHelper,
-  date: dateHelper,
-}
-
-function _dateHelper(date: Date, formatString: string): string
-function _dateHelper(date: Date, formatString: string, durationDifference: number, durationType: keyof Duration): string
-function _dateHelper(
-  date: Date,
-  formatString: string,
-  durationDifference?: number,
-  durationType?: keyof Duration,
-): string {
-  if (durationType && durationDifference !== undefined) {
-    return dateFns.format(dateFns.add(date, { [durationType]: durationDifference }), formatString)
-  }
-  return dateFns.format(date, formatString)
-}
-
-export function nowHelper(formatString: string): string
-export function nowHelper(formatString: string, durationDifference: number, durationType: keyof Duration): string
-export function nowHelper(formatString: string, durationDifference?: number, durationType?: keyof Duration): string {
-  return _dateHelper(new Date(), formatString, durationDifference!, durationType!)
-}
-
-export function dateHelper(date: string, formatString: string): string
-export function dateHelper(
-  date: string,
-  formatString: string,
-  durationDifference: number,
-  durationType: keyof Duration,
-): string
-export function dateHelper(
-  date: string,
-  formatString: string,
-  durationDifference?: number,
-  durationType?: keyof Duration,
-): string {
-  return _dateHelper(dateFns.parseISO(date), formatString, durationDifference!, durationType!)
-}
-
-// splits by either non-alpha character or capital letter
-function toWordParts(string: string): string[] {
-  return string.split(/(?=[A-Z])|[^a-zA-Z]/).filter((s) => s.length > 0)
-}
-
-function camelCase(s: string): string {
-  return toWordParts(s).reduce((acc, part, i) => {
-    if (i === 0) {
-      return part.toLowerCase()
-    }
-    return acc + part[0].toUpperCase() + part.slice(1).toLowerCase()
-  }, "")
-}
-
-function snakeCase(s: string): string {
-  return toWordParts(s).join("_").toLowerCase()
-}
-
-function kebabCase(s: string): string {
-  return toWordParts(s).join("-").toLowerCase()
-}
-
-function startCase(s: string): string {
-  return toWordParts(s)
-    .map((part) => part[0].toUpperCase() + part.slice(1).toLowerCase())
-    .join(" ")
-}
-
-function pascalCase(s: string): string {
-  return startCase(s).replace(/\s+/g, "")
-}
-
-export function registerHelpers(config: ScaffoldConfig): void {
-  const _helpers = { ...defaultHelpers, ...config.helpers }
-  for (const helperName in _helpers) {
-    log(config, LogLevel.Debug, `Registering helper: ${helperName}`)
-    Handlebars.registerHelper(helperName, _helpers[helperName as keyof typeof _helpers])
-  }
-}
-
-export function handlebarsParse(
-  config: ScaffoldConfig,
-  templateBuffer: Buffer | string,
-  { isPath = false }: { isPath?: boolean } = {},
-): Buffer {
-  const { data } = config
-  try {
-    let str = templateBuffer.toString()
-    if (isPath) {
-      str = str.replace(/\\/g, "/")
-    }
-    const parser = Handlebars.compile(str, { noEscape: true })
-    let outputContents = parser(data)
-    if (isPath && path.sep !== "/") {
-      outputContents = outputContents.replace(/\//g, "\\")
-    }
-    return Buffer.from(outputContents)
-  } catch (e) {
-    log(config, LogLevel.Debug, e)
-    log(config, LogLevel.Warning, "Couldn't parse file with handlebars, returning original content")
-    return Buffer.from(templateBuffer)
-  }
-}

src/scaffold.ts

@@ -1,138 +1,162 @@
-/**
- * @module
- * Simple Scaffold
- *
- * See [readme](README.md)
- */
+import { glob } from "glob"
 import path from "path"
-import { handleErr, resolve } from "./utils"
+import { promisify } from "util"
+import { promises as fsPromises } from "fs"
+const { readFile, writeFile } = fsPromises
+
 import {
+  createDirIfNotExists,
+  getOptionValueForFile,
+  handleErr,
+  handlebarsParse,
+  log,
+  pathExists,
+  pascalCase,
   isDir,
   removeGlob,
   makeRelativePath,
-  getTemplateGlobInfo,
-  getFileList,
-  getBasePath,
-  handleTemplateFile,
-} from "./file"
-import { LogLevel, MinimalConfig, Resolver, ScaffoldCmdConfig, ScaffoldConfig } from "./types"
-import { OptionsBase } from "massarg/types"
-import { defaultHelpers, registerHelpers } from "./parser"
-import { log, logInitStep, logInputFile } from "./logger"
-import { parseConfig } from "./config"
+  registerHelpers,
+} from "./utils"
+import { LogLevel, ScaffoldConfig } from "./types"
 
-/**
- * Create a scaffold using given `options`.
- *
- * #### Create files
- * To create a file structure to output, use any directory and file structure you would like.
- * Inside folder names, file names or file contents, you may place `{{ var }}` where `var` is either
- * `name` which is the scaffold name you provided or one of the keys you provided in the `data` option.
- *
- * The contents and names will be replaced with the transformed values so you can use your original structure as a
- * boilerplate for other projects, components, modules, or even single files.
- *
- * The files will maintain their structure, starting from the directory containing the template (or the template itself
- * if it is already a directory), and will output from that directory into the directory defined by `config.output`.
- *
- * #### Helpers
- * Helpers are functions you can use to transform your `{{ var }}` contents into other values without having to
- * pre-define the data and use a duplicated key.
- *
- * Any functions you provide in `helpers` option will also be available to you to make custom formatting as you see fit
- * (for example, formatting a date)
- *
- * For available default values, see {@link DefaultHelpers}.
- *
- * @param {ScaffoldConfig} config The main configuration object
- * @return {Promise<void>} A promise that resolves when the scaffold is complete
- *
- * @see {@link DefaultHelpers}
- * @see {@link CaseHelpers}
- * @see {@link DateHelpers}
- *
- * @category Main
- */
-export async function Scaffold(config: ScaffoldConfig): Promise<void> {
-  config.output ??= process.cwd()
-
-  registerHelpers(config)
+export async function Scaffold(config: ScaffoldConfig) {
+  const options = { ...config }
   try {
-    config.data = { name: config.name, Name: defaultHelpers.pascalCase(config.name), ...config.data }
-    logInitStep(config)
-    for (let _template of config.templates) {
+    const data = { name: options.name, Name: pascalCase(options.name), ...options.data }
+    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,
+      helpers: Object.keys(options.helpers ?? {}),
+      verbose: `${options.verbose} (${Object.keys(LogLevel).find(
+        (k) => (LogLevel[k as any] as unknown as number) === options.verbose!
+      )})`,
+    })
+    log(options, LogLevel.Info, "Data:", data)
+    for (let template of config.templates) {
       try {
-        const { nonGlobTemplate, origTemplate, isDirOrGlob, isGlob, template } = await getTemplateGlobInfo(
-          config,
-          _template,
-        )
-        const files = await getFileList(config, template)
+        registerHelpers(options)
+        const _isGlob = template.includes("*")
+        if (!_isGlob && !(await pathExists(template))) {
+          const err: NodeJS.ErrnoException = new Error(`ENOENT, no such file or directory ${template}`)
+          err.code = "ENOENT"
+          err.path = "non-existing-input"
+          err.errno = -2
+          throw err
+        }
+        const _nonGlobTemplate = _isGlob ? removeGlob(template) : template
+        log(options, LogLevel.Debug, "before isDir", "isGlob:", _isGlob, template)
+        const _isDir = _isGlob ? true : await isDir(template)
+        log(options, LogLevel.Debug, "after isDir", _isDir)
+        const _shouldAddGlob = !_isGlob && _isDir
+        const origTemplate = template
+        if (_shouldAddGlob) {
+          template = template + "/**/*"
+        }
+        log(options, LogLevel.Debug, "before glob")
+        const files = await promisify(glob)(template, {
+          dot: true,
+          debug: false,
+          nodir: options.verbose === LogLevel.Debug,
+          nobrace: true,
+          noext: true,
+          nocomment: true,
+          nonegate: true,
+        })
+        log(options, LogLevel.Debug, "after glob")
         for (const inputFilePath of files) {
-          if (await isDir(inputFilePath)) {
-            continue
+          if (!(await isDir(inputFilePath))) {
+            const relPath = makeRelativePath(path.dirname(removeGlob(inputFilePath).replace(_nonGlobTemplate, "")))
+            const basePath = path
+              .resolve(process.cwd(), relPath)
+              .replace(process.cwd() + "/", "")
+              .replace(process.cwd(), "")
+            log(
+              options,
+              LogLevel.Debug,
+              `\nprocess.cwd(): ${process.cwd()}`,
+              `\norigTemplate: ${origTemplate}`,
+              `\nrelPath: ${relPath}`,
+              `\ntemplate: ${template}`,
+              `\ninputFilePath: ${inputFilePath}`,
+              `\nnonGlobTemplate: ${_nonGlobTemplate}`,
+              `\nbasePath: ${basePath}`,
+              `\nisDir: ${_isDir}`,
+              `\nisGlob: ${_isGlob}`,
+              `\n`
+            )
+            await handleTemplateFile(inputFilePath, basePath, options, data)
           }
-          const relPath = makeRelativePath(path.dirname(removeGlob(inputFilePath).replace(nonGlobTemplate, "")))
-          const basePath = getBasePath(relPath)
-          logInputFile(config, {
-            originalTemplate: origTemplate,
-            relativePath: relPath,
-            parsedTemplate: template,
-            inputFilePath,
-            nonGlobTemplate,
-            basePath,
-            isDirOrGlob,
-            isGlob,
-          })
-          await handleTemplateFile(config, {
-            templatePath: inputFilePath,
-            basePath,
-          })
         }
       } catch (e: any) {
         handleErr(e)
       }
     }
   } catch (e: any) {
-    log(config, LogLevel.Error, e)
+    log(options, LogLevel.Error, e)
     throw e
   }
 }
 
-/**
- * Create a scaffold based on a config file or URL.
- *
- * @param {string} pathOrUrl The path or URL to the config file
- * @param {Record<string, string>} config Information needed before loading the config
- * @param {Partial<Omit<ScaffoldConfig, 'name'>>} overrides Any overrides to the loaded config
- *
- * @see {@link Scaffold}
- * @category Main
- * @return {Promise<void>} A promise that resolves when the scaffold is complete
- */
-Scaffold.fromConfig = async function(
-  /** The path or URL to the config file */
-  pathOrUrl: string,
-  /** Information needed before loading the config */
-  config: MinimalConfig,
-  /** Any overrides to the loaded config */
-  overrides?: Resolver<ScaffoldCmdConfig, Partial<Omit<ScaffoldConfig, "name">>>,
+async function handleTemplateFile(
+  templatePath: string,
+  basePath: string,
+  options: ScaffoldConfig,
+  data: Record<string, string>
 ): Promise<void> {
-  const _cmdConfig: ScaffoldCmdConfig & OptionsBase = {
-    dryRun: false,
-    output: process.cwd(),
-    verbose: LogLevel.Info,
-    overwrite: false,
-    templates: [],
-    createSubFolder: false,
-    quiet: false,
-    help: false,
-    extras: [],
-    config: pathOrUrl,
-    ...config,
-  }
-  const _overrides = resolve(overrides, _cmdConfig)
-  const _config = await parseConfig(_cmdConfig)
-  return Scaffold({ ..._config, ..._overrides })
+  return new Promise(async (resolve, reject) => {
+    try {
+      const inputPath = path.resolve(process.cwd(), templatePath)
+      const outputPathOpt = getOptionValueForFile(inputPath, data, options.output)
+      const outputDir = path.resolve(
+        process.cwd(),
+        ...([outputPathOpt, basePath, options.createSubFolder ? options.name : undefined].filter(Boolean) as string[])
+      )
+      const outputPath = handlebarsParse(path.join(outputDir, path.basename(inputPath)), data)
+      log(
+        options,
+        LogLevel.Debug,
+        `\nParsing ${templatePath}`,
+        `\nBase path: ${basePath}`,
+        `\nFull input path: ${inputPath}`,
+        `\nOutput Path Opt: ${outputPathOpt}`,
+        `\nFull output dir: ${outputDir}`,
+        `\nFull output path: ${outputPath}`,
+        `\n`
+      )
+      const overwrite = getOptionValueForFile(inputPath, data, options.overwrite ?? false)
+      const exists = await pathExists(outputPath)
+
+      await createDirIfNotExists(path.dirname(outputPath), options)
+
+      log(options, LogLevel.Info, `Writing to ${outputPath}`)
+      if (!exists || overwrite) {
+        if (exists && overwrite) {
+          log(options, LogLevel.Info, `File ${outputPath} exists, overwriting`)
+        }
+        const templateBuffer = await readFile(inputPath)
+        const outputContents = handlebarsParse(templateBuffer, data)
+
+        if (!options.dryRun) {
+          await writeFile(outputPath, outputContents)
+          log(options, LogLevel.Info, "Done.")
+        } else {
+          log(options, LogLevel.Info, "Content output:")
+          log(options, LogLevel.Info, outputContents)
+        }
+      } else if (exists) {
+        log(options, LogLevel.Info, `File ${outputPath} already exists, skipping`)
+      }
+      resolve()
+    } catch (e: any) {
+      handleErr(e)
+      reject(e)
+    }
+  })
 }
 
 export default Scaffold

src/types.ts

@@ -1,16 +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>
 
-/**
- * The config object for defining a scaffolding group.
- *
- * @see {@link https://chenasraf.github.io/simple-scaffold/pages/node.html | Node.js usage}
- * @see {@link https://chenasraf.github.io/simple-scaffold/pages/cli.html | CLI usage}
- * @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
@@ -20,77 +19,46 @@ 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.
-   *
-   * May also be a {@link FileResponseHandler} which returns a new output path to override the default one.
-   *
-   * @see {@link FileResponse}
-   * @see {@link FileResponseHandler}
-   */
+  /** Path to output to. If `createSubFolder` is `true`, the subfolder will be created inside this path. */
   output: FileResponse<string>
 
   /**
-   * Whether to create subfolder with the input name.
-   *
-   * When `true`, you may also use {@link subFolderNameHelper} to determine a pre-process helper on
-   * the directory name.
-   *
-   * @default `false`
+   * Create subfolder with the input name (default: `false`)
    */
   createSubFolder?: boolean
 
   /**
    * Add custom data to the templates. By default, only your app name is included as `{{name}}` and `{{Name}}`.
-   *
-   * This can be any object that will be usable by Handlebars.
    */
-  data?: Record<string, any>
+  data?: Record<string, string>
 
   /**
-   * Enable to override output files, even if they already exist.
+   * Enable to override output files, even if they already exist. (default: `false`)
    *
    * You may supply a function to this option, which can take the arguments `(fullPath, baseDir, baseName)` and returns
-   * a boolean for each file.
-   *
-   * May also be a {@link FileResponseHandler} which returns a boolean value per file.
-   *
-   * @see {@link FileResponse}
-   * @see {@link FileResponseHandler}
-   *
-   * @default `false`
+   * a string, to return a dynamic path for each file.
    */
   overwrite?: FileResponse<boolean>
 
-  /**
-   * Suppress output logs (Same as `verbose: 0` or `verbose: LogLevel.None`)
-   *  @see {@link verbose}
-   */
+  /** Suppress output logs (Same as `verbose: 0` or `verbose: LogLevel.None`) */
   quiet?: boolean
 
   /**
    * Determine amount of logs to display.
    *
    * The values are: `0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`. The provided level will display messages
-   * of the same level or higher.
-   *
-   * @see {@link LogLevel}
-   *
-   * @default `2 (info)`
+   * of the same level or higher. (default: `2 (info)`)
+   * @see LogLevel
    */
   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
 
@@ -98,7 +66,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, ...args: any[]) => string
+   * (text: string) => string
    * ```
    *
    * A full example might be:
@@ -107,276 +75,21 @@ export interface ScaffoldConfig {
    * Scaffold({
    *   //...
    *   helpers: {
-   *     upperKebabCase: (text) => kebabCase(text).toUpperCase()
+   *     upperCamelCase: (text) => camelCase(text).toUpperCase()
    *   }
    * })
    * ```
-   *
-   * 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 {@link https://chenasraf.github.io/simple-scaffold/pages/templates.html | Templates}
-   * */
-  helpers?: Record<string, Helper>
-
-  /**
-   * Default transformer to apply to subfolder name when using `createSubFolder: true`. Can be one of the default
-   * capitalization helpers, or a custom one you provide to `helpers`. Defaults to `undefined`, which means no
-   * transformation is done.
-   *
-   * @see {@link createSubFolder}
-   * @see {@link CaseHelpers}
-   * @see {@link DefaultHelpers}
    */
-  subFolderNameHelper?: DefaultHelpers | string
-
-  /**
-   * This callback runs right before content is being written to the disk. If you supply this function, you may return
-   * a string that represents the final content of your file, you may process the content as you see fit. For example,
-   * you may run formatters on a file, fix output in edge-cases not supported by helpers or data, etc.
-   *
-   * If the return value of this function is `undefined`, the original content will be used.
-   *
-   * @param content The original template after token replacement
-   * @param rawContent The original template before token replacement
-   * @param outputPath The final output path of the processed file
-   *
-   * @returns {Promise<String | Buffer | undefined> | String | Buffer | undefined} The final output of the file
-   * contents-only, after further modifications - or `undefined` to use the original content (i.e. `content.toString()`)
-   */
-  beforeWrite?(
-    content: Buffer,
-    rawContent: Buffer,
-    outputPath: string,
-  ): string | Buffer | undefined | Promise<string | Buffer | undefined>
+  helpers?: Record<string, (text: string) => string>
 }
-
-/**
- * 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 ScaffoldConfig.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 to be passed to the generated files. `{{name}}` and `{{Name}}` inside contents and file names will be replaced
-   * accordingly.
-   */
   name: string
   templates: string[]
   output: string
   createSubFolder: boolean
   data?: Record<string, string>
-  appendData?: Record<string, string>
   overwrite: boolean
   quiet: boolean
   verbose: LogLevel
   dryRun: boolean
-  config?: string
-  /** The key to use for the file which contains the template configurations. */
-  key?: string
-  github?: string
 }
-
-/**
- * A mapping of scaffold template keys to their configurations.
- *
- * Each configuration is a {@link ScaffoldConfig} object.
- *
- * The key is the name of the template, and the value is the configuration for that template.
- *
- * When no template key is provided to the scaffold command, the "default" template is used.
- *
- * @see {@link ScaffoldConfig}
- */
-export type ScaffoldConfigMap = Record<string, ScaffoldConfig>
-
-/** The scaffold config file is either:
- * - A {@link ScaffoldConfigMap} object
- * - A function that returns a {@link ScaffoldConfigMap} object
- * - A promise that resolves to a {@link ScaffoldConfigMap} object
- * - A function that returns a promise that resolves to a {@link ScaffoldConfigMap} object
- */
-export type ScaffoldConfigFile = AsyncResolver<ScaffoldCmdConfig, ScaffoldConfigMap>
-
-/** @internal */
-export type Resolver<T, R = T> = R | ((value: T) => R)
-
-/** @internal */
-export type AsyncResolver<T, R = T> = Resolver<T, Promise<R> | R>
-
-/** @internal */
-export type LogConfig = Pick<ScaffoldConfig, "quiet" | "verbose">
-
-/** @internal */
-export type ConfigLoadConfig = LogConfig & Pick<ScaffoldCmdConfig, "config">
-
-/** @internal */
-export type MinimalConfig = Pick<ScaffoldCmdConfig, "name" | "key">

src/utils.ts

@@ -1,9 +1,131 @@
-import { Resolver } from "./types"
+import path from "path"
+import { F_OK } from "constants"
+import { FileResponse, FileResponseFn, LogLevel, ScaffoldConfig } from "./types"
+import camelCase from "lodash/camelCase"
+import snakeCase from "lodash/snakeCase"
+import kebabCase from "lodash/kebabCase"
+import startCase from "lodash/startCase"
+import Handlebars from "handlebars"
+import { promises as fsPromises } from "fs"
+import chalk from "chalk"
+const { stat, access, mkdir } = fsPromises
 
-export function handleErr(err: NodeJS.ErrnoException | null): void {
+export const defaultHelpers: Exclude<ScaffoldConfig["helpers"], undefined> = {
+  camelCase,
+  snakeCase,
+  startCase,
+  kebabCase,
+  hyphenCase: kebabCase,
+  pascalCase,
+  lowerCase: (text) => text.toLowerCase(),
+  upperCase: (text) => text.toUpperCase(),
+}
+
+export function registerHelpers(options: ScaffoldConfig) {
+  const _helpers = { ...defaultHelpers, ...options.helpers }
+  for (const helperName in _helpers) {
+    log(options, LogLevel.Debug, `Registering helper: ${helperName}`)
+    Handlebars.registerHelper(helperName, _helpers[helperName as keyof typeof _helpers])
+  }
+}
+
+export function handleErr(err: NodeJS.ErrnoException | null) {
   if (err) throw err
 }
 
-export function resolve<T, R = T>(resolver: Resolver<T, R>, arg: T): R {
-  return typeof resolver === "function" ? (resolver as (value: T) => R)(arg) : (resolver as R)
+export function log(options: ScaffoldConfig, level: LogLevel, ...obj: any[]) {
+  if (options.quiet || options.verbose === LogLevel.None || level <= (options.verbose ?? LogLevel.Info)) {
+    return
+  }
+  const levelColor: Record<LogLevel, keyof typeof chalk> = {
+    [LogLevel.None]: "reset",
+    [LogLevel.Debug]: "blue",
+    [LogLevel.Info]: "dim",
+    [LogLevel.Warning]: "yellow",
+    [LogLevel.Error]: "red",
+  }
+  const chalkFn: any = chalk[levelColor[level]]
+  const key: "log" | "warn" | "error" = level === LogLevel.Error ? "error" : level === LogLevel.Warning ? "warn" : "log"
+  const logFn: any = console[key]
+  logFn(
+    ...obj.map((i) =>
+      i instanceof Error
+        ? chalkFn(i, JSON.stringify(i, undefined, 1), i.stack)
+        : typeof i === "object"
+        ? chalkFn(JSON.stringify(i, undefined, 1))
+        : chalkFn(i)
+    )
+  )
+}
+
+export async function createDirIfNotExists(dir: string, options: ScaffoldConfig): Promise<void> {
+  const parentDir = path.dirname(dir)
+
+  if (!(await pathExists(parentDir))) {
+    await createDirIfNotExists(parentDir, options)
+  }
+
+  if (!(await pathExists(dir))) {
+    try {
+      log(options, LogLevel.Debug, `Creating dir ${dir}`)
+      await mkdir(dir)
+      return
+    } catch (e: any) {
+      if (e.code !== "EEXIST") {
+        throw e
+      }
+      return
+    }
+  }
+}
+
+export function getOptionValueForFile<T>(
+  filePath: string,
+  data: Record<string, string>,
+  fn: FileResponse<T>,
+  defaultValue?: T
+): T {
+  if (typeof fn !== "function") {
+    return defaultValue ?? (fn as T)
+  }
+  return (fn as FileResponseFn<T>)(
+    filePath,
+    path.dirname(handlebarsParse(filePath, data)),
+    path.basename(handlebarsParse(filePath, data))
+  )
+}
+
+export function handlebarsParse(templateBuffer: Buffer | string, data: Record<string, string>) {
+  const parser = Handlebars.compile(templateBuffer.toString(), { noEscape: true })
+  const outputContents = parser(data)
+  return outputContents
+}
+
+export async function pathExists(filePath: string): Promise<boolean> {
+  try {
+    await access(filePath, F_OK)
+    return true
+  } catch (e: any) {
+    if (e.code === "ENOENT") {
+      return false
+    }
+    throw e
+  }
+}
+
+export function pascalCase(s: string): string {
+  return startCase(s).replace(/\s+/g, "")
+}
+
+export async function isDir(path: string): Promise<boolean> {
+  const tplStat = await stat(path)
+  return tplStat.isDirectory()
+}
+
+export function removeGlob(template: string) {
+  return template.replace(/\*/g, "").replace(/\/\//g, "/")
+}
+
+export function makeRelativePath(str: string): string {
+  return str.startsWith("/") ? str.slice(1) : str
 }

tests/config.test.ts

@@ -1,61 +0,0 @@
-import { ScaffoldCmdConfig } from "../src/types"
-import { OptionsBase } from "massarg/types"
-import { githubPartToUrl, parseAppendData, parseConfigSelection } from "../src/config"
-
-const blankCliConf: ScaffoldCmdConfig & OptionsBase = {
-  verbose: 0,
-  name: "",
-  output: "",
-  templates: [],
-  data: { name: "test" },
-  overwrite: false,
-  createSubFolder: false,
-  dryRun: false,
-  quiet: false,
-  extras: [],
-  help: false,
-}
-
-describe("config", () => {
-  describe("parseAppendData", () => {
-    test('works for "key=value"', () => {
-      expect(parseAppendData("key=value", blankCliConf)).toEqual({ key: "value", name: "test" })
-    })
-
-    test('works for "key:=value"', () => {
-      expect(parseAppendData("key:=123", blankCliConf)).toEqual({ key: 123, name: "test" })
-    })
-
-    test("overwrites existing value", () => {
-      expect(parseAppendData("name:=123", blankCliConf)).toEqual({ name: 123 })
-    })
-
-    test("works with quotes", () => {
-      expect(parseAppendData('key="value test"', blankCliConf)).toEqual({ key: "value test", name: "test" })
-    })
-  })
-  describe("githubPartToUrl", () => {
-    test("works", () => {
-      expect(githubPartToUrl("chenasraf/simple-scaffold")).toEqual("https://github.com/chenasraf/simple-scaffold.git")
-      expect(githubPartToUrl("chenasraf/simple-scaffold.git")).toEqual(
-        "https://github.com/chenasraf/simple-scaffold.git",
-      )
-    })
-  })
-  describe("parseConfigSelection", () => {
-    test("works", () => {
-      expect(parseConfigSelection("scaffold.config.js", "component")).toEqual({
-        configFile: "scaffold.config.js",
-        key: "component",
-      })
-      expect(parseConfigSelection("scaffold.config.js:component", "main")).toEqual({
-        configFile: "scaffold.config.js",
-        key: "main",
-      })
-      expect(parseConfigSelection("scaffold.config.js", "main")).toEqual({
-        configFile: "scaffold.config.js",
-        key: "main",
-      })
-    })
-  })
-})

tests/parser.test.ts

@@ -1,148 +0,0 @@
-import { ScaffoldCmdConfig, ScaffoldConfig } from "../src/types"
-import path from "path"
-import * as dateFns from "date-fns"
-import { OptionsBase } from "massarg/types"
-import { dateHelper, defaultHelpers, handlebarsParse, nowHelper } from "../src/parser"
-
-const blankConf: ScaffoldConfig = {
-  verbose: 0,
-  name: "",
-  output: "",
-  templates: [],
-  data: { name: "test" },
-}
-
-const blankCliConf: ScaffoldCmdConfig & OptionsBase = {
-  verbose: 0,
-  name: "",
-  output: "",
-  templates: [],
-  data: { name: "test" },
-  overwrite: false,
-  createSubFolder: false,
-  dryRun: false,
-  quiet: false,
-  extras: [],
-  help: false,
-}
-
-describe("parser", () => {
-  describe("handlebarsParse", () => {
-    let origSep: any
-    describe("windows paths", () => {
-      beforeAll(() => {
-        origSep = path.sep
-        Object.defineProperty(path, "sep", { value: "\\" })
-      })
-      afterAll(() => {
-        Object.defineProperty(path, "sep", { value: origSep })
-      })
-      test("should work for windows paths", async () => {
-        expect(handlebarsParse(blankConf, "C:\\exports\\{{name}}.txt", { isPath: true })).toEqual(
-          Buffer.from("C:\\exports\\test.txt"),
-        )
-      })
-    })
-    describe("non-windows paths", () => {
-      beforeAll(() => {
-        origSep = path.sep
-        Object.defineProperty(path, "sep", { value: "/" })
-      })
-      afterAll(() => {
-        Object.defineProperty(path, "sep", { value: origSep })
-      })
-      test("should work for non-windows paths", async () => {
-        expect(handlebarsParse(blankConf, "/home/test/{{name}}.txt", { isPath: true })).toEqual(
-          Buffer.from("/home/test/test.txt"),
-        )
-      })
-    })
-    test("should not do path escaping on non-path compiles", async () => {
-      expect(
-        handlebarsParse(
-          { ...blankConf, data: { ...blankConf.data, escaped: "value" } },
-          "/home/test/{{name}} \\{{escaped}}.txt",
-          {
-            isPath: false,
-          },
-        ),
-      ).toEqual(Buffer.from("/home/test/test {{escaped}}.txt"))
-    })
-  })
-
-  describe("Helpers", () => {
-    describe("string helpers", () => {
-      test("camelCase", () => {
-        expect(defaultHelpers.camelCase("test string")).toEqual("testString")
-        expect(defaultHelpers.camelCase("test_string")).toEqual("testString")
-        expect(defaultHelpers.camelCase("test-string")).toEqual("testString")
-        expect(defaultHelpers.camelCase("testString")).toEqual("testString")
-        expect(defaultHelpers.camelCase("TestString")).toEqual("testString")
-        expect(defaultHelpers.camelCase("Test____String")).toEqual("testString")
-      })
-      test("pascalCase", () => {
-        expect(defaultHelpers.pascalCase("test string")).toEqual("TestString")
-        expect(defaultHelpers.pascalCase("test_string")).toEqual("TestString")
-        expect(defaultHelpers.pascalCase("test-string")).toEqual("TestString")
-        expect(defaultHelpers.pascalCase("testString")).toEqual("TestString")
-        expect(defaultHelpers.pascalCase("TestString")).toEqual("TestString")
-        expect(defaultHelpers.pascalCase("Test____String")).toEqual("TestString")
-      })
-      test("snakeCase", () => {
-        expect(defaultHelpers.snakeCase("test string")).toEqual("test_string")
-        expect(defaultHelpers.snakeCase("test_string")).toEqual("test_string")
-        expect(defaultHelpers.snakeCase("test-string")).toEqual("test_string")
-        expect(defaultHelpers.snakeCase("testString")).toEqual("test_string")
-        expect(defaultHelpers.snakeCase("TestString")).toEqual("test_string")
-        expect(defaultHelpers.snakeCase("Test____String")).toEqual("test_string")
-      })
-      test("kebabCase", () => {
-        expect(defaultHelpers.kebabCase("test string")).toEqual("test-string")
-        expect(defaultHelpers.kebabCase("test_string")).toEqual("test-string")
-        expect(defaultHelpers.kebabCase("test-string")).toEqual("test-string")
-        expect(defaultHelpers.kebabCase("testString")).toEqual("test-string")
-        expect(defaultHelpers.kebabCase("TestString")).toEqual("test-string")
-        expect(defaultHelpers.kebabCase("Test____String")).toEqual("test-string")
-      })
-      test("startCase", () => {
-        expect(defaultHelpers.startCase("test string")).toEqual("Test String")
-        expect(defaultHelpers.startCase("test_string")).toEqual("Test String")
-        expect(defaultHelpers.startCase("test-string")).toEqual("Test String")
-        expect(defaultHelpers.startCase("testString")).toEqual("Test String")
-        expect(defaultHelpers.startCase("TestString")).toEqual("Test String")
-        expect(defaultHelpers.startCase("Test____String")).toEqual("Test String")
-      })
-    })
-    describe("date helpers", () => {
-      describe("now", () => {
-        test("should work without extra params", () => {
-          const now = new Date()
-          const fmt = "yyyy-MM-dd HH:mm"
-
-          expect(nowHelper(fmt)).toEqual(dateFns.format(now, fmt))
-        })
-      })
-
-      describe("date", () => {
-        test("should work with no offset params", () => {
-          const now = new Date()
-          const fmt = "yyyy-MM-dd HH:mm"
-
-          expect(dateHelper(now.toISOString(), fmt)).toEqual(dateFns.format(now, fmt))
-        })
-
-        test("should work with offset params", () => {
-          const now = new Date()
-          const fmt = "yyyy-MM-dd HH:mm"
-
-          expect(dateHelper(now.toISOString(), fmt, -1, "days")).toEqual(
-            dateFns.format(dateFns.add(now, { days: -1 }), fmt),
-          )
-          expect(dateHelper(now.toISOString(), fmt, 1, "months")).toEqual(
-            dateFns.format(dateFns.add(now, { months: 1 }), fmt),
-          )
-        })
-      })
-    })
-  })
-})

tests/scaffold.test.ts

@@ -3,10 +3,7 @@ import FileSystem from "mock-fs/lib/filesystem"
 import Scaffold from "../src/scaffold"
 import { readdirSync, readFileSync } from "fs"
 import { Console } from "console"
-import { defaultHelpers } from "../src/parser"
-import { join } from "path"
-import * as dateFns from "date-fns"
-import crypto from "crypto"
+import { defaultHelpers } from "../src/utils"
 
 const fileStructNormal = {
   input: {
@@ -14,13 +11,6 @@ const fileStructNormal = {
   },
   output: {},
 }
-const fileStructWithBinary = {
-  input: {
-    "{{name}}.txt": "Hello, my app is {{name}}",
-    "{{name}}.bin": crypto.randomBytes(10000),
-  },
-  output: {},
-}
 
 const fileStructWithData = {
   input: {
@@ -41,19 +31,13 @@ const fileStructNested = {
   },
   output: {},
 }
-const fileStructSubdirTransformer = {
-  input: {
-    "{{name}}.txt": "Hello, my app is {{name}}",
-  },
-  output: {},
-}
 
 const defaultHelperNames = Object.keys(defaultHelpers)
 const fileStructHelpers = {
   input: {
     defaults: defaultHelperNames.reduce<Record<string, string>>(
       (all, cur) => ({ ...all, [cur + ".txt"]: `{{ ${cur} name }}` }),
-      {},
+      {}
     ),
     custom: {
       "add1.txt": "{{ add1 name }}",
@@ -61,16 +45,8 @@ const fileStructHelpers = {
   },
   output: {},
 }
-
-const fileStructDates = {
-  input: {
-    "now.txt": "Today is {{ now 'mmm' }}, time is {{ now 'HH:mm' }}",
-    "offset.txt": "Yesterday was {{ now 'mmm' -1 'days' }}, time is {{ now 'HH:mm' -1 'days' }}",
-    "custom.txt": "Custom date is {{ date customDate 'mmm' }}, time is {{ date customDate 'HH:mm' }}",
-  },
-  output: {},
-}
-
+// let logsTemp: any = []
+// let logMock: any
 function withMock(fileStruct: FileSystem.DirectoryItems, testFn: jest.EmptyFunction): jest.EmptyFunction {
   return () => {
     beforeEach(() => {
@@ -101,8 +77,8 @@ describe("Scaffold", () => {
           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 data = readFileSync(process.cwd() + "/output/app_name.txt")
+        expect(data.toString()).toBe("Hello, my app is app_name")
       })
 
       test("should create with config", async () => {
@@ -114,28 +90,10 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const data = readFileSync(join(process.cwd(), "output", "app_name", "app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my app is app_name")
+        const data = readFileSync(process.cwd() + "/output/app_name/app_name.txt")
+        expect(data.toString()).toBe("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(
@@ -158,8 +116,8 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my value is 1")
+        const data = readFileSync(process.cwd() + "/output/app_name.txt")
+        expect(data.toString()).toBe("Hello, my value is 1")
       })
 
       test("should overwrite with config", async () => {
@@ -180,10 +138,10 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my value is 2")
+        const data = readFileSync(process.cwd() + "/output/app_name.txt")
+        expect(data.toString()).toBe("Hello, my value is 2")
       })
-    }),
+    })
   )
 
   describe(
@@ -206,49 +164,12 @@ describe("Scaffold", () => {
             templates: ["non-existing-input"],
             data: { value: "1" },
             verbose: 0,
-          }),
+          })
         ).rejects.toThrow()
 
-        await expect(
-          Scaffold({
-            name: "app_name",
-            output: "output",
-            templates: ["non-existing-input/non-existing-file.txt"],
-            data: { value: "1" },
-            verbose: 0,
-          }),
-        ).rejects.toThrow()
-
-        expect(() => readFileSync(join(process.cwd(), "output", "app_name.txt"))).toThrow()
+        expect(() => readFileSync(process.cwd() + "/output/app_name.txt")).toThrow()
       })
-    }),
-  )
-
-  describe(
-    "dry run",
-    withMock(fileStructNormal, () => {
-      let consoleMock1: jest.SpyInstance
-      beforeAll(() => {
-        consoleMock1 = jest.spyOn(console, "error").mockImplementation(() => void 0)
-      })
-
-      afterAll(() => {
-        consoleMock1.mockRestore()
-      })
-
-      test("should not write to disk", async () => {
-        Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          data: { value: "1" },
-          verbose: 0,
-          dryRun: true,
-        })
-
-        expect(() => readFileSync(join(process.cwd(), "output", "app_name.txt"))).toThrow()
-      })
-    }),
+    })
   )
 
   describe(
@@ -257,15 +178,15 @@ describe("Scaffold", () => {
       test("should allow override function", async () => {
         await Scaffold({
           name: "app_name",
-          output: (fullPath, basedir, basename) => join("custom-output", `${basename.split(".")[0]}`),
+          output: (fullPath, basedir, basename) => `custom-output/${basename.split(".")[0]}`,
           templates: ["input"],
           data: { value: "1" },
           verbose: 0,
         })
-        const data = readFileSync(join(process.cwd(), "/custom-output/app_name/app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my app is app_name")
+        const data = readFileSync(process.cwd() + "/custom-output/app_name/app_name.txt")
+        expect(data.toString()).toBe("Hello, my app is app_name")
       })
-    }),
+    })
   )
 
   describe(
@@ -280,223 +201,75 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const rootDir = readdirSync(join(process.cwd(), "output"))
-        const dir = readdirSync(join(process.cwd(), "output", "AppName"))
-        const nestedDir = readdirSync(join(process.cwd(), "output", "AppName", "moreNesting"))
+        const rootDir = readdirSync(process.cwd() + "/output")
+        const dir = readdirSync(process.cwd() + "/output/AppName")
+        const nestedDir = readdirSync(process.cwd() + "/output/AppName/moreNesting")
         expect(rootDir).toHaveProperty("length")
         expect(dir).toHaveProperty("length")
         expect(nestedDir).toHaveProperty("length")
 
-        const rootFile = readFileSync(join(process.cwd(), "output", "app_name-1.txt"))
-        const oneDeepFile = readFileSync(join(process.cwd(), "output", "AppName/app_name-2.txt"))
-        const twoDeepFile = readFileSync(join(process.cwd(), "output", "AppName/moreNesting/app_name-3.txt"))
+        const rootFile = readFileSync(process.cwd() + "/output/app_name-1.txt")
+        const oneDeepFile = readFileSync(process.cwd() + "/output/AppName/app_name-2.txt")
+        const twoDeepFile = readFileSync(process.cwd() + "/output/AppName/moreNesting/app_name-3.txt")
         expect(rootFile.toString()).toEqual("This should be in root")
         expect(oneDeepFile.toString()).toEqual("Hello, my value is 1")
         expect(twoDeepFile.toString()).toEqual("Hi! My value is actually NOT 1!")
       })
-    }),
+    })
   )
 
   describe(
-    "capitalization helpers",
+    "helpers",
     withMock(fileStructHelpers, () => {
       const _helpers: Record<string, (text: string) => string> = {
         add1: (text) => text + " 1",
       }
 
-      test("should work", async () => {
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          verbose: 0,
-          helpers: _helpers,
+      describe("default helpers", () => {
+        test("should work", async () => {
+          await Scaffold({
+            name: "app_name",
+            output: "output",
+            templates: ["input"],
+            verbose: 0,
+            helpers: _helpers,
+          })
+
+          const results = {
+            camelCase: "appName",
+            snakeCase: "app_name",
+            startCase: "App Name",
+            kebabCase: "app-name",
+            hyphenCase: "app-name",
+            pascalCase: "AppName",
+            lowerCase: "app_name",
+            upperCase: "APP_NAME",
+          }
+          for (const key in results) {
+            const file = readFileSync(process.cwd() + `/output/defaults/${key}.txt`)
+            expect(file.toString()).toEqual(results[key as keyof typeof results])
+          }
         })
-
-        const results = {
-          camelCase: "appName",
-          snakeCase: "app_name",
-          startCase: "App Name",
-          kebabCase: "app-name",
-          hyphenCase: "app-name",
-          pascalCase: "AppName",
-          lowerCase: "app_name",
-          upperCase: "APP_NAME",
-        }
-        for (const key in results) {
-          const file = readFileSync(join(process.cwd(), "output", "defaults", `${key}.txt`))
-          expect(file.toString()).toEqual(results[key as keyof typeof results])
-        }
       })
-    }),
-  )
-  describe(
-    "date helpers",
-    withMock(fileStructDates, () => {
-      test("should work", async () => {
-        const now = new Date()
-        const yesterday = dateFns.add(new Date(), { days: -1 })
-        const customDate = dateFns.formatISO(dateFns.add(new Date(), { days: -1 }))
+      describe("custom helpers", () => {
+        test("should work", async () => {
+          await Scaffold({
+            name: "app_name",
+            output: "output",
+            templates: ["input"],
+            verbose: 0,
+            helpers: _helpers,
+          })
 
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          verbose: 0,
-          data: { customDate },
+          const results = {
+            add1: "app_name 1",
+          }
+          for (const key in results) {
+            const file = readFileSync(process.cwd() + `/output/custom/${key}.txt`)
+            expect(file.toString()).toEqual(results[key as keyof typeof results])
+          }
         })
-
-        const nowFile = readFileSync(join(process.cwd(), "output", "now.txt"))
-        const offsetFile = readFileSync(join(process.cwd(), "output", "offset.txt"))
-        const customFile = readFileSync(join(process.cwd(), "output", "custom.txt"))
-
-        // "now.txt": "Today is {{ now 'mmm' }}, time is {{ now 'HH:mm' }}",
-        // "offset.txt": "Yesterday was {{ now 'mmm' -1 'days' }}, time is {{ now 'HH:mm' -1 'days' }}",
-        // "custom.txt": "Custom date is {{ date customDate 'mmm' }}, time is {{ date customDate 'HH:mm' }}",
-
-        expect(nowFile.toString()).toEqual(
-          `Today is ${dateFns.format(now, "mmm")}, time is ${dateFns.format(now, "HH:mm")}`,
-        )
-        expect(offsetFile.toString()).toEqual(
-          `Yesterday was ${dateFns.format(yesterday, "mmm")}, time is ${dateFns.format(yesterday, "HH:mm")}`,
-        )
-        expect(customFile.toString()).toEqual(
-          `Custom date is ${dateFns.format(dateFns.parseISO(customDate), "mmm")}, time is ${dateFns.format(
-            dateFns.parseISO(customDate),
-            "HH:mm",
-          )}`,
-        )
       })
-    }),
-  )
-  describe(
-    "custom helpers",
-    withMock(fileStructHelpers, () => {
-      const _helpers: Record<string, (text: string) => string> = {
-        add1: (text) => text + " 1",
-      }
-      test("should work", async () => {
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          verbose: 0,
-          helpers: _helpers,
-        })
-
-        const results = {
-          add1: "app_name 1",
-        }
-        for (const key in results) {
-          const file = readFileSync(join(process.cwd(), "output", "custom", `${key}.txt`))
-          expect(file.toString()).toEqual(results[key as keyof typeof results])
-        }
-      })
-    }),
-  )
-  describe(
-    "transform subfolder",
-    withMock(fileStructSubdirTransformer, () => {
-      test("should work with no helper", async () => {
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          createSubFolder: true,
-          verbose: 0,
-        })
-
-        const data = readFileSync(join(process.cwd(), "output", "app_name", "app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my app is app_name")
-      })
-
-      test("should work with default helper", async () => {
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          createSubFolder: true,
-          verbose: 0,
-          subFolderNameHelper: "upperCase",
-        })
-
-        const data = readFileSync(join(process.cwd(), "output", "APP_NAME", "app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my app is app_name")
-      })
-
-      test("should work with custom helper", async () => {
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          createSubFolder: true,
-          verbose: 0,
-          subFolderNameHelper: "test",
-          helpers: {
-            test: () => "REPLACED",
-          },
-        })
-
-        const data = readFileSync(join(process.cwd(), "output", "REPLACED", "app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my app is app_name")
-      })
-    }),
-  )
-  describe(
-    "before write",
-    withMock(fileStructNormal, () => {
-      test("should work with no callback", async () => {
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          verbose: 0,
-          data: {
-            value: "value",
-          },
-        })
-
-        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my app is app_name")
-      })
-
-      test("should work with custom callback", async () => {
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          verbose: 0,
-          data: {
-            value: "value",
-          },
-          beforeWrite: (content, beforeContent, outputPath) =>
-            [content.toString().toUpperCase(), beforeContent, outputPath].join(", "),
-        })
-
-        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toEqual(
-          [
-            "Hello, my app is app_name".toUpperCase(),
-            fileStructNormal.input["{{name}}.txt"],
-            join(process.cwd(), "output", "app_name.txt"),
-          ].join(", "),
-        )
-      })
-      test("should work with undefined response custom callback", async () => {
-        await Scaffold({
-          name: "app_name",
-          output: "output",
-          templates: ["input"],
-          verbose: 0,
-          data: {
-            value: "value",
-          },
-          beforeWrite: () => undefined,
-        })
-
-        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toEqual("Hello, my app is app_name")
-      })
-    }),
+    })
   )
 })

tests/utils.test.ts

@@ -1,21 +0,0 @@
-import { handleErr, resolve } from "../src/utils"
-
-describe("utils", () => {
-  describe("resolve", () => {
-    test("should resolve function", () => {
-      expect(resolve(() => 1, null)).toBe(1)
-      expect(resolve((x) => x, 2)).toBe(2)
-    })
-    test("should resolve value", () => {
-      expect(resolve(1, null)).toBe(1)
-      expect(resolve(2, 1)).toBe(2)
-    })
-  })
-
-  describe("handleErr", () => {
-    test("should throw error", () => {
-      expect(() => handleErr({ name: "test", message: "test" })).toThrow()
-      expect(() => handleErr(null as never)).not.toThrow()
-    })
-  })
-})

tsconfig.json

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

typedoc.config.js

@@ -1,63 +0,0 @@
-const path = require("path")
-
-/** @type {import('typedoc').TypeDocOptions} */
-module.exports = {
-  name: "Simple Scaffold",
-  entryPoints: ["src/index.ts"],
-  includeVersion: true,
-  categorizeByGroup: false,
-  sort: ["visibility"],
-  categoryOrder: ["Main", "*"],
-  media: "media",
-  githubPages: true,
-  entryPointStrategy: "expand",
-  out: "docs",
-  excludePrivate: true,
-  excludeProtected: true,
-  excludeInternal: true,
-  gaID: "GTM-KHQS9TQ",
-  validation: {
-    invalidLink: true,
-  },
-  plugin: ["@knodes/typedoc-plugin-pages"],
-  customCss: "src/docs.css",
-  options: "typedoc.config.js",
-  logLevel: "Verbose",
-  pluginPages: {
-    logLevel: "Verbose",
-    pages: [
-      {
-        name: "Configuration",
-        source: "README.md",
-        childrenDir: path.join(process.cwd(), "pages"),
-        childrenOutputDir: "./",
-        children: [
-          {
-            name: "CLI usage",
-            source: "cli.md",
-          },
-          {
-            name: "Node.js usage",
-            source: "node.md",
-          },
-          {
-            name: "Templates",
-            source: "templates.md",
-          },
-          {
-            name: "Configuration Files",
-            source: "configuration_files.md",
-          },
-          {
-            name: "Migrating v0.x to v1.x",
-            source: "migration.md",
-          },
-        ],
-      },
-      {
-        name: "Changelog",
-        source: "./CHANGELOG.md",
-      },
-    ],
-  },
-}