1.0.14

dist/smartscaf.classes.smartscaf.d.ts

@@ -9,6 +9,7 @@ export declare class ScafTemplate {
     description: string;
     templateSmartfileArray: Smartfile[];
     requiredVariables: string[];
+    defaultVariables: any;
     suppliedVariables: any;
     missingVariables: string[];
     /**
@@ -17,19 +18,34 @@ export declare class ScafTemplate {
     readTemplateFromDir(dirPathArg: string): Promise<void>;
     /**
      * supply the variables to render the teplate with
-     * @param variablesArg
+     * @param variablesArg gets merged with this.suppliedVariables
      */
     supplyVariables(variablesArg: any): Promise<void>;
     /**
      * Will ask for the missing variables by cli interaction
      */
     askCliForMissingVariables(): Promise<void>;
+    writeToDisk(destinationDirArg: any): Promise<void>;
     /**
-     * finds all variables in a Template
+     * 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 default.yml at the root of a template for default variables
+     * 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();
 }

dist/smartscaf.classes.smartscaf.js

@@ -9,8 +9,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const plugins = require("./smartscaf.plugins");
+const helpers = require("./smartscaf.helpers");
 class ScafTemplate {
     constructor() {
+        this.suppliedVariables = {};
         this.missingVariables = [];
     }
     /**
@@ -20,16 +22,18 @@ class ScafTemplate {
         return __awaiter(this, void 0, void 0, function* () {
             let dirPath = plugins.path.resolve(dirPathArg);
             this.templateSmartfileArray = yield plugins.smartfile.fs.fileTreeToObject(dirPath, '**/*');
-            this._findVariablesInTemplate();
+            yield this._findVariablesInTemplate();
+            yield this._checkSuppliedVariables();
+            yield this._checkDefaultVariables();
         });
     }
     /**
      * supply the variables to render the teplate with
-     * @param variablesArg
+     * @param variablesArg gets merged with this.suppliedVariables
      */
     supplyVariables(variablesArg) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.suppliedVariables = variablesArg;
+            this.suppliedVariables = plugins.lodash.merge(this.suppliedVariables, variablesArg);
             this.missingVariables = yield this._checkSuppliedVariables();
         });
     }
@@ -44,20 +48,52 @@ class ScafTemplate {
                 localSmartInteract.addQuestions([{
                         name: missingVariable,
                         type: 'input',
-                        default: `undefined ${missingVariable}`,
+                        default: (() => {
+                            if (this.defaultVariables && this.defaultVariables[missingVariable]) {
+                                return this.defaultVariables[missingVariable];
+                            }
+                            else {
+                                return 'undefined variable';
+                            }
+                        })(),
                         message: `What is the value of ${missingVariable}?`
                     }]);
             }
-            let answers = yield localSmartInteract.runQueue();
+            let answerBucket = yield localSmartInteract.runQueue();
+            answerBucket.answerMap.forEach((answer) => __awaiter(this, void 0, void 0, function* () {
+                yield helpers.deepAddToObject(this.suppliedVariables, answer.name, answer.value);
+            }));
+        });
+    }
+    writeToDisk(destinationDirArg) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let smartfileArrayToWrite = plugins.lodash.cloneDeep(this.templateSmartfileArray);
+            for (let smartfile of smartfileArrayToWrite) {
+                // render the template
+                let template = yield plugins.smarthbs.getTemplateForString(smartfile.contents.toString());
+                let renderedTemplateString = template(this.suppliedVariables);
+                // handle frontmatter
+                let parsedTemplate = plugins.smartfm.parse(renderedTemplateString);
+                if (parsedTemplate.data.fileName) {
+                    smartfile.updateFileName(parsedTemplate.data.fileName);
+                }
+                smartfile.contents = Buffer.from(parsedTemplate.content);
+            }
+            yield plugins.smartfile.memory.smartfileArrayToFs(smartfileArrayToWrite, destinationDirArg);
         });
     }
     /**
-     * finds all variables in a Template
+     * finds all variables in a Template in as string
+     * e.g. myobject.someKey and myobject.someOtherKey
      */
     _findVariablesInTemplate() {
         return __awaiter(this, void 0, void 0, function* () {
-            for (let localSmartfile of this.templateSmartfileArray) {
+            let templateVariables = [];
+            for (let templateSmartfile of this.templateSmartfileArray) {
+                let localTemplateVariables = yield plugins.smarthbs.findVarsInHbsString(templateSmartfile.contents.toString());
+                templateVariables = plugins.lodash.concat(templateVariables, localTemplateVariables);
             }
+            templateVariables = plugins.lodash.uniq(templateVariables);
         });
     }
     /**
@@ -66,14 +102,40 @@ class ScafTemplate {
     _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);
+            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);
             }
+            missingVars = plugins.lodash.uniq(missingVars);
             return missingVars;
         });
     }
+    /**
+     * checks the default.yml at the root of a template for default variables
+     * allows 2 ways of notation in YAML:
+     * >> myObject.myKey.someDeeperKey: someValue
+     * >> myObject.yourKey.yourDeeperKey: yourValue
+     * or
+     * >> myObject:
+     * >>   - someKey:
+     * >>     - someDeeperKey: someValue
+     * >>   - yourKey:
+     * >>     - yourDeeperKey: yourValue
+     */
+    _checkDefaultVariables() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let defaultsSmartfile = this.templateSmartfileArray.filter(smartfileArg => {
+                return smartfileArg.parsedPath.base === 'defaults.yml';
+            })[0];
+            if (defaultsSmartfile) {
+                let defaultObject = yield plugins.smartyaml.yamlStringToObject(defaultsSmartfile.contents.toString());
+                this.defaultVariables = defaultObject;
+            }
+            else {
+                this.defaultVariables = {};
+            }
+        });
+    }
 }
 exports.ScafTemplate = ScafTemplate;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmNsYXNzZXMuc21hcnRzY2FmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzY2FmLmNsYXNzZXMuc21hcnRzY2FmLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSwrQ0FBOEM7QUFXOUM7SUFBQTtRQU1FLHFCQUFnQixHQUFhLEVBQUUsQ0FBQTtJQTZEakMsQ0FBQztJQTNEQzs7T0FFRztJQUNHLG1CQUFtQixDQUFFLFVBQWtCOztZQUMzQyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQTtZQUM5QyxJQUFJLENBQUMsc0JBQXNCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLEVBQUUsTUFBTSxDQUFDLENBQUE7WUFDMUYsSUFBSSxDQUFDLHdCQUF3QixFQUFFLENBQUE7UUFDakMsQ0FBQztLQUFBO0lBRUQ7OztPQUdHO0lBQ0csZUFBZSxDQUFFLFlBQVk7O1lBQ2pDLElBQUksQ0FBQyxpQkFBaUIsR0FBRyxZQUFZLENBQUE7WUFDckMsSUFBSSxDQUFDLGdCQUFnQixHQUFHLE1BQU0sSUFBSSxDQUFDLHVCQUF1QixFQUFFLENBQUE7UUFDOUQsQ0FBQztLQUFBO0lBRUQ7O09BRUc7SUFDRyx5QkFBeUI7O1lBQzdCLElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxNQUFNLElBQUksQ0FBQyx1QkFBdUIsRUFBRSxDQUFBO1lBQzVELElBQUksa0JBQWtCLEdBQUcsSUFBSSxPQUFPLENBQUMsYUFBYSxDQUFDLGFBQWEsRUFBRSxDQUFBO1lBQ2xFLEdBQUcsQ0FBQyxDQUFDLElBQUksZUFBZSxJQUFJLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUM7Z0JBQ2xELGtCQUFrQixDQUFDLFlBQVksQ0FBQyxDQUFDO3dCQUMvQixJQUFJLEVBQUUsZUFBZTt3QkFDckIsSUFBSSxFQUFFLE9BQU87d0JBQ2IsT0FBTyxFQUFFLGFBQWEsZUFBZSxFQUFFO3dCQUN2QyxPQUFPLEVBQUUsd0JBQXdCLGVBQWUsR0FBRztxQkFDcEQsQ0FBQyxDQUFDLENBQUE7WUFDTCxDQUFDO1lBQ0QsSUFBSSxPQUFPLEdBQUcsTUFBTSxrQkFBa0IsQ0FBQyxRQUFRLEVBQUUsQ0FBQTtRQUNuRCxDQUFDO0tBQUE7SUFFRDs7T0FFRztJQUNXLHdCQUF3Qjs7WUFDcEMsR0FBRyxDQUFDLENBQUMsSUFBSSxjQUFjLElBQUksSUFBSSxDQUFDLHNCQUFzQixDQUFDLENBQUMsQ0FBQztZQUV6RCxDQUFDO1FBQ0gsQ0FBQztLQUFBO0lBRUQ7O09BRUc7SUFDVyx1QkFBdUI7O1lBQ25DLElBQUksV0FBVyxHQUFhLEVBQUUsQ0FBQTtZQUM5QixHQUFHLENBQUMsQ0FBQyxJQUFJLGlCQUFpQixJQUFJLElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDLENBQUM7Z0JBQzFELElBQUksZ0JBQWdCLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLHFCQUFxQixDQUNqRSxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLEVBQ3JDLElBQUksQ0FBQyxpQkFBaUIsQ0FDdkIsQ0FBQTtnQkFDRCxXQUFXLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsV0FBVyxFQUFFLGdCQUFnQixDQUFDLENBQUE7Z0JBQ2xFLFdBQVcsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQTtZQUNoRCxDQUFDO1lBQ0QsTUFBTSxDQUFDLFdBQVcsQ0FBQTtRQUNwQixDQUFDO0tBQUE7Q0FDRjtBQW5FRCxvQ0FtRUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmNsYXNzZXMuc21hcnRzY2FmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzY2FmLmNsYXNzZXMuc21hcnRzY2FmLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSwrQ0FBOEM7QUFDOUMsK0NBQThDO0FBVzlDO0lBQUE7UUFNRSxzQkFBaUIsR0FBUSxFQUFFLENBQUE7UUFDM0IscUJBQWdCLEdBQWEsRUFBRSxDQUFBO0lBOEhqQyxDQUFDO0lBNUhDOztPQUVHO0lBQ0csbUJBQW1CLENBQUUsVUFBa0I7O1lBQzNDLElBQUksT0FBTyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1lBQzlDLElBQUksQ0FBQyxzQkFBc0IsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsQ0FBQTtZQUMxRixNQUFNLElBQUksQ0FBQyx3QkFBd0IsRUFBRSxDQUFBO1lBQ3JDLE1BQU0sSUFBSSxDQUFDLHVCQUF1QixFQUFFLENBQUE7WUFDcEMsTUFBTSxJQUFJLENBQUMsc0JBQXNCLEVBQUUsQ0FBQTtRQUNyQyxDQUFDO0tBQUE7SUFFRDs7O09BR0c7SUFDRyxlQUFlLENBQUUsWUFBWTs7WUFDakMsSUFBSSxDQUFDLGlCQUFpQixHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxpQkFBaUIsRUFBRSxZQUFZLENBQUMsQ0FBQTtZQUNuRixJQUFJLENBQUMsZ0JBQWdCLEdBQUcsTUFBTSxJQUFJLENBQUMsdUJBQXVCLEVBQUUsQ0FBQTtRQUM5RCxDQUFDO0tBQUE7SUFFRDs7T0FFRztJQUNHLHlCQUF5Qjs7WUFDN0IsSUFBSSxDQUFDLGdCQUFnQixHQUFHLE1BQU0sSUFBSSxDQUFDLHVCQUF1QixFQUFFLENBQUE7WUFDNUQsSUFBSSxrQkFBa0IsR0FBRyxJQUFJLE9BQU8sQ0FBQyxhQUFhLENBQUMsYUFBYSxFQUFFLENBQUE7WUFDbEUsR0FBRyxDQUFDLENBQUMsSUFBSSxlQUFlLElBQUksSUFBSSxDQUFDLGdCQUFnQixDQUFDLENBQUMsQ0FBQztnQkFDbEQsa0JBQWtCLENBQUMsWUFBWSxDQUFDLENBQUM7d0JBQy9CLElBQUksRUFBRSxlQUFlO3dCQUNyQixJQUFJLEVBQUUsT0FBTzt3QkFDYixPQUFPLEVBQUUsQ0FBQzs0QkFDUixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLElBQUksSUFBSSxDQUFDLGdCQUFnQixDQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUMsQ0FBQztnQ0FDcEUsTUFBTSxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxlQUFlLENBQUMsQ0FBQTs0QkFDL0MsQ0FBQzs0QkFBQyxJQUFJLENBQUMsQ0FBQztnQ0FDTixNQUFNLENBQUMsb0JBQW9CLENBQUE7NEJBQzdCLENBQUM7d0JBQ0gsQ0FBQyxDQUFDLEVBQUU7d0JBQ0osT0FBTyxFQUFFLHdCQUF3QixlQUFlLEdBQUc7cUJBQ3BELENBQUMsQ0FBQyxDQUFBO1lBQ0wsQ0FBQztZQUNELElBQUksWUFBWSxHQUFHLE1BQU0sa0JBQWtCLENBQUMsUUFBUSxFQUFFLENBQUE7WUFDdEQsWUFBWSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBTSxNQUFNO2dCQUN6QyxNQUFNLE9BQU8sQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLGlCQUFpQixFQUFFLE1BQU0sQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFBO1lBQ2xGLENBQUMsQ0FBQSxDQUFDLENBQUE7UUFFSixDQUFDO0tBQUE7SUFFSyxXQUFXLENBQUUsaUJBQWlCOztZQUNsQyxJQUFJLHFCQUFxQixHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxDQUFBO1lBQ2pGLEdBQUcsQ0FBQyxDQUFDLElBQUksU0FBUyxJQUFJLHFCQUFxQixDQUFDLENBQUMsQ0FBQztnQkFFNUMsc0JBQXNCO2dCQUN0QixJQUFJLFFBQVEsR0FBRyxNQUFNLE9BQU8sQ0FBQyxRQUFRLENBQUMsb0JBQW9CLENBQ3hELFNBQVMsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLENBQzlCLENBQUE7Z0JBQ0QsSUFBSSxzQkFBc0IsR0FBRyxRQUFRLENBQUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDLENBQUE7Z0JBRTdELHFCQUFxQjtnQkFDckIsSUFBSSxjQUFjLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsc0JBQXNCLENBQUMsQ0FBQTtnQkFDbEUsRUFBRSxDQUFDLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO29CQUNqQyxTQUFTLENBQUMsY0FBYyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUE7Z0JBQ3hELENBQUM7Z0JBRUQsU0FBUyxDQUFDLFFBQVEsR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxPQUFPLENBQUMsQ0FBQTtZQUMxRCxDQUFDO1lBRUQsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQyxrQkFBa0IsQ0FBQyxxQkFBcUIsRUFBRSxpQkFBaUIsQ0FBQyxDQUFBO1FBQzdGLENBQUM7S0FBQTtJQUVEOzs7T0FHRztJQUNXLHdCQUF3Qjs7WUFDcEMsSUFBSSxpQkFBaUIsR0FBYSxFQUFFLENBQUE7WUFDcEMsR0FBRyxDQUFDLENBQUMsSUFBSSxpQkFBaUIsSUFBSSxJQUFJLENBQUMsc0JBQXNCLENBQUMsQ0FBQyxDQUFDO2dCQUMxRCxJQUFJLHNCQUFzQixHQUFHLE1BQU0sT0FBTyxDQUFDLFFBQVEsQ0FBQyxtQkFBbUIsQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQTtnQkFDOUcsaUJBQWlCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsaUJBQWlCLEVBQUUsc0JBQXNCLENBQUMsQ0FBQTtZQUN0RixDQUFDO1lBQ0QsaUJBQWlCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQTtRQUM1RCxDQUFDO0tBQUE7SUFFRDs7T0FFRztJQUNXLHVCQUF1Qjs7WUFDbkMsSUFBSSxXQUFXLEdBQWEsRUFBRSxDQUFBO1lBQzlCLEdBQUcsQ0FBQyxDQUFDLElBQUksaUJBQWlCLElBQUksSUFBSSxDQUFDLHNCQUFzQixDQUFDLENBQUMsQ0FBQztnQkFDMUQsSUFBSSxnQkFBZ0IsR0FBRyxNQUFNLE9BQU8sQ0FBQyxRQUFRLENBQUMscUJBQXFCLENBQ2pFLGlCQUFpQixDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUUsRUFDckMsSUFBSSxDQUFDLGlCQUFpQixDQUN2QixDQUFBO2dCQUNELFdBQVcsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxXQUFXLEVBQUUsZ0JBQWdCLENBQUMsQ0FBQTtZQUNwRSxDQUFDO1lBQ0QsV0FBVyxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFBO1lBQzlDLE1BQU0sQ0FBQyxXQUFXLENBQUE7UUFDcEIsQ0FBQztLQUFBO0lBRUQ7Ozs7Ozs7Ozs7O09BV0c7SUFDVyxzQkFBc0I7O1lBQ2xDLElBQUksaUJBQWlCLEdBQUcsSUFBSSxDQUFDLHNCQUFzQixDQUFDLE1BQU0sQ0FBQyxZQUFZO2dCQUNyRSxNQUFNLENBQUMsWUFBWSxDQUFDLFVBQVUsQ0FBQyxJQUFJLEtBQUssY0FBYyxDQUFBO1lBQ3hELENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFBO1lBRUwsRUFBRSxDQUFDLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxDQUFDO2dCQUN0QixJQUFJLGFBQWEsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsa0JBQWtCLENBQzVELGlCQUFpQixDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUUsQ0FDdEMsQ0FBQTtnQkFDRCxJQUFJLENBQUMsZ0JBQWdCLEdBQUcsYUFBYSxDQUFBO1lBQ3ZDLENBQUM7WUFBQyxJQUFJLENBQUMsQ0FBQztnQkFDTixJQUFJLENBQUMsZ0JBQWdCLEdBQUcsRUFBRSxDQUFBO1lBQzVCLENBQUM7UUFDSCxDQUFDO0tBQUE7Q0FDRjtBQXJJRCxvQ0FxSUMifQ==

dist/smartscaf.helpers.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 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,3 +1,43 @@
 "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 });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmhlbHBlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=
+/**
+ * adds a variable in string dot notation to an already more or less expanded object
+ */
+exports.deepAddToObject = (objectArg, varStringArg, valueArg) => __awaiter(this, void 0, void 0, function* () {
+    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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLmhlbHBlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBRUE7O0dBRUc7QUFDUSxRQUFBLGVBQWUsR0FBRyxDQUFPLFNBQVMsRUFBRSxZQUFvQixFQUFFLFFBQWdCO0lBQ25GLElBQUksYUFBYSxHQUFHLFlBQVksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUE7SUFDM0MsSUFBSSxnQkFBZ0IsR0FBRyxTQUFTLENBQUE7SUFDaEMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsS0FBSyxhQUFhLENBQUMsTUFBTSxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUM7UUFDaEQsSUFBSSxPQUFPLEdBQUcsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFBO1FBRTlCLDZCQUE2QjtRQUM3QixJQUFJLFdBQVcsR0FBVyxDQUFDO1lBQ3pCLEVBQUUsQ0FBQyxDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUN6QixNQUFNLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQTtZQUM3QixDQUFDO1lBQ0QsTUFBTSxDQUFDLElBQUksQ0FBQTtRQUNiLENBQUMsQ0FBQyxFQUFFLENBQUE7UUFFSixzQ0FBc0M7UUFDdEMsRUFBRSxDQUFDLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDL0MsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLEdBQUcsUUFBUSxDQUFBO1lBQ3BDLGdCQUFnQixHQUFHLElBQUksQ0FBQTtRQUN6QixDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLElBQUksV0FBVyxDQUFDLENBQUMsQ0FBQztZQUNyRCxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7WUFDOUIsZ0JBQWdCLEdBQUcsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLENBQUE7UUFDOUMsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQ3BELGdCQUFnQixHQUFHLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxDQUFBO1FBQzlDLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLE1BQU0sSUFBSSxLQUFLLENBQUMsdUJBQXVCLENBQUMsQ0FBQTtRQUMxQyxDQUFDO0lBQ0gsQ0FBQztBQUNILENBQUMsQ0FBQSxDQUFBIn0=

dist/smartscaf.plugins.d.ts

@@ -2,7 +2,9 @@ import 'typings-global';
 import * as lodash from 'lodash';
 import * as path from 'path';
 import * as smartfile from 'smartfile';
+import * as smartfm from 'smartfm';
 import * as smarthbs from 'smarthbs';
 import * as smartinteract from 'smartinteract';
 import * as smartq from 'smartq';
-export { lodash, path, smartfile, smarthbs, smartinteract, smartq };
+import * as smartyaml from 'smartyaml';
+export { lodash, path, smartfile, smartfm, smarthbs, smartinteract, smartq, smartyaml };

dist/smartscaf.plugins.js

@@ -7,10 +7,14 @@ const path = require("path");
 exports.path = path;
 const smartfile = require("smartfile");
 exports.smartfile = smartfile;
+const smartfm = require("smartfm");
+exports.smartfm = smartfm;
 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==
+const smartyaml = require("smartyaml");
+exports.smartyaml = smartyaml;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzY2FmLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNjYWYucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUN2QixpQ0FBZ0M7QUFVOUIsd0JBQU07QUFUUiw2QkFBNEI7QUFVMUIsb0JBQUk7QUFUTix1Q0FBc0M7QUFVcEMsOEJBQVM7QUFUWCxtQ0FBa0M7QUFVaEMsMEJBQU87QUFUVCxxQ0FBb0M7QUFVbEMsNEJBQVE7QUFUViwrQ0FBOEM7QUFVNUMsc0NBQWE7QUFUZixpQ0FBZ0M7QUFVOUIsd0JBQU07QUFUUix1Q0FBc0M7QUFVcEMsOEJBQVMifQ==

docs/index.md

@@ -0,0 +1,29 @@
+# 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/)
+
+## 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/)
+
+## 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)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://)

package.json

@@ -1,11 +1,12 @@
 {
   "name": "smartscaf",
-  "version": "1.0.1",
+  "version": "1.0.14",
   "description": "scaffold projects quickly",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(npmts)",
+    "testLocal": "(npmts --notest && ts-node --compilerOptions '{\"target\":\"es6\"}' test/test.ts)"
   },
   "repository": {
     "type": "git",
@@ -23,15 +24,17 @@
     "npm"
   ],
   "devDependencies": {
-    "tapbundle": "^1.0.10"
+    "tapbundle": "^1.1.1"
   },
   "dependencies": {
-    "@types/lodash": "^4.14.63",
+    "@types/lodash": "^4.14.72",
     "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"
+    "smartfile": "^4.2.20",
+    "smartfm": "^1.0.5",
+    "smarthbs": "^1.0.16",
+    "smartinteract": "^1.0.10",
+    "smartq": "^1.1.6",
+    "smartyaml": "^1.0.2",
+    "typings-global": "^1.0.20"
   }
 }

test/test.ts

@@ -1,6 +1,9 @@
 import { expect, tap } from 'tapbundle'
+import * as path from 'path'
 
-import * as smartscaf from '../dist/index'
+import * as smartscaf from '../ts/index'
+
+// process.env.CI = 'true'
 
 let testScafTemplate: smartscaf.ScafTemplate
 
@@ -11,7 +14,7 @@ tap.test('should create new Smartscaf instance', async () => {
 
 tap.test('Smartscaf instance -> should read a template directory', async () => {
   await testScafTemplate.readTemplateFromDir('./test/test_template')
-  expect(testScafTemplate.templateSmartfileArray.length).to.equal(3)
+  expect(testScafTemplate.templateSmartfileArray.length).to.equal(5)
 })
 
 tap.test('smartfile -> should accept variables', async () => {
@@ -23,4 +26,12 @@ tap.test('ask cli', async () => {
   await testScafTemplate.askCliForMissingVariables()
 })
 
+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/defaults.yml

@@ -0,0 +1,4 @@
+templateVar1: from default yaml
+templateVar2: this is another value from yml
+templateObject.value1: wow
+templateObject.value2: here

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/defaults.yml

@@ -0,0 +1,4 @@
+templateVar1: from default yaml
+templateVar2: this is another value from yml
+templateObject.value1: wow
+templateObject.value2: here

test/test_template/notemplate.yml

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

test/test_template/template1.md

@@ -1,3 +1,3 @@
-# this is a {{templateVar1}}
-# this is a {{templateVar2}}
+# 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}}

ts/smartscaf.classes.smartscaf.ts

@@ -1,4 +1,5 @@
 import * as plugins from './smartscaf.plugins'
+import * as helpers from './smartscaf.helpers'
 
 // interfaces
 import { Smartfile } from 'smartfile'
@@ -14,7 +15,8 @@ export class ScafTemplate {
   description: string
   templateSmartfileArray: Smartfile[]
   requiredVariables: string[]
-  suppliedVariables: any
+  defaultVariables: any
+  suppliedVariables: any = {}
   missingVariables: string[] = []
 
   /**
@@ -23,15 +25,17 @@ export class ScafTemplate {
   async readTemplateFromDir (dirPathArg: string) {
     let dirPath = plugins.path.resolve(dirPathArg)
     this.templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(dirPath, '**/*')
-    this._findVariablesInTemplate()
+    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.suppliedVariables = plugins.lodash.merge(this.suppliedVariables, variablesArg)
     this.missingVariables = await this._checkSuppliedVariables()
   }
 
@@ -45,35 +49,98 @@ export class ScafTemplate {
       localSmartInteract.addQuestions([{
         name: missingVariable,
         type: 'input',
-        default: `undefined ${missingVariable}`,
+        default: (() => {
+          if (this.defaultVariables && this.defaultVariables[missingVariable]) {
+            return this.defaultVariables[missingVariable]
+          } else {
+            return 'undefined variable'
+          }
+        })(),
         message: `What is the value of ${missingVariable}?`
       }])
     }
-    let answers = await localSmartInteract.runQueue()
+    let answerBucket = await localSmartInteract.runQueue()
+    answerBucket.answerMap.forEach(async answer => {
+      await helpers.deepAddToObject(this.suppliedVariables, answer.name, answer.value)
+    })
+
+  }
+
+  async writeToDisk (destinationDirArg) {
+    let smartfileArrayToWrite = plugins.lodash.cloneDeep(this.templateSmartfileArray)
+    for (let smartfile of smartfileArrayToWrite) {
+
+      // render the template
+      let template = await plugins.smarthbs.getTemplateForString(
+        smartfile.contents.toString()
+      )
+      let renderedTemplateString = template(this.suppliedVariables)
+
+      // handle frontmatter
+      let parsedTemplate = plugins.smartfm.parse(renderedTemplateString)
+      if (parsedTemplate.data.fileName) {
+        smartfile.updateFileName(parsedTemplate.data.fileName)
+      }
+
+      smartfile.contents = Buffer.from(parsedTemplate.content)
+    }
+
+    await plugins.smartfile.memory.smartfileArrayToFs(smartfileArrayToWrite, destinationDirArg)
   }
 
   /**
-   * finds all variables in a Template
+   * 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) {
-
+  private async _findVariablesInTemplate () {
+    let templateVariables: string[] = []
+    for (let templateSmartfile of this.templateSmartfileArray) {
+      let localTemplateVariables = await plugins.smarthbs.findVarsInHbsString(templateSmartfile.contents.toString())
+      templateVariables = plugins.lodash.concat(templateVariables, localTemplateVariables)
     }
+    templateVariables = plugins.lodash.uniq(templateVariables)
   }
 
   /**
    * checks if supplied Variables satisfy the template
    */
-  private async _checkSuppliedVariables() {
+  private async _checkSuppliedVariables () {
     let missingVars: string[] = []
-    for (let templateSmartFile of this.templateSmartfileArray) {
+    for (let templateSmartfile of this.templateSmartfileArray) {
       let localMissingVars = await plugins.smarthbs.checkVarsSatisfaction(
-        templateSmartFile.contents.toString(),
+        templateSmartfile.contents.toString(),
         this.suppliedVariables
       )
       missingVars = plugins.lodash.concat(missingVars, localMissingVars)
-      missingVars = plugins.lodash.uniq(missingVars)
     }
+    missingVars = plugins.lodash.uniq(missingVars)
     return missingVars
   }
+
+  /**
+   * checks the default.yml at the root of a template for default variables
+   * 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 () {
+    let defaultsSmartfile = this.templateSmartfileArray.filter(smartfileArg => {
+      return smartfileArg.parsedPath.base === 'defaults.yml'
+    })[0]
+
+    if (defaultsSmartfile) {
+      let defaultObject = await plugins.smartyaml.yamlStringToObject(
+        defaultsSmartfile.contents.toString()
+      )
+      this.defaultVariables = defaultObject
+    } else {
+      this.defaultVariables = {}
+    }
+  }
 }

ts/smartscaf.helpers.ts

@@ -1,2 +1,33 @@
 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

@@ -2,15 +2,19 @@ import 'typings-global'
 import * as lodash from 'lodash'
 import * as path from 'path'
 import * as smartfile from 'smartfile'
+import * as smartfm from 'smartfm'
 import * as smarthbs from 'smarthbs'
 import * as smartinteract from 'smartinteract'
 import * as smartq from 'smartq'
+import * as smartyaml from 'smartyaml'
 
 export {
   lodash,
   path,
   smartfile,
+  smartfm,
   smarthbs,
   smartinteract,
-  smartq
+  smartq,
+  smartyaml
 }