4.0.4

update

See merge request pushrocks/smartscaf!1

.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,38 +1,80 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- test
-- release
-- trigger
-- pages
+  - security
+  - test
+  - release
+  - metadata
 
-testLEGACY:
-  stage: test
+before_script:
+  - npm install -g @shipzone/npmci
+
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
-  coverage: /\d+.?\d+?\%\s*coverage/
+    - npmci git mirror
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
   allow_failure: true
 
-testLTS:
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test lts
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-    
-testSTABLE:
+
+testBuild:
   stage: test
   script:
-    - npmci test stable
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -40,32 +82,58 @@ testSTABLE:
 release:
   stage: release
   script:
-    - npmci publish
+    - npmci node install stable
+    - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  only:
+    - tags
+  script:
+    - npmci command npm install -g typescript
+    - npmci npm prepare
+    - npmci npm install
+  tags:
+    - lossless
+    - docker
+    - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
     - npmci trigger
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command yarn global add npmpage
-    - npmci command npmpage
+    - npmci node install stable 
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLG1EQUE2QyJ9

dist/smartscaf.classes.smartscaf.d.ts

@@ -1,35 +0,0 @@
-import { Smartfile } from 'smartfile';
-export interface ScafTemplateContructorOptions {
-    name?: string;
-    description?: string;
-    sourceDir?: string;
-}
-export declare class ScafTemplate {
-    name: string;
-    description: string;
-    templateSmartfileArray: Smartfile[];
-    requiredVariables: string[];
-    suppliedVariables: any;
-    missingVariables: string[];
-    /**
-     * read a template from a directory
-     */
-    readTemplateFromDir(dirPathArg: string): Promise<void>;
-    /**
-     * supply the variables to render the teplate with
-     * @param variablesArg
-     */
-    supplyVariables(variablesArg: any): Promise<void>;
-    /**
-     * Will ask for the missing variables by cli interaction
-     */
-    askCliForMissingVariables(): Promise<void>;
-    /**
-     * finds all variables in a Template
-     */
-    private _findVariablesInTemplate();
-    /**
-     * checks if supplied Variables satisfy the template
-     */
-    private _checkSuppliedVariables();
-}

dist/smartscaf.classes.smartscaf.js

@@ -1,79 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const plugins = require("./smartscaf.plugins");
-class ScafTemplate {
-    constructor() {
-        this.missingVariables = [];
-    }
-    /**
-     * read a template from a directory
-     */
-    readTemplateFromDir(dirPathArg) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let dirPath = plugins.path.resolve(dirPathArg);
-            this.templateSmartfileArray = yield plugins.smartfile.fs.fileTreeToObject(dirPath, '**/*');
-            this._findVariablesInTemplate();
-        });
-    }
-    /**
-     * supply the variables to render the teplate with
-     * @param variablesArg
-     */
-    supplyVariables(variablesArg) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.suppliedVariables = variablesArg;
-            this.missingVariables = yield this._checkSuppliedVariables();
-        });
-    }
-    /**
-     * Will ask for the missing variables by cli interaction
-     */
-    askCliForMissingVariables() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.missingVariables = yield this._checkSuppliedVariables();
-            let localSmartInteract = new plugins.smartinteract.SmartInteract();
-            for (let missingVariable of this.missingVariables) {
-                localSmartInteract.addQuestions([{
-                        name: missingVariable,
-                        type: 'input',
-                        default: `undefined ${missingVariable}`,
-                        message: `What is the value of ${missingVariable}?`
-                    }]);
-            }
-            let answers = yield localSmartInteract.runQueue();
-        });
-    }
-    /**
-     * finds all variables in a Template
-     */
-    _findVariablesInTemplate() {
-        return __awaiter(this, void 0, void 0, function* () {
-            for (let localSmartfile of this.templateSmartfileArray) {
-            }
-        });
-    }
-    /**
-     * checks if supplied Variables satisfy the template
-     */
-    _checkSuppliedVariables() {
-        return __awaiter(this, void 0, void 0, function* () {
-            let missingVars = [];
-            for (let templateSmartFile of this.templateSmartfileArray) {
-                let localMissingVars = yield plugins.smarthbs.checkVarsSatisfaction(templateSmartFile.contents.toString(), this.suppliedVariables);
-                missingVars = plugins.lodash.concat(missingVars, localMissingVars);
-                missingVars = plugins.lodash.uniq(missingVars);
-            }
-            return missingVars;
-        });
-    }
-}
-exports.ScafTemplate = ScafTemplate;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmNsYXNzZXMuc21hcnRzY2FmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzY2FmLmNsYXNzZXMuc21hcnRzY2FmLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSwrQ0FBOEM7QUFXOUM7SUFBQTtRQU1FLHFCQUFnQixHQUFhLEVBQUUsQ0FBQTtJQTZEakMsQ0FBQztJQTNEQzs7T0FFRztJQUNHLG1CQUFtQixDQUFFLFVBQWtCOztZQUMzQyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQTtZQUM5QyxJQUFJLENBQUMsc0JBQXNCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLEVBQUUsTUFBTSxDQUFDLENBQUE7WUFDMUYsSUFBSSxDQUFDLHdCQUF3QixFQUFFLENBQUE7UUFDakMsQ0FBQztLQUFBO0lBRUQ7OztPQUdHO0lBQ0csZUFBZSxDQUFFLFlBQVk7O1lBQ2pDLElBQUksQ0FBQyxpQkFBaUIsR0FBRyxZQUFZLENBQUE7WUFDckMsSUFBSSxDQUFDLGdCQUFnQixHQUFHLE1BQU0sSUFBSSxDQUFDLHVCQUF1QixFQUFFLENBQUE7UUFDOUQsQ0FBQztLQUFBO0lBRUQ7O09BRUc7SUFDRyx5QkFBeUI7O1lBQzdCLElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxNQUFNLElBQUksQ0FBQyx1QkFBdUIsRUFBRSxDQUFBO1lBQzVELElBQUksa0JBQWtCLEdBQUcsSUFBSSxPQUFPLENBQUMsYUFBYSxDQUFDLGFBQWEsRUFBRSxDQUFBO1lBQ2xFLEdBQUcsQ0FBQyxDQUFDLElBQUksZUFBZSxJQUFJLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUM7Z0JBQ2xELGtCQUFrQixDQUFDLFlBQVksQ0FBQyxDQUFDO3dCQUMvQixJQUFJLEVBQUUsZUFBZTt3QkFDckIsSUFBSSxFQUFFLE9BQU87d0JBQ2IsT0FBTyxFQUFFLGFBQWEsZUFBZSxFQUFFO3dCQUN2QyxPQUFPLEVBQUUsd0JBQXdCLGVBQWUsR0FBRztxQkFDcEQsQ0FBQyxDQUFDLENBQUE7WUFDTCxDQUFDO1lBQ0QsSUFBSSxPQUFPLEdBQUcsTUFBTSxrQkFBa0IsQ0FBQyxRQUFRLEVBQUUsQ0FBQTtRQUNuRCxDQUFDO0tBQUE7SUFFRDs7T0FFRztJQUNXLHdCQUF3Qjs7WUFDcEMsR0FBRyxDQUFDLENBQUMsSUFBSSxjQUFjLElBQUksSUFBSSxDQUFDLHNCQUFzQixDQUFDLENBQUMsQ0FBQztZQUV6RCxDQUFDO1FBQ0gsQ0FBQztLQUFBO0lBRUQ7O09BRUc7SUFDVyx1QkFBdUI7O1lBQ25DLElBQUksV0FBVyxHQUFhLEVBQUUsQ0FBQTtZQUM5QixHQUFHLENBQUMsQ0FBQyxJQUFJLGlCQUFpQixJQUFJLElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDLENBQUM7Z0JBQzFELElBQUksZ0JBQWdCLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLHFCQUFxQixDQUNqRSxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLEVBQ3JDLElBQUksQ0FBQyxpQkFBaUIsQ0FDdkIsQ0FBQTtnQkFDRCxXQUFXLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsV0FBVyxFQUFFLGdCQUFnQixDQUFDLENBQUE7Z0JBQ2xFLFdBQVcsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQTtZQUNoRCxDQUFDO1lBQ0QsTUFBTSxDQUFDLFdBQVcsQ0FBQTtRQUNwQixDQUFDO0tBQUE7Q0FDRjtBQW5FRCxvQ0FtRUMifQ==

dist/smartscaf.helpers.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmhlbHBlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

dist/smartscaf.plugins.d.ts

@@ -1,8 +0,0 @@
-import 'typings-global';
-import * as lodash from 'lodash';
-import * as path from 'path';
-import * as smartfile from 'smartfile';
-import * as smarthbs from 'smarthbs';
-import * as smartinteract from 'smartinteract';
-import * as smartq from 'smartq';
-export { lodash, path, smartfile, smarthbs, smartinteract, smartq };

dist/smartscaf.plugins.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require("typings-global");
-const lodash = require("lodash");
-exports.lodash = lodash;
-const path = require("path");
-exports.path = path;
-const smartfile = require("smartfile");
-exports.smartfile = smartfile;
-const smarthbs = require("smarthbs");
-exports.smarthbs = smarthbs;
-const smartinteract = require("smartinteract");
-exports.smartinteract = smartinteract;
-const smartq = require("smartq");
-exports.smartq = smartq;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUN2QixpQ0FBZ0M7QUFROUIsd0JBQU07QUFQUiw2QkFBNEI7QUFRMUIsb0JBQUk7QUFQTix1Q0FBc0M7QUFRcEMsOEJBQVM7QUFQWCxxQ0FBb0M7QUFRbEMsNEJBQVE7QUFQViwrQ0FBOEM7QUFRNUMsc0NBQWE7QUFQZixpQ0FBZ0M7QUFROUIsd0JBQU0ifQ==

npmextra.json

@@ -3,8 +3,18 @@
     "coverageTreshold": 30
   },
   "npmci": {
-    "globalNpmTools": [
-      "npmts"
-    ]
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartscaf",
+      "description": "scaffold projects quickly",
+      "npmPackagename": "@pushrocks/smartscaf",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,11 +1,14 @@
 {
-  "name": "smartscaf",
-  "version": "1.0.1",
+  "name": "@pushrocks/smartscaf",
+  "version": "4.0.4",
+  "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": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -23,15 +26,37 @@
     "npm"
   ],
   "devDependencies": {
-    "tapbundle": "^1.0.10"
+    "@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": {
-    "@types/lodash": "^4.14.63",
-    "lodash": "^4.17.4",
-    "smartfile": "^4.2.9",
-    "smarthbs": "^1.0.12",
-    "smartinteract": "^1.0.4",
-    "smartq": "^1.1.1",
-    "typings-global": "^1.0.16"
-  }
+    "@pushrocks/lik": "^6.0.2",
+    "@pushrocks/smartfile": "^10.0.17",
+    "@pushrocks/smartfm": "^2.0.4",
+    "@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

@@ -1,29 +1,46 @@
-# smartscaf
+# @pushrocks/smartscaf
 scaffold projects quickly
 
-## Availabililty
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartscaf)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartscaf)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartscaf)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartscaf/)
+## Availabililty and Links
+* [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
-[![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/smartscaf.svg)](https://www.npmjs.com/package/smartscaf)
-[![Dependency Status](https://david-dm.org/pushrocks/smartscaf.svg)](https://david-dm.org/pushrocks/smartscaf)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartscaf/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartscaf/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartscaf/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartscaf)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.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)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
+
 Use TypeScript for best in class instellisense.
 
 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)
+> | 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://)
+
+## 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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,26 +1,37 @@
-import { expect, tap } from 'tapbundle'
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as path from 'path';
 
-import * as smartscaf from '../dist/index'
+import * as smartscaf from '../ts/index.js';
 
-let testScafTemplate: smartscaf.ScafTemplate
+process.env.CI = 'true';
+
+let testScafTemplate: smartscaf.ScafTemplate;
 
 tap.test('should create new Smartscaf instance', async () => {
-  testScafTemplate = new smartscaf.ScafTemplate()
-  expect(testScafTemplate).to.be.instanceof(smartscaf.ScafTemplate)
-})
+  testScafTemplate = new smartscaf.ScafTemplate('./test/test_template');
+  expect(testScafTemplate).toBeInstanceOf(smartscaf.ScafTemplate);
+});
 
 tap.test('Smartscaf instance -> should read a template directory', async () => {
-  await testScafTemplate.readTemplateFromDir('./test/test_template')
-  expect(testScafTemplate.templateSmartfileArray.length).to.equal(3)
-})
+  await testScafTemplate.readTemplateFromDir();
+  expect(testScafTemplate.templateSmartfileArray.length).toEqual(6);
+});
 
 tap.test('smartfile -> should accept variables', async () => {
-  await testScafTemplate.supplyVariables({})
-  console.log(testScafTemplate.missingVariables)
-})
+  await testScafTemplate.supplyVariables({});
+  console.log(testScafTemplate.missingVariables);
+});
 
 tap.test('ask cli', async () => {
-  await testScafTemplate.askCliForMissingVariables()
-})
+  await testScafTemplate.askCliForMissingVariables();
+});
 
-tap.start()
+tap.test('should have valid supplied variables', async () => {
+  console.log(testScafTemplate.suppliedVariables);
+});
+
+tap.test('should output ready rendered template', async () => {
+  await testScafTemplate.writeToDisk(path.resolve('./test/test_output'));
+});
+
+tap.start();

test/test_output/changedname.md

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

test/test_output/hello.md

@@ -0,0 +1 @@
+# param1 10

test/test_output/notemplate.yml

@@ -0,0 +1 @@
+awesome!

test/test_output/template1.md

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

test/test_output/template2.md

@@ -0,0 +1,3 @@
+# 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

@@ -0,0 +1,13 @@
+defaults:
+  templateVar1: from default yaml
+  templateVar2: this is another value from yml
+  templateObject.value1: wow
+  templateObject.value2: here
+  node_version: '10'
+
+dependencies:
+  merge:
+    - ../test_template_2
+
+runafter:
+  - npm install

test/test_template/notemplate.yml

@@ -0,0 +1 @@
+awesome!

test/test_template/template1.md

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

test/test_template/template3.md

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

test/test_template_2/hello.md

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

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartscaf',
+  version: '4.0.4',
+  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,79 +1,266 @@
-import * as plugins from './smartscaf.plugins'
+import * as plugins from './smartscaf.plugins.js';
+import * as interfaces from './interfaces/index.js';
 
 // interfaces
-import { Smartfile } from 'smartfile'
+import { Smartfile } from '@pushrocks/smartfile';
 
 export interface ScafTemplateContructorOptions {
-  name?: string,
-  description?: string
-  sourceDir?: string
+  name?: string;
+  description?: string;
+  sourceDir?: string;
 }
 
 export class ScafTemplate {
-  name: string
-  description: string
-  templateSmartfileArray: Smartfile[]
-  requiredVariables: string[]
-  suppliedVariables: any
-  missingVariables: string[] = []
+  public static async createTemplateFromDir(dirPathArg: string) {
+    return new ScafTemplate(dirPathArg);
+  }
+
+  /**
+   * the name of the template
+   */
+  public name: string;
+
+  /**
+   * the descriptions of the template
+   */
+  public description: string;
+
+  /**
+   * the location on disk of the template
+   */
+  public dirPath: string;
+  public destinationPath: string;
+
+  /**
+   * smartscafFile
+   */
+  public smartscafFile: interfaces.ISmartscafFile;
+
+  /**
+   * the files of the template as array of Smartfiles
+   */
+  public templateSmartfileArray: Smartfile[];
+  public requiredVariables: string[];
+  public defaultVariables: any;
+  public suppliedVariables: any = {};
+  public missingVariables: string[] = [];
+
+  constructor(dirPathArg: string) {
+    this.dirPath = plugins.path.resolve(dirPathArg);
+  }
 
   /**
    * read a template from a directory
    */
-  async readTemplateFromDir (dirPathArg: string) {
-    let dirPath = plugins.path.resolve(dirPathArg)
-    this.templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(dirPath, '**/*')
-    this._findVariablesInTemplate()
+  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();
+    await this._checkDefaultVariables();
   }
 
   /**
    * supply the variables to render the teplate with
-   * @param variablesArg
+   * @param variablesArg gets merged with this.suppliedVariables
    */
-  async supplyVariables (variablesArg) {
-    this.suppliedVariables = variablesArg
-    this.missingVariables = await this._checkSuppliedVariables()
+  public async supplyVariables(variablesArg) {
+    this.suppliedVariables = {
+      ...this.suppliedVariables,
+      ...variablesArg,
+    };
+    this.missingVariables = await this._checkSuppliedVariables();
   }
 
   /**
    * Will ask for the missing variables by cli interaction
    */
-  async askCliForMissingVariables () {
-    this.missingVariables = await this._checkSuppliedVariables()
-    let localSmartInteract = new plugins.smartinteract.SmartInteract()
-    for (let missingVariable of this.missingVariables) {
-      localSmartInteract.addQuestions([{
-        name: missingVariable,
-        type: 'input',
-        default: `undefined ${missingVariable}`,
-        message: `What is the value of ${missingVariable}?`
-      }])
+  public async askCliForMissingVariables() {
+    this.missingVariables = await this._checkSuppliedVariables();
+    const localSmartInteract = new plugins.smartinteract.SmartInteract();
+    for (const missingVariable of this.missingVariables) {
+      localSmartInteract.addQuestions([
+        {
+          name: missingVariable,
+          type: 'input',
+          default: (() => {
+            if (this.defaultVariables && this.defaultVariables[missingVariable]) {
+              return this.defaultVariables[missingVariable];
+            } else {
+              return 'undefined variable';
+            }
+          })(),
+          message: `What is the value of ${missingVariable}?`,
+        },
+      ]);
+    }
+    const answerBucket = await localSmartInteract.runQueue();
+    const answers = answerBucket.getAllAnswers();
+    for (const answer of answers) {
+      await plugins.smartparam.smartAdd(this.suppliedVariables, answer.name, answer.value);
     }
-    let answers = await localSmartInteract.runQueue()
   }
 
   /**
-   * finds all variables in a Template
+   * writes a file to disk
+   * @param destinationDirArg
+   */
+  public async writeToDisk(destinationDirArg) {
+    this.destinationPath = destinationDirArg;
+    const smartfileArrayToWrite: Smartfile[] = [];
+    for (const smartfile of this.templateSmartfileArray) {
+      // lets filter out template files
+      if (smartfile.path === '.smartscaf.yml') {
+        continue;
+      }
+
+      // render the template
+      const template = await plugins.smarthbs.getTemplateForString(smartfile.contents.toString());
+      const renderedTemplateString = template(this.suppliedVariables);
+
+      // handle frontmatter
+      const smartfmInstance = new plugins.smartfm.Smartfm({
+        fmType: 'yaml',
+      });
+      const parsedTemplate = smartfmInstance.parse(renderedTemplateString) as any;
+      if (parsedTemplate.data.fileName) {
+        smartfile.updateFileName(parsedTemplate.data.fileName);
+      }
+
+      smartfile.contents = Buffer.from(parsedTemplate.content);
+      smartfileArrayToWrite.push(smartfile);
+    }
+
+    await plugins.smartfile.memory.smartfileArrayToFs(smartfileArrayToWrite, destinationDirArg);
+    await this.runScripts();
+  }
+
+  /**
+   * finds all variables in a Template in as string
+   * e.g. myobject.someKey and myobject.someOtherKey
    */
   private async _findVariablesInTemplate() {
-    for (let localSmartfile of this.templateSmartfileArray) {
-
+    let templateVariables: string[] = [];
+    for (const templateSmartfile of this.templateSmartfileArray) {
+      const localTemplateVariables = await plugins.smarthbs.findVarsInHbsString(
+        templateSmartfile.contents.toString()
+      );
+      templateVariables = [...templateVariables, ...localTemplateVariables];
     }
+    templateVariables = templateVariables.filter((value, index, self) => {
+      return self.indexOf(value) === index;
+    });
   }
 
   /**
    * checks if supplied Variables satisfy the template
    */
   private async _checkSuppliedVariables() {
-    let missingVars: string[] = []
-    for (let templateSmartFile of this.templateSmartfileArray) {
-      let localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
-        templateSmartFile.contents.toString(),
+    let missingVars: string[] = [];
+    for (const templateSmartfile of this.templateSmartfileArray) {
+      const localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
+        templateSmartfile.contents.toString(),
         this.suppliedVariables
-      )
-      missingVars = plugins.lodash.concat(missingVars, localMissingVars)
-      missingVars = plugins.lodash.uniq(missingVars)
+      );
+
+      // combine with other missingVars
+      missingVars = [...missingVars, ...localMissingVars];
+    }
+
+    // dedupe
+    missingVars = missingVars.filter((value, index, self) => {
+      return self.indexOf(value) === index;
+    });
+    return missingVars;
+  }
+
+  /**
+   * 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 async _checkDefaultVariables() {
+    const smartscafSmartfile = this.templateSmartfileArray.find((smartfileArg) => {
+      return smartfileArg.parsedPath.base === '.smartscaf.yml';
+    });
+
+    if (smartscafSmartfile) {
+      const smartscafObject = await plugins.smartyaml.yamlStringToObject(
+        smartscafSmartfile.contents.toString()
+      );
+      const defaultObject = smartscafObject.defaults;
+      this.defaultVariables = defaultObject;
+    }
+
+    // safeguard against non existent defaults
+    if (!this.defaultVariables) {
+      console.log('this template does not specify defaults');
+      this.defaultVariables = {};
+    }
+  }
+
+  /**
+   * resolve template dependencies
+   */
+  private async _resolveTemplateDependencies() {
+    console.log('looking at templates to 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)) {
+        console.log(
+          `dependency ${dependency} resolves to ${templatePathToMerge} which ist NOT a directory`
+        );
+        continue;
+      }
+      const templateSmartfileArray = 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.exec(`cd ${this.destinationPath} && ${command}`);
     }
-    return missingVars
   }
 }

ts/smartscaf.helpers.ts

@@ -1,2 +0,0 @@
-import * as plugins from './smartscaf.plugins'
-

ts/smartscaf.plugins.ts

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

tsconfig.json

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

tslint.json

@@ -1,3 +0,0 @@
-{
-    "extends": "tslint-config-standard"
-}