4.0.7

.gitea/workflows/gitzone_ci_default.yaml

@@ -0,0 +1,107 @@
+name: CI Pipeline
+
+on: push
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+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 @shipzone/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
+
+  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: 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: Code quality
+      run: |
+        npmci command npm install -g typescript
+        npmci npm prepare
+        npmci npm install
+
+    - name: Trigger
+      run: npmci trigger
+
+    - name: Build docs and upload artifacts
+      run: |
+        npmci node install stable
+        npmci npm install
+        npmci command npm run buildDocs
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: public
+        path: public
+        retention-days: 7

.gitignore

@@ -1,3 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# 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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

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,11 +7,12 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartscaf",
-      "shortDescription": "scaffold projects quickly",
+      "description": "scaffold projects quickly",
       "npmPackagename": "@pushrocks/smartscaf",
       "license": "MIT"
     }

package.json

@@ -1,13 +1,14 @@
 {
   "name": "@pushrocks/smartscaf",
-  "version": "3.0.4",
+  "version": "4.0.7",
   "private": false,
   "description": "scaffold projects quickly",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -25,19 +26,37 @@
     "npm"
   ],
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.4"
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsrun": "^1.2.42",
+    "@gitzone/tstest": "^1.0.74",
+    "@pushrocks/tapbundle": "^5.0.8",
+    "@types/node": "^20.3.1"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.11",
-    "@pushrocks/smartfile": "^7.0.4",
+    "@pushrocks/lik": "^6.0.2",
+    "@pushrocks/smartfile": "^10.0.17",
     "@pushrocks/smartfm": "^2.0.4",
-    "@pushrocks/smarthbs": "^2.0.4",
-    "@pushrocks/smartinteract": "^2.0.4",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartyaml": "^2.0.3"
-  }
+    "@pushrocks/smarthbs": "^3.0.3",
+    "@pushrocks/smartinteract": "^2.0.11",
+    "@pushrocks/smartparam": "^1.1.6",
+    "@pushrocks/smartpromise": "^4.0.2",
+    "@pushrocks/smartshell": "^3.0.3",
+    "@pushrocks/smartyaml": "^2.0.5"
+  },
+  "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"
+  ]
 }

readme.md

@@ -8,13 +8,19 @@ scaffold projects quickly
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartscaf/)
 
 ## Status for master
-[![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/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartscaf/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartscaf/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartscaf)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartscaf)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartscaf)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartscaf)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartscaf)](https://lossless.cloud)
 
 ## Usage
 
@@ -27,9 +33,12 @@ For further information read the linked docs at the top of this README.
 
 [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://)
 
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| 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)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

test/test.ts

@@ -1,7 +1,7 @@
 import { expect, tap } from '@pushrocks/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

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

test/test_template/.smartscaf.yml

@@ -8,3 +8,6 @@ defaults:
 dependencies:
   merge:
     - ../test_template_2
+
+runafter:
+  - npm install

test/test_template/template1.md

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

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartscaf',
+  version: '4.0.7',
+  description: 'scaffold projects quickly'
+}

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,5 +1,5 @@
-import * as plugins from './smartscaf.plugins';
-import * as helpers from './smartscaf.helpers';
+import * as plugins from './smartscaf.plugins.js';
+import * as interfaces from './interfaces/index.js';
 
 // interfaces
 import { Smartfile } from '@pushrocks/smartfile';
@@ -11,31 +11,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[];
-  requiredVariables: string[];
-  defaultVariables: any;
-  suppliedVariables: any = {};
-  missingVariables: string[] = [];
+  public templateSmartfileArray: Smartfile[];
+  public requiredVariables: string[];
+  public defaultVariables: any;
+  public suppliedVariables: any = {};
+  public missingVariables: string[] = [];
 
   constructor(dirPathArg: string) {
     this.dirPath = plugins.path.resolve(dirPathArg);
@@ -44,8 +52,32 @@ export class ScafTemplate {
   /**
    * read a template from a directory
    */
-  async readTemplateFromDir() {
+  public async readTemplateFromDir() {
     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 +88,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,10 +99,10 @@ 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();
-    for (let missingVariable of this.missingVariables) {
+    const localSmartInteract = new plugins.smartinteract.SmartInteract();
+    for (const missingVariable of this.missingVariables) {
       localSmartInteract.addQuestions([
         {
           name: missingVariable,
@@ -82,46 +114,49 @@ export class ScafTemplate {
               return 'undefined variable';
             }
           })(),
-          message: `What is the value of ${missingVariable}?`
-        }
+          message: `What is the value of ${missingVariable}?`,
+        },
       ]);
     }
-    let answerBucket = await localSmartInteract.runQueue();
-    await answerBucket.answerMap.forEach(async answer => {
-      await helpers.deepAddToObject(this.suppliedVariables, answer.name, answer.value);
-    });
+    const answerBucket = await localSmartInteract.runQueue();
+    const answers = answerBucket.getAllAnswers();
+    for (const answer of answers) {
+      await plugins.smartparam.smartAdd(this.suppliedVariables, answer.name, answer.value);
+    }
   }
 
   /**
    * writes a file to disk
    * @param destinationDirArg
    */
-  async writeToDisk(destinationDirArg) {
+  public async writeToDisk(destinationDirArg) {
+    this.destinationPath = destinationDirArg;
     const smartfileArrayToWrite: Smartfile[] = [];
-    for (let smartfile of this.templateSmartfileArray) {
+    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());
-      let renderedTemplateString = template(this.suppliedVariables);
+      const template = await plugins.smarthbs.getTemplateForString(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 this.runScripts();
   }
 
   /**
@@ -130,8 +165,8 @@ export class ScafTemplate {
    */
   private async _findVariablesInTemplate() {
     let templateVariables: string[] = [];
-    for (let templateSmartfile of this.templateSmartfileArray) {
-      let localTemplateVariables = await plugins.smarthbs.findVarsInHbsString(
+    for (const templateSmartfile of this.templateSmartfileArray) {
+      const localTemplateVariables = await plugins.smarthbs.findVarsInHbsString(
         templateSmartfile.contents.toString()
       );
       templateVariables = [...templateVariables, ...localTemplateVariables];
@@ -146,8 +181,8 @@ export class ScafTemplate {
    */
   private async _checkSuppliedVariables() {
     let missingVars: string[] = [];
-    for (let templateSmartfile of this.templateSmartfileArray) {
-      let localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
+    for (const templateSmartfile of this.templateSmartfileArray) {
+      const localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
         templateSmartfile.contents.toString(),
         this.suppliedVariables
       );
@@ -176,7 +211,7 @@ export class ScafTemplate {
    * >>     - yourDeeperKey: yourValue
    */
   private async _checkDefaultVariables() {
-    let smartscafSmartfile = this.templateSmartfileArray.find(smartfileArg => {
+    const smartscafSmartfile = this.templateSmartfileArray.find((smartfileArg) => {
       return smartfileArg.parsedPath.base === '.smartscaf.yml';
     });
 
@@ -199,23 +234,8 @@ 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(
-      smartscafSmartfile.contentBuffer.toString()
-    );
-    if (!smartscafYamlObject) {
-      console.log('Something seems strange about the supplied dependencies.yml file.');
-      return;
-    }
-    for (const dependency of smartscafYamlObject.dependencies.merge) {
+    for (const dependency of this.smartscafFile.dependencies.merge) {
       console.log(`Now resolving ${dependency}`);
       const templatePathToMerge = plugins.path.join(this.dirPath, dependency);
       if (!plugins.smartfile.fs.isDirectory(templatePathToMerge)) {
@@ -231,4 +251,16 @@ export class ScafTemplate {
       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.exec(`cd ${this.destinationPath} && ${command}`);
+    }
+  }
 }

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

@@ -4,7 +4,20 @@ 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 smartparam from '@pushrocks/smartparam';
+import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartyaml from '@pushrocks/smartyaml';
+import * as smartshell from '@pushrocks/smartshell';
 
-export { path, lik, smartfile, smartfm, smarthbs, smartinteract, smartq, smartyaml };
+export {
+  path,
+  lik,
+  smartfile,
+  smartfm,
+  smarthbs,
+  smartinteract,
+  smartparam,
+  smartpromise,
+  smartyaml,
+  smartshell,
+};

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext"
+  }
+}

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