4.0.19

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: code.foss.global/host.today/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: code.foss.global/host.today/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -1,3 +1,23 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# AI
+.claude/
+.serena/
+
+#------# custom

.gitlab-ci.yml

@@ -1,150 +0,0 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
-
-stages:
-- security
-- test
-- release
-- metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-  - docker
-  - notpriv
-
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
-
-# ====================
-# test stage
-# ====================
-
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-
-release:
-  stage: release
-  script:
-  - npmci node install stable
-  - npmci npm publish
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  image: docker:stable
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
-  tags:
-  - docker
-  - priv
-
-trigger:
-  stage: metadata
-  script:
-  - npmci trigger
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: metadata
-  script:
-    - npmci command npm install -g typedoc typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
-  tags:
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public
-  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

changelog.md

@@ -0,0 +1,313 @@
+# Changelog
+
+## 2025-08-17 - 4.0.19 - fix(readme)
+Update README with comprehensive quick start, usage examples, API reference and advanced guides
+
+- Expanded README with a detailed Quick Start guide and installation instructions
+- Added examples for creating templates, supplying variables, and scaffolding projects programmatically
+- Documented core features: smart variable system, template composition, dynamic file naming, interactive CLI, and post-scaffold scripts
+- Included advanced usage, CI/CD integration, template validation, and real-world example templates
+- Improved formatting and added code snippets for API reference and ScafTemplate usage
+
+## 2025-08-17 - 4.0.18 - fix(ScafTemplate)
+Use interactive shell for post-scaffold scripts; update CI workflows and package metadata
+
+- Switched ScafTemplate.runScripts to use smartshell.execInteractive so post-scaffold 'runafter' commands can run interactively
+- Updated Gitea workflow environment: replaced CI image with code.foss.global/host.today/ht-docker-node:npmci and adjusted NPMCI_COMPUTED_REPOURL
+- Changed CI install target from @shipzone/npmci to @ship.zone/npmci
+- Updated package.json metadata (bugs URL and homepage now point to code.foss.global) and added a pnpm.overrides entry
+- Minor TypeScript code cleanups and formatting (consistent trailing commas, safer string handling when parsing templates/frontmatter, improved concatenation when merging template files)
+- tsconfig adjustments: enabled emitDecoratorMetadata and added baseUrl/paths entries
+- Normalized README and template/test output files; updated .gitignore to ignore AI agent directories
+- Updated changelog and commitinfo metadata
+
+## 2025-08-17 - 4.0.17 - fix(ScafTemplate)
+
+Use interactive shell for post-scaffold scripts; update test/build config and dependency versions
+
+- Switched from smartshell.exec to smartshell.execInteractive when running smartscaf 'runafter' commands to allow interactive commands during post-scaffold execution (ScafTemplate.runScripts).
+- Updated package.json scripts: test now runs with additional flags (--verbose --logfile --timeout 60). Added typings entry pointing to dist_ts/index.d.ts.
+- Bumped devDependencies: @git.zone/tsbuild -> ^2.6.4, @git.zone/tstest -> ^2.3.4, @push.rocks/tapbundle -> ^6.0.3.
+- Updated runtime dependency versions: @push.rocks/lik -> ^6.2.2, @push.rocks/smartfile -> ^11.2.5, @push.rocks/smartshell -> ^3.3.0 (other deps kept or minor bumps).
+- Added pnpm-workspace.yaml with onlyBuiltDependencies configuration (esbuild, mongodb-memory-server, puppeteer).
+
+## 2025-04-15 - 4.0.16 - fix(dependencies)
+
+Update dependency references and bump version numbers; adjust workflow and template commands
+
+- Bump versions for devDependencies (@git.zone/tsbuild, @git.zone/tsrun, @git.zone/tstest, @push.rocks/tapbundle, and @types/node) and dependencies (@push.rocks/lik, @push.rocks/smartfile, @push.rocks/smartfm, @push.rocks/smarthbs, @push.rocks/smartinteract, @push.rocks/smartobject, @push.rocks/smartpromise, @push.rocks/smartshell, and @push.rocks/smartyaml)
+- Replace smartparam with smartobject in both plugins and core modules
+- Fix workflow install command by renaming '@gitzone/tsdoc' to '@git.zone/tsdoc'
+- Update template runafter command from 'npm install' to 'echo "runafter"'
+
+## 2024-05-29 - 4.0.15 - configuration updates
+
+Updates to the project’s configuration files, description and build settings.
+
+- Updated description.
+- Updated tsconfig (applied in multiple commits).
+- Updated npmextra.json (githost).
+
+## 2023-08-18 - 4.0.14 - core
+
+Improved core functionality.
+
+- Fixed core update.
+
+## 2023-07-25 - 4.0.13 - core & organization
+
+Enhancements in core behavior and organizational structure.
+
+- Fixed core update.
+- Switched to new organization scheme.
+
+## 2023-06-25 - 4.0.12 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-25 - 4.0.11 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-25 - 4.0.10 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-25 - 4.0.9 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-25 - 4.0.8 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-25 - 4.0.7 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-25 - 4.0.6 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-25 - 4.0.5 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-24 - 4.0.4 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2023-06-24 - 4.0.3 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2022-06-25 - 4.0.2 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2022-06-25 - 4.0.1 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2022-06-25 - 4.0.0 - core
+
+Core improvements.
+
+- Fixed core update.
+
+## 2022-06-25 - 3.0.10 - core (breaking)
+
+A breaking change was introduced affecting the module format.
+
+- BREAKING CHANGE (core): switched to ESM.
+
+## 2020-01-31 - 3.0.9 - core
+
+Routine core update.
+
+- Fixed core update.
+
+## 2019-10-11 - 3.0.8 - core
+
+Routine core update.
+
+- Fixed core update.
+
+## 2019-10-02 - 3.0.7 - core
+
+Routine core update.
+
+- Fixed core update.
+
+## 2019-09-10 - 3.0.6 - core
+
+Routine core update.
+
+- Fixed core update.
+
+## 2019-09-10 - 3.0.5 - core
+
+Routine core update.
+
+- Fixed core update.
+
+## 2019-09-10 - 3.0.4 - core
+
+Routine core update.
+
+- Fixed core update.
+
+## 2019-09-10 - 3.0.3 - general updates
+
+Updates to project dependencies and general code improvements.
+
+- Performed update.
+- Updated dependencies.
+
+## 2019-02-17 - 3.0.2 - core
+
+Routine core update.
+
+- Fixed core update.
+
+## 2019-01-27 - 3.0.1 - core
+
+Routine core update.
+
+- Fixed core update.
+
+## 2018-10-04 - 3.0.0 - core
+
+Changes from merging and core improvements.
+
+- Fixed core update.
+- Merged master branch changes and performed additional updates.
+
+## 2018-08-30 - 2.0.2 - structure (breaking)
+
+A breaking change in the project’s structure.
+
+- BREAKING CHANGE (structure): templates now take their path within the constructor.
+
+## 2018-08-27 - 2.0.1 - minor
+
+Versions in this range involved only version bump commits with no significant changes.
+
+- No significant changes.
+
+## 2017-08-09 - 1.0.14 - scope (breaking)
+
+A breaking change in the package scope was applied.
+
+- BREAKING CHANGE (scope): switched to new @pushrocks scope.
+
+## 2017-08-09 - 1.0.13 - core
+
+Improvements to variable handling.
+
+- Fixed variable distribution.
+
+## 2017-07-28 - 1.0.12 - dependencies
+
+Dependency updates.
+
+- Updated dependencies.
+
+## 2017-06-01 - 1.0.11 - dependencies
+
+Dependency updates.
+
+- Updated dependencies.
+
+## 2017-06-01 - 1.0.10 - CLI improvements
+
+Enhanced CLI error prevention.
+
+- Prevented error due to empty defaults.yml.
+
+## 2017-05-27 - 1.0.9 - dependencies
+
+Dependency updates.
+
+- Updated dependencies.
+
+## 2017-05-27 - 1.0.8 - templating
+
+Improved file templating support.
+
+- Added support for frontmatter for advanced file templating.
+
+## 2017-05-27 - 1.0.7 - documentation
+
+Documentation improvements.
+
+- Added docs.
+
+## 2017-05-27 - 1.0.6 - fixes
+
+Minor fixes.
+
+- Fixed deep add.
+
+## 2017-05-26 - 1.0.5 - smartfile updates
+
+Smartfile updates.
+
+- Updated smartfile.
+
+## 2017-05-26 - 1.0.4 - tests
+
+Test fixes.
+
+- Fixed tests.
+
+## 2017-05-26 - 1.0.3 - smartfile updates
+
+Smartfile updates.
+
+- Updated smartfile.
+
+## 2017-05-25 - 1.0.2 - functionality
+
+Minor functionality improvements.
+
+- Ensured proper functionality.
+
+## 2017-05-25 - 1.0.1 - core
+
+Core fixes.
+
+- Fixed working issues.
+
+## 2017-05-06 - 1.0.0 - initial release and CLI integration
+
+The initial release introducing CLI support and project setup.
+
+- Added CLI to prompt for missing variables.
+- Started CLI integration.
+- Added readme and CI tslint configuration.
+- Performed initial setup and various update tasks.

dist/index.d.ts

@@ -1 +0,0 @@
-export * from './smartscaf.classes.smartscaf';

dist/index.js

@@ -1,7 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./smartscaf.classes.smartscaf"));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLG1EQUE4QyJ9

dist/smartscaf.classes.smartscaf.d.ts

@@ -1,74 +0,0 @@
-import { Smartfile } from '@pushrocks/smartfile';
-export interface ScafTemplateContructorOptions {
-    name?: string;
-    description?: string;
-    sourceDir?: string;
-}
-export declare class ScafTemplate {
-    static createTemplateFromDir(): Promise<void>;
-    /**
-     * the name of the template
-     */
-    name: string;
-    /**
-     * the descriptions of the template
-     */
-    description: string;
-    /**
-     * the location on disk of the template
-     */
-    dirPath: string;
-    /**
-     * the files of the template as array of Smartfiles
-     */
-    templateSmartfileArray: Smartfile[];
-    requiredVariables: string[];
-    defaultVariables: any;
-    suppliedVariables: any;
-    missingVariables: string[];
-    constructor(dirPathArg: string);
-    /**
-     * read a template from a directory
-     */
-    readTemplateFromDir(): Promise<void>;
-    /**
-     * supply the variables to render the teplate with
-     * @param variablesArg gets merged with this.suppliedVariables
-     */
-    supplyVariables(variablesArg: any): Promise<void>;
-    /**
-     * Will ask for the missing variables by cli interaction
-     */
-    askCliForMissingVariables(): Promise<void>;
-    /**
-     * writes a file to disk
-     * @param destinationDirArg
-     */
-    writeToDisk(destinationDirArg: any): Promise<void>;
-    /**
-     * finds all variables in a Template in as string
-     * e.g. myobject.someKey and myobject.someOtherKey
-     */
-    private _findVariablesInTemplate;
-    /**
-     * checks if supplied Variables satisfy the template
-     */
-    private _checkSuppliedVariables;
-    /**
-     * checks the smartscaf.yml default values at the root of a template
-     * allows 2 ways of notation in YAML:
-     * >> myObject.myKey.someDeeperKey: someValue
-     * >> myObject.yourKey.yourDeeperKey: yourValue
-     * or
-     * >> myObject:
-     * >>   - someKey:
-     * >>     - someDeeperKey: someValue
-     * >>   - yourKey:
-     * >>     - yourDeeperKey: yourValue
-     */
-    private _checkDefaultVariables;
-    /**
-     * resolve template dependencies
-     */
-    private _resolveTemplateDependencies;
-}

dist/smartscaf.helpers.d.ts

@@ -1,4 +0,0 @@
-/**
- * adds a variable in string dot notation to an already more or less expanded object
- */
-export declare let deepAddToObject: (objectArg: any, varStringArg: string, valueArg: string) => Promise<void>;

dist/smartscaf.helpers.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * adds a variable in string dot notation to an already more or less expanded object
- */
-exports.deepAddToObject = async (objectArg, varStringArg, valueArg) => {
-    let varNamesArray = varStringArg.split('.');
-    let referencePointer = objectArg;
-    for (let i = 0; i !== varNamesArray.length; i++) {
-        let varName = varNamesArray[i];
-        // is there a next variable ?
-        let varNameNext = (() => {
-            if (varNamesArray[i + 1]) {
-                return varNamesArray[i + 1];
-            }
-            return null;
-        })();
-        // build the tree in suppliedVariables
-        if (!referencePointer[varName] && !varNameNext) {
-            referencePointer[varName] = valueArg;
-            referencePointer = null;
-        }
-        else if (!referencePointer[varName] && varNameNext) {
-            referencePointer[varName] = {};
-            referencePointer = referencePointer[varName];
-        }
-        else if (referencePointer[varName] && varNameNext) {
-            referencePointer = referencePointer[varName];
-        }
-        else {
-            throw new Error('Something is strange!');
-        }
-    }
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmhlbHBlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUVBOztHQUVHO0FBQ1EsUUFBQSxlQUFlLEdBQUcsS0FBSyxFQUFFLFNBQVMsRUFBRSxZQUFvQixFQUFFLFFBQWdCLEVBQUUsRUFBRTtJQUN2RixJQUFJLGFBQWEsR0FBRyxZQUFZLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzVDLElBQUksZ0JBQWdCLEdBQUcsU0FBUyxDQUFDO0lBQ2pDLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsS0FBSyxhQUFhLENBQUMsTUFBTSxFQUFFLENBQUMsRUFBRSxFQUFFO1FBQy9DLElBQUksT0FBTyxHQUFHLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUUvQiw2QkFBNkI7UUFDN0IsSUFBSSxXQUFXLEdBQVcsQ0FBQyxHQUFHLEVBQUU7WUFDOUIsSUFBSSxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxFQUFFO2dCQUN4QixPQUFPLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7YUFDN0I7WUFDRCxPQUFPLElBQUksQ0FBQztRQUNkLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFFTCxzQ0FBc0M7UUFDdEMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFO1lBQzlDLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxHQUFHLFFBQVEsQ0FBQztZQUNyQyxnQkFBZ0IsR0FBRyxJQUFJLENBQUM7U0FDekI7YUFBTSxJQUFJLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLElBQUksV0FBVyxFQUFFO1lBQ3BELGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztZQUMvQixnQkFBZ0IsR0FBRyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsQ0FBQztTQUM5QzthQUFNLElBQUksZ0JBQWdCLENBQUMsT0FBTyxDQUFDLElBQUksV0FBVyxFQUFFO1lBQ25ELGdCQUFnQixHQUFHLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxDQUFDO1NBQzlDO2FBQU07WUFDTCxNQUFNLElBQUksS0FBSyxDQUFDLHVCQUF1QixDQUFDLENBQUM7U0FDMUM7S0FDRjtBQUNILENBQUMsQ0FBQyJ9

dist/smartscaf.plugins.d.ts

@@ -1,9 +0,0 @@
-import * as path from 'path';
-import * as lik from '@pushrocks/lik';
-import * as smartfile from '@pushrocks/smartfile';
-import * as smartfm from '@pushrocks/smartfm';
-import * as smarthbs from '@pushrocks/smarthbs';
-import * as smartinteract from '@pushrocks/smartinteract';
-import * as smartq from '@pushrocks/smartpromise';
-import * as smartyaml from '@pushrocks/smartyaml';
-export { path, lik, smartfile, smartfm, smarthbs, smartinteract, smartq, smartyaml };

dist/smartscaf.plugins.js

@@ -1,26 +0,0 @@
-"use strict";
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path = __importStar(require("path"));
-exports.path = path;
-const lik = __importStar(require("@pushrocks/lik"));
-exports.lik = lik;
-const smartfile = __importStar(require("@pushrocks/smartfile"));
-exports.smartfile = smartfile;
-const smartfm = __importStar(require("@pushrocks/smartfm"));
-exports.smartfm = smartfm;
-const smarthbs = __importStar(require("@pushrocks/smarthbs"));
-exports.smarthbs = smarthbs;
-const smartinteract = __importStar(require("@pushrocks/smartinteract"));
-exports.smartinteract = smartinteract;
-const smartq = __importStar(require("@pushrocks/smartpromise"));
-exports.smartq = smartq;
-const smartyaml = __importStar(require("@pushrocks/smartyaml"));
-exports.smartyaml = smartyaml;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSwyQ0FBNkI7QUFTcEIsb0JBQUk7QUFSYixvREFBc0M7QUFRdkIsa0JBQUc7QUFQbEIsZ0VBQWtEO0FBTzlCLDhCQUFTO0FBTjdCLDREQUE4QztBQU1mLDBCQUFPO0FBTHRDLDhEQUFnRDtBQUtSLDRCQUFRO0FBSmhELHdFQUEwRDtBQUlSLHNDQUFhO0FBSC9ELGdFQUFrRDtBQUdlLHdCQUFNO0FBRnZFLGdFQUFrRDtBQUV1Qiw4QkFBUyJ9

npmextra.json

@@ -7,13 +7,27 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartscaf",
-      "shortDescription": "scaffold projects quickly",
+      "description": "A project aimed at quickly scaffolding projects with support for TypeScript, smart file handling, and template rendering.",
-      "npmPackagename": "@pushrocks/smartscaf",
+      "npmPackagename": "@push.rocks/smartscaf",
-      "license": "MIT"
+      "license": "MIT",
+      "keywords": [
+        "typescript",
+        "scaffolding",
+        "template rendering",
+        "file handling",
+        "project setup",
+        "smart interaction",
+        "yaml",
+        "cli tool"
+      ]
     }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
-}
+}

package.json

@@ -1,43 +1,71 @@
 {
-  "name": "@pushrocks/smartscaf",
+  "name": "@push.rocks/smartscaf",
-  "version": "3.0.4",
+  "version": "4.0.19",
   "private": false,
-  "description": "scaffold projects quickly",
+  "description": "A project aimed at quickly scaffolding projects with support for TypeScript, smart file handling, and template rendering.",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --verbose --logfile --timeout 60)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/smartscaf.git"
+    "url": "https://code.foss.global/push.rocks/smartscaf.git"
   },
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/smartscaf/issues"
+    "url": "https://code.foss.global/push.rocks/smartscaf/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartscaf#README",
+  "homepage": "https://code.foss.global/push.rocks/smartscaf#readme",
   "keywords": [
-    "scaffold",
+    "typescript",
-    "polymer",
+    "scaffolding",
-    "npm"
+    "template rendering",
+    "file handling",
+    "project setup",
+    "smart interaction",
+    "yaml",
+    "cli tool"
   ],
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@git.zone/tsbuild": "^2.6.4",
-    "@gitzone/tsrun": "^1.2.8",
+    "@git.zone/tsrun": "^1.3.3",
-    "@gitzone/tstest": "^1.0.24",
+    "@git.zone/tstest": "^2.3.4",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@push.rocks/tapbundle": "^6.0.3",
-    "@types/node": "^12.7.4"
+    "@types/node": "^22.14.1"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.11",
+    "@push.rocks/lik": "^6.2.2",
-    "@pushrocks/smartfile": "^7.0.4",
+    "@push.rocks/smartfile": "^11.2.5",
-    "@pushrocks/smartfm": "^2.0.4",
+    "@push.rocks/smartfm": "^2.2.2",
-    "@pushrocks/smarthbs": "^2.0.4",
+    "@push.rocks/smarthbs": "^3.0.3",
-    "@pushrocks/smartinteract": "^2.0.4",
+    "@push.rocks/smartinteract": "^2.0.16",
-    "@pushrocks/smartpromise": "^3.0.2",
+    "@push.rocks/smartobject": "^1.0.12",
-    "@pushrocks/smartyaml": "^2.0.3"
+    "@push.rocks/smartpromise": "^4.2.3",
+    "@push.rocks/smartshell": "^3.3.0",
+    "@push.rocks/smartyaml": "^3.0.4"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "type": "module",
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6",
+  "pnpm": {
+    "overrides": {}
   }
 }

pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+onlyBuiltDependencies:
+  - esbuild
+  - mongodb-memory-server
+  - puppeteer

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,35 +1,421 @@
-# @pushrocks/smartscaf
+# @push.rocks/smartscaf 🚀
-scaffold projects quickly
 
-## Availabililty and Links
+**Lightning-fast project scaffolding with smart templates and variable interpolation**
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartscaf)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartscaf)
-* [github.com (source mirror)](https://github.com/pushrocks/smartscaf)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartscaf/)
 
-## Status for master
+## What It Does
-[![build status](https://gitlab.com/pushrocks/smartscaf/badges/master/build.svg)](https://gitlab.com/pushrocks/smartscaf/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartscaf/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartscaf/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartscaf.svg)](https://www.npmjs.com/package/@pushrocks/smartscaf)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartscaf/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartscaf)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
-## Usage
+SmartScaf is a powerful TypeScript scaffolding engine that transforms template directories into fully configured projects in seconds. Think of it as your project's DNA replicator - define once, deploy anywhere with custom variables, dependency merging, and automated post-setup scripts.
 
-Use TypeScript for best in class instellisense.
+Perfect for:
+- 🏗️ **Bootstrapping microservices** with consistent structure
+- 📦 **Creating npm packages** with standard configurations  
+- 🎨 **Spinning up frontend projects** with your tech stack
+- 🔧 **Standardizing team workflows** with company templates
+- ⚡ **Automating repetitive project setups**
 
-For further information read the linked docs at the top of this README.
+## Installation
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+```bash
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+# Install globally for CLI usage
+npm install -g @push.rocks/smartscaf
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://)
+# Or add to your project
+npm install @push.rocks/smartscaf --save-dev
+```
 
-For further information read the linked docs at the top of this readme.
+## Quick Start
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+### Create Your First Template
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+1. **Set up a template directory** with your project structure:
+
+```
+my-template/
+├── .smartscaf.yml       # Template configuration
+├── package.json          # With {{projectName}} variables
+├── src/
+│   └── index.ts         # Your source files
+├── readme.md            # With {{description}} placeholder
+└── .gitignore           # Standard ignores
+```
+
+2. **Configure your template** in `.smartscaf.yml`:
+
+```yaml
+# Template defaults and configuration
+defaults:
+  projectName: 'my-awesome-project'
+  description: 'A fantastic new project'
+  author: '{{gitName}}'
+  license: 'MIT'
+  nodeVersion: '20'
+
+# Merge other templates (optional)
+dependencies:
+  merge:
+    - ../shared-config-template
+    - ../company-standards-template
+
+# Post-scaffold automation
+runafter:
+  - 'npm install'
+  - 'git init'
+  - 'git add .'
+  - 'git commit -m "Initial commit from SmartScaf"'
+```
+
+3. **Use Handlebars syntax** in your template files:
+
+```typescript
+// src/index.ts
+/**
+ * {{description}}
+ * @author {{author}}
+ * @license {{license}}
+ */
+
+export class {{className}} {
+  constructor() {
+    console.log('Welcome to {{projectName}}!');
+  }
+}
+```
+
+### Scaffold a New Project
+
+```typescript
+import { ScafTemplate } from '@push.rocks/smartscaf';
+
+async function createProject() {
+  // Load your template
+  const template = await ScafTemplate.createTemplateFromDir('./my-template');
+  await template.readTemplateFromDir();
+  
+  // Supply variables (overrides defaults)
+  await template.supplyVariables({
+    projectName: 'super-api',
+    description: 'Revolutionary API service',
+    className: 'SuperAPI',
+    author: 'John Doe'
+  });
+  
+  // Interactive mode - asks for any missing variables
+  await template.askCliForMissingVariables();
+  
+  // Generate the project
+  await template.writeToDisk('./projects/super-api');
+  
+  console.log('✨ Project scaffolded successfully!');
+}
+
+createProject();
+```
+
+## Core Features
+
+### 🎯 Smart Variable System
+
+SmartScaf intelligently manages template variables through multiple layers:
+
+```typescript
+const template = await ScafTemplate.createTemplateFromDir('./template');
+await template.readTemplateFromDir();
+
+// Access variable collections
+console.log(template.defaultVariables);   // From .smartscaf.yml defaults
+console.log(template.requiredVariables);  // Found in template files
+console.log(template.suppliedVariables);  // What you've provided
+console.log(template.missingVariables);   // What still needs values
+```
+
+### 🔀 Template Composition
+
+Merge multiple templates to create complex project structures:
+
+```yaml
+# .smartscaf.yml
+dependencies:
+  merge:
+    - ../base-template      # Common structure
+    - ../auth-template      # Authentication setup
+    - ../docker-template    # Container configuration
+```
+
+Templates are merged in order, allowing you to build sophisticated scaffolds from modular components.
+
+### 📝 Dynamic File Naming
+
+Use frontmatter to dynamically rename files during scaffolding:
+
+```markdown
+---
+fileName: {{projectName}}.config.js
+---
+
+module.exports = {
+  name: '{{projectName}}',
+  version: '{{version}}'
+};
+```
+
+### 🤖 Interactive CLI Mode
+
+Let SmartScaf prompt for missing variables:
+
+```typescript
+// Automatically prompts for any variables not yet supplied
+await template.askCliForMissingVariables();
+```
+
+### 🚀 Post-Scaffold Scripts
+
+Automate setup tasks after scaffolding:
+
+```yaml
+runafter:
+  - 'npm install'                    # Install dependencies
+  - 'npm run build'                   # Initial build
+  - 'npm test'                        # Verify setup
+  - 'code .'                          # Open in VS Code
+```
+
+Scripts run in order using an interactive shell, ensuring proper environment handling.
+
+## Advanced Usage
+
+### Programmatic Control
+
+```typescript
+import { ScafTemplate } from '@push.rocks/smartscaf';
+
+class ProjectGenerator {
+  private template: ScafTemplate;
+  
+  async initialize(templatePath: string) {
+    this.template = await ScafTemplate.createTemplateFromDir(templatePath);
+    await this.template.readTemplateFromDir();
+  }
+  
+  async generate(config: any, outputPath: string) {
+    // Supply configuration
+    await this.template.supplyVariables(config);
+    
+    // Check what's missing
+    if (this.template.missingVariables.length > 0) {
+      console.log('Missing:', this.template.missingVariables);
+      // Handle missing variables programmatically
+      // or use: await this.template.askCliForMissingVariables();
+    }
+    
+    // Generate project
+    await this.template.writeToDisk(outputPath);
+  }
+}
+```
+
+### Template Validation
+
+```typescript
+// Validate template before using
+const template = await ScafTemplate.createTemplateFromDir('./template');
+await template.readTemplateFromDir();
+
+// Check template structure
+if (template.templateSmartfileArray.length === 0) {
+  throw new Error('Template is empty!');
+}
+
+// Verify required variables
+const required = template.requiredVariables;
+const defaults = Object.keys(template.defaultVariables);
+const missing = required.filter(v => !defaults.includes(v));
+
+if (missing.length > 0) {
+  console.warn(`Template needs: ${missing.join(', ')}`);
+}
+```
+
+### Complex Variable Structures
+
+SmartScaf supports nested object variables:
+
+```yaml
+# .smartscaf.yml
+defaults:
+  app.name: 'MyApp'
+  app.version: '1.0.0'
+  database.host: 'localhost'
+  database.port: 5432
+  api.endpoints.users: '/api/users'
+  api.endpoints.auth: '/api/auth'
+```
+
+Use in templates:
+
+```javascript
+// config.js
+export default {
+  app: {
+    name: '{{app.name}}',
+    version: '{{app.version}}'
+  },
+  database: {
+    host: '{{database.host}}',
+    port: {{database.port}}
+  },
+  api: {
+    users: '{{api.endpoints.users}}',
+    auth: '{{api.endpoints.auth}}'
+  }
+};
+```
+
+### CI/CD Integration
+
+```typescript
+// ci-scaffold.ts
+import { ScafTemplate } from '@push.rocks/smartscaf';
+
+async function scaffoldForCI() {
+  const template = await ScafTemplate.createTemplateFromDir(
+    process.env.TEMPLATE_PATH
+  );
+  await template.readTemplateFromDir();
+  
+  // Get variables from environment
+  const vars = {
+    projectName: process.env.PROJECT_NAME,
+    environment: process.env.DEPLOY_ENV,
+    apiKey: process.env.API_KEY,
+    region: process.env.AWS_REGION
+  };
+  
+  await template.supplyVariables(vars);
+  await template.writeToDisk(process.env.OUTPUT_PATH);
+}
+
+// Run in CI pipeline
+scaffoldForCI().catch(console.error);
+```
+
+## Real-World Examples
+
+### Microservice Template
+
+```yaml
+# .smartscaf.yml for microservice template
+defaults:
+  serviceName: 'my-service'
+  port: 3000
+  dockerImage: 'node:20-alpine'
+  healthPath: '/health'
+  
+dependencies:
+  merge:
+    - ../shared/base-service
+    - ../shared/monitoring
+    - ../shared/logging
+
+runafter:
+  - 'npm install'
+  - 'docker build -t {{serviceName}}:latest .'
+  - 'npm run test:integration'
+```
+
+### React Component Library
+
+```yaml
+# .smartscaf.yml for React library
+defaults:
+  libraryName: 'ui-components'
+  componentPrefix: 'UI'
+  useTypeScript: true
+  useStorybook: true
+  testRunner: 'jest'
+
+runafter:
+  - 'pnpm install'
+  - 'pnpm build'
+  - 'pnpm storybook:build'
+  - 'pnpm test'
+```
+
+## API Reference
+
+### ScafTemplate Class
+
+```typescript
+class ScafTemplate {
+  // Factory method
+  static createTemplateFromDir(dirPath: string): Promise<ScafTemplate>
+  
+  // Core methods
+  readTemplateFromDir(): Promise<void>
+  supplyVariables(variables: object): Promise<void>
+  askCliForMissingVariables(): Promise<void>
+  writeToDisk(destinationPath: string): Promise<void>
+  
+  // Properties
+  name: string                        // Template name
+  description: string                  // Template description
+  templateSmartfileArray: SmartFile[] // Loaded template files
+  defaultVariables: object            // Default values from .smartscaf.yml
+  requiredVariables: string[]         // Variables found in templates
+  suppliedVariables: object          // Variables you've provided
+  missingVariables: string[]         // Variables still needed
+}
+```
+
+## Best Practices
+
+### 📁 Template Organization
+
+```
+company-templates/
+├── base/                   # Shared foundations
+│   ├── typescript/        # TS configuration
+│   ├── eslint/           # Linting setup
+│   └── ci-cd/            # CI/CD pipelines
+├── services/              # Service templates
+│   ├── rest-api/
+│   ├── graphql-api/
+│   └── worker-service/
+└── frontends/             # Frontend templates
+    ├── react-app/
+    ├── vue-app/
+    └── static-site/
+```
+
+### 🔒 Security Considerations
+
+- Never commit sensitive data in templates
+- Use environment variables for secrets
+- Add `.smartscaf.yml` to `.gitignore` if it contains private defaults
+- Validate user input when using in automation
+
+### 🎨 Template Design Tips
+
+1. **Start small** - Begin with minimal templates and grow them
+2. **Use composition** - Build complex templates from simple ones
+3. **Document variables** - Add comments in `.smartscaf.yml`
+4. **Test templates** - Create test scaffolds before deploying
+5. **Version templates** - Use git tags for template versions
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.ts

@@ -1,7 +1,7 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 import * as path from 'path';
 
-import * as smartscaf from '../ts/index';
+import * as smartscaf from '../ts/index.js';
 
 process.env.CI = 'true';
 
@@ -9,12 +9,12 @@ let testScafTemplate: smartscaf.ScafTemplate;
 
 tap.test('should create new Smartscaf instance', async () => {
   testScafTemplate = new smartscaf.ScafTemplate('./test/test_template');
-  expect(testScafTemplate).to.be.instanceof(smartscaf.ScafTemplate);
+  expect(testScafTemplate).toBeInstanceOf(smartscaf.ScafTemplate);
 });
 
 tap.test('Smartscaf instance -> should read a template directory', async () => {
   await testScafTemplate.readTemplateFromDir();
-  expect(testScafTemplate.templateSmartfileArray.length).to.equal(6);
+  expect(testScafTemplate.templateSmartfileArray.length).toEqual(6);
 });
 
 tap.test('smartfile -> should accept variables', async () => {

test/test_output/anothername.yml

@@ -1,3 +1,6 @@
+
 # this is a wow
+
 # this is a here
+
 # this is a undefined variable

test/test_output/changedname.md

@@ -1 +1,2 @@
-# some undefined variable
+
+# some undefined variable

test/test_output/hello.md

@@ -1 +1 @@
-# param1 10
+# param1 10

test/test_output/notemplate.yml

@@ -1 +1 @@
-awesome!
+awesome!

test/test_output/template2.md

@@ -1,3 +1,5 @@
 # this is a from default yaml
+
 # this is a this is another value from yml
+
 # this is a undefined variable

test/test_template/.smartscaf.yml

@@ -8,3 +8,6 @@ defaults:
 dependencies:
   merge:
     - ../test_template_2
+
+runafter:
+  - echo 'runafter'

test/test_template/notemplate.yml

@@ -1 +1 @@
-awesome!
+awesome!

test/test_template/template1.md

@@ -1,3 +1,9 @@
+---
+fileName: anothername.yml
+---
+
 # this is a {{templateObject.value1}}
+
 # this is a {{templateObject.value2}}
+
 # this is a {{templateVar3}}

test/test_template/template2.md

@@ -1,3 +1,5 @@
 # this is a {{templateVar1}}
+
 # this is a {{templateVar2}}
+
 # this is a {{templateVar3}}

test/test_template/template3.md

@@ -1,4 +1,5 @@
 ---
 fileName: changedname.md
 ---
-# some {{wow}}
+
+# some {{wow}}

test/test_template_2/hello.md

@@ -1 +1 @@
-# param1 {{node_version}}
+# param1 {{node_version}}

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @push.rocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartscaf',
+  version: '4.0.19',
+  description: 'A project aimed at quickly scaffolding projects with support for TypeScript, smart file handling, and template rendering.'
+}

ts/index.ts

@@ -1 +1 @@
-export * from './smartscaf.classes.smartscaf';
+export * from './smartscaf.classes.smartscaf.js';

ts/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './smartscaf.js';

ts/interfaces/smartscaf.ts

@@ -0,0 +1,7 @@
+export interface ISmartscafFile {
+  defaults: { [key: string]: string };
+  dependencies: {
+    merge: string[];
+  };
+  runafter: string[];
+}

ts/smartscaf.classes.smartscaf.ts

@@ -1,8 +1,5 @@
-import * as plugins from './smartscaf.plugins';
+import * as plugins from './smartscaf.plugins.js';
-import * as helpers from './smartscaf.helpers';
+import * as interfaces from './interfaces/index.js';
-
-// interfaces
-import { Smartfile } from '@pushrocks/smartfile';
 
 export interface ScafTemplateContructorOptions {
   name?: string;
@@ -11,31 +8,39 @@ export interface ScafTemplateContructorOptions {
 }
 
 export class ScafTemplate {
-  static async createTemplateFromDir() {}
+  public static async createTemplateFromDir(dirPathArg: string) {
+    return new ScafTemplate(dirPathArg);
+  }
 
   /**
    * the name of the template
    */
-  name: string;
+  public name: string;
 
   /**
    * the descriptions of the template
    */
-  description: string;
+  public description: string;
 
   /**
    * the location on disk of the template
    */
-  dirPath: string;
+  public dirPath: string;
+  public destinationPath: string;
+
+  /**
+   * smartscafFile
+   */
+  public smartscafFile: interfaces.ISmartscafFile;
 
   /**
    * the files of the template as array of Smartfiles
    */
-  templateSmartfileArray: Smartfile[];
+  public templateSmartfileArray: plugins.smartfile.SmartFile[];
-  requiredVariables: string[];
+  public requiredVariables: string[];
-  defaultVariables: any;
+  public defaultVariables: any;
-  suppliedVariables: any = {};
+  public suppliedVariables: any = {};
-  missingVariables: string[] = [];
+  public missingVariables: string[] = [];
 
   constructor(dirPathArg: string) {
     this.dirPath = plugins.path.resolve(dirPathArg);
@@ -44,8 +49,37 @@ export class ScafTemplate {
   /**
    * read a template from a directory
    */
-  async readTemplateFromDir() {
+  public async readTemplateFromDir() {
-    this.templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(this.dirPath, '**/*');
+    this.templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(
+      this.dirPath,
+      '**/*',
+    );
+
+    // read .smartscaf.yml file
+    let smartscafFile: interfaces.ISmartscafFile = {
+      defaults: {},
+      dependencies: {
+        merge: [],
+      },
+      runafter: [],
+    };
+
+    const smartscafSmartfile = this.templateSmartfileArray.find(
+      (smartfileArg) => {
+        return smartfileArg.parsedPath.base === '.smartscaf.yml';
+      },
+    );
+
+    if (smartscafSmartfile) {
+      smartscafFile = {
+        ...smartscafFile,
+        ...(await plugins.smartyaml.yamlStringToObject(
+          smartscafSmartfile.contentBuffer.toString(),
+        )),
+      };
+    }
+    this.smartscafFile = smartscafFile;
+
     await this._resolveTemplateDependencies();
     await this._findVariablesInTemplate();
     await this._checkSuppliedVariables();
@@ -56,10 +90,10 @@ export class ScafTemplate {
    * supply the variables to render the teplate with
    * @param variablesArg gets merged with this.suppliedVariables
    */
-  async supplyVariables(variablesArg) {
+  public async supplyVariables(variablesArg) {
     this.suppliedVariables = {
       ...this.suppliedVariables,
-      ...variablesArg
+      ...variablesArg,
     };
     this.missingVariables = await this._checkSuppliedVariables();
   }
@@ -67,61 +101,80 @@ export class ScafTemplate {
   /**
    * Will ask for the missing variables by cli interaction
    */
-  async askCliForMissingVariables() {
+  public async askCliForMissingVariables() {
     this.missingVariables = await this._checkSuppliedVariables();
-    let localSmartInteract = new plugins.smartinteract.SmartInteract();
+    const localSmartInteract = new plugins.smartinteract.SmartInteract();
-    for (let missingVariable of this.missingVariables) {
+    for (const missingVariable of this.missingVariables) {
       localSmartInteract.addQuestions([
         {
           name: missingVariable,
           type: 'input',
           default: (() => {
-            if (this.defaultVariables && this.defaultVariables[missingVariable]) {
+            if (
+              this.defaultVariables &&
+              this.defaultVariables[missingVariable]
+            ) {
               return this.defaultVariables[missingVariable];
             } else {
               return 'undefined variable';
             }
           })(),
-          message: `What is the value of ${missingVariable}?`
+          message: `What is the value of ${missingVariable}?`,
-        }
+        },
       ]);
     }
-    let answerBucket = await localSmartInteract.runQueue();
+    const answerBucket = await localSmartInteract.runQueue();
-    await answerBucket.answerMap.forEach(async answer => {
+    const answers = answerBucket.getAllAnswers();
-      await helpers.deepAddToObject(this.suppliedVariables, answer.name, answer.value);
+    for (const answer of answers) {
-    });
+      await plugins.smartobject.smartAdd(
+        this.suppliedVariables,
+        answer.name,
+        answer.value,
+      );
+    }
   }
 
   /**
    * writes a file to disk
    * @param destinationDirArg
    */
-  async writeToDisk(destinationDirArg) {
+  public async writeToDisk(destinationDirArg) {
-    const smartfileArrayToWrite: Smartfile[] = [];
+    this.destinationPath = destinationDirArg;
-    for (let smartfile of this.templateSmartfileArray) {
+    const smartfileArrayToWrite: plugins.smartfile.SmartFile[] = [];
+    for (const smartfile of this.templateSmartfileArray) {
       // lets filter out template files
       if (smartfile.path === '.smartscaf.yml') {
         continue;
       }
 
       // render the template
-      let template = await plugins.smarthbs.getTemplateForString(smartfile.contents.toString());
+      const template = await plugins.smarthbs.getTemplateForString(
-      let renderedTemplateString = template(this.suppliedVariables);
+        smartfile.contents.toString(),
+      );
+      const renderedTemplateString = template(this.suppliedVariables);
 
       // handle frontmatter
       const smartfmInstance = new plugins.smartfm.Smartfm({
-        fmType: 'yaml'
+        fmType: 'yaml',
       });
-      let parsedTemplate = smartfmInstance.parse(renderedTemplateString) as any;
+      const parsedTemplate = smartfmInstance.parse(
+        renderedTemplateString,
+      ) as any;
       if (parsedTemplate.data.fileName) {
         smartfile.updateFileName(parsedTemplate.data.fileName);
       }
 
-      smartfile.contents = Buffer.from(parsedTemplate.content);
+      smartfile.contents = Buffer.from(
+        await plugins.smarthbs.postprocess(parsedTemplate.content),
+      );
       smartfileArrayToWrite.push(smartfile);
     }
 
-    await plugins.smartfile.memory.smartfileArrayToFs(smartfileArrayToWrite, destinationDirArg);
+    await plugins.smartfile.memory.smartfileArrayToFs(
+      smartfileArrayToWrite,
+      destinationDirArg,
+    );
+    await this.runScripts();
   }
 
   /**
@@ -130,9 +183,9 @@ export class ScafTemplate {
    */
   private async _findVariablesInTemplate() {
     let templateVariables: string[] = [];
-    for (let templateSmartfile of this.templateSmartfileArray) {
+    for (const templateSmartfile of this.templateSmartfileArray) {
-      let localTemplateVariables = await plugins.smarthbs.findVarsInHbsString(
+      const localTemplateVariables = await plugins.smarthbs.findVarsInHbsString(
-        templateSmartfile.contents.toString()
+        templateSmartfile.contents.toString(),
       );
       templateVariables = [...templateVariables, ...localTemplateVariables];
     }
@@ -146,10 +199,10 @@ export class ScafTemplate {
    */
   private async _checkSuppliedVariables() {
     let missingVars: string[] = [];
-    for (let templateSmartfile of this.templateSmartfileArray) {
+    for (const templateSmartfile of this.templateSmartfileArray) {
-      let localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
+      const localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
         templateSmartfile.contents.toString(),
-        this.suppliedVariables
+        this.suppliedVariables,
       );
 
       // combine with other missingVars
@@ -176,13 +229,15 @@ export class ScafTemplate {
    * >>     - yourDeeperKey: yourValue
    */
   private async _checkDefaultVariables() {
-    let smartscafSmartfile = this.templateSmartfileArray.find(smartfileArg => {
+    const smartscafSmartfile = this.templateSmartfileArray.find(
-      return smartfileArg.parsedPath.base === '.smartscaf.yml';
+      (smartfileArg) => {
-    });
+        return smartfileArg.parsedPath.base === '.smartscaf.yml';
+      },
+    );
 
     if (smartscafSmartfile) {
       const smartscafObject = await plugins.smartyaml.yamlStringToObject(
-        smartscafSmartfile.contents.toString()
+        smartscafSmartfile.contents.toString(),
       );
       const defaultObject = smartscafObject.defaults;
       this.defaultVariables = defaultObject;
@@ -199,36 +254,38 @@ export class ScafTemplate {
    * resolve template dependencies
    */
   private async _resolveTemplateDependencies() {
-    const smartscafSmartfile = this.templateSmartfileArray.find(smartfileArg => {
-      return smartfileArg.parsedPath.base === '.smartscaf.yml';
-    });
-    if (!smartscafSmartfile) {
-      console.log('No further template dependencies defined!');
-      return;
-    }
-    console.log('Found template dependencies! Resolving them now!');
     console.log('looking at templates to merge!');
-    const smartscafYamlObject = await plugins.smartyaml.yamlStringToObject(
+    for (const dependency of this.smartscafFile.dependencies.merge) {
-      smartscafSmartfile.contentBuffer.toString()
-    );
-    if (!smartscafYamlObject) {
-      console.log('Something seems strange about the supplied dependencies.yml file.');
-      return;
-    }
-    for (const dependency of smartscafYamlObject.dependencies.merge) {
       console.log(`Now resolving ${dependency}`);
       const templatePathToMerge = plugins.path.join(this.dirPath, dependency);
       if (!plugins.smartfile.fs.isDirectory(templatePathToMerge)) {
         console.log(
-          `dependency ${dependency} resolves to ${templatePathToMerge} which ist NOT a directory`
+          `dependency ${dependency} resolves to ${templatePathToMerge} which ist NOT a directory`,
         );
         continue;
       }
-      const templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(
+      const templateSmartfileArray =
-        templatePathToMerge,
+        await plugins.smartfile.fs.fileTreeToObject(
-        '**/*'
+          templatePathToMerge,
+          '**/*',
+        );
+      this.templateSmartfileArray = this.templateSmartfileArray.concat(
+        templateSmartfileArray,
+      );
+    }
+  }
+
+  private async runScripts() {
+    if (!this.destinationPath) {
+      throw new Error('cannot run scripts without an destinationdir');
+    }
+    const smartshellInstance = new plugins.smartshell.Smartshell({
+      executor: 'bash',
+    });
+    for (const command of this.smartscafFile.runafter) {
+      await smartshellInstance.execInteractive(
+        `cd ${this.destinationPath} && ${command}`,
       );
-      this.templateSmartfileArray = this.templateSmartfileArray.concat(templateSmartfileArray);
     }
   }
 }

ts/smartscaf.helpers.ts

@@ -1,33 +0,0 @@
-import * as plugins from './smartscaf.plugins';
-
-/**
- * adds a variable in string dot notation to an already more or less expanded object
- */
-export let deepAddToObject = async (objectArg, varStringArg: string, valueArg: string) => {
-  let varNamesArray = varStringArg.split('.');
-  let referencePointer = objectArg;
-  for (let i = 0; i !== varNamesArray.length; i++) {
-    let varName = varNamesArray[i];
-
-    // is there a next variable ?
-    let varNameNext: string = (() => {
-      if (varNamesArray[i + 1]) {
-        return varNamesArray[i + 1];
-      }
-      return null;
-    })();
-
-    // build the tree in suppliedVariables
-    if (!referencePointer[varName] && !varNameNext) {
-      referencePointer[varName] = valueArg;
-      referencePointer = null;
-    } else if (!referencePointer[varName] && varNameNext) {
-      referencePointer[varName] = {};
-      referencePointer = referencePointer[varName];
-    } else if (referencePointer[varName] && varNameNext) {
-      referencePointer = referencePointer[varName];
-    } else {
-      throw new Error('Something is strange!');
-    }
-  }
-};

ts/smartscaf.plugins.ts

@@ -1,10 +1,23 @@
 import * as path from 'path';
-import * as lik from '@pushrocks/lik';
+import * as lik from '@push.rocks/lik';
-import * as smartfile from '@pushrocks/smartfile';
+import * as smartfile from '@push.rocks/smartfile';
-import * as smartfm from '@pushrocks/smartfm';
+import * as smartfm from '@push.rocks/smartfm';
-import * as smarthbs from '@pushrocks/smarthbs';
+import * as smarthbs from '@push.rocks/smarthbs';
-import * as smartinteract from '@pushrocks/smartinteract';
+import * as smartinteract from '@push.rocks/smartinteract';
-import * as smartq from '@pushrocks/smartpromise';
+import * as smartobject from '@push.rocks/smartobject';
-import * as smartyaml from '@pushrocks/smartyaml';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartyaml from '@push.rocks/smartyaml';
+import * as smartshell from '@push.rocks/smartshell';
 
-export { path, lik, smartfile, smartfm, smarthbs, smartinteract, smartq, smartyaml };
+export {
+  path,
+  lik,
+  smartfile,
+  smartfm,
+  smarthbs,
+  smartinteract,
+  smartobject,
+  smartpromise,
+  smartyaml,
+  smartshell,
+};

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
+    "baseUrl": ".",
+    "paths": {}
+  },
+  "exclude": ["dist_*/**/*.d.ts"]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}