3.0.2

update

See merge request pushrocks/smartscaf!1

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -33,24 +34,39 @@ snyk:
   - 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
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +78,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -118,6 +135,7 @@ pages:
   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:
@@ -130,13 +148,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartscaf",
-  "version": "2.0.2",
+  "version": "3.0.2",
   "private": false,
   "description": "scaffold projects quickly",
   "main": "dist/index.js",
@@ -26,21 +26,21 @@
     "npm"
   ],
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.6",
-    "@gitzone/tsrun": "^1.1.12",
+    "@gitzone/tsrun": "^1.1.17",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.18",
-    "@pushrocks/tapbundle": "^3.0.5",
+    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.9.2"
+    "@types/node": "^10.12.18"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.1",
+    "@pushrocks/lik": "^3.0.4",
-    "@pushrocks/smartfile": "^6.0.8",
+    "@pushrocks/smartfile": "^6.0.12",
     "@pushrocks/smartfm": "^2.0.1",
     "@pushrocks/smarthbs": "^2.0.0",
     "@pushrocks/smartinteract": "^2.0.4",
     "@pushrocks/smartpromise": "^2.0.5",
     "@pushrocks/smartyaml": "^2.0.3",
-    "@types/lodash": "^4.14.72",
+    "@types/lodash": "^4.14.120",
-    "lodash": "^4.17.4"
+    "lodash": "^4.17.11"
   }
 }

test/test.ts

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

test/test_output/defaults.yml

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

test/test_output/hello.md

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

test/test_template/.smartscaf.yml

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

test/test_template/defaults.yml

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

test/test_template_2/hello.md

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

ts/smartscaf.classes.smartscaf.ts

@@ -11,26 +11,45 @@ export interface ScafTemplateContructorOptions {
 }
 
 export class ScafTemplate {
+  static async createTemplateFromDir() {}
+
+  /**
+   * 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[] = [];
 
-  dependencies: ScafTemplate[];
+  constructor(dirPathArg: string) {
+    this.dirPath = plugins.path.resolve(dirPathArg);
+  }
 
   /**
    * read a template from a directory
    */
-  async readTemplateFromDir(dirPathArg: string) {
+  async readTemplateFromDir() {
-    let dirPath = plugins.path.resolve(dirPathArg);
+    this.templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(this.dirPath, '**/*');
-    this.templateSmartfileArray = await plugins.smartfile.fs.fileTreeToObject(dirPath, '**/*');
+    await this._resolveTemplateDependencies();
     await this._findVariablesInTemplate();
     await this._checkSuppliedVariables();
     await this._checkDefaultVariables();
-    await this._resolveTemplateDependencies();
   }
 
   /**
@@ -68,21 +87,30 @@ export class ScafTemplate {
       ]);
     }
     let answerBucket = await localSmartInteract.runQueue();
-    answerBucket.answerMap.forEach(async answer => {
+    await answerBucket.answerMap.forEach(async answer => {
       await helpers.deepAddToObject(this.suppliedVariables, answer.name, answer.value);
     });
   }
 
+  /**
+   * writes a file to disk
+   * @param destinationDirArg
+   */
   async writeToDisk(destinationDirArg) {
-    let smartfileArrayToWrite = this.templateSmartfileArray;
+    const smartfileArrayToWrite: Smartfile[] = [];
-    for (let smartfile of smartfileArrayToWrite) {
+    for (let 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);
 
       // handle frontmatter
       const smartfmInstance = new plugins.smartfm.Smartfm({
-        fmType: "yaml"
+        fmType: 'yaml'
       });
       let parsedTemplate = smartfmInstance.parse(renderedTemplateString) as any;
       if (parsedTemplate.data.fileName) {
@@ -90,6 +118,7 @@ export class ScafTemplate {
       }
 
       smartfile.contents = Buffer.from(parsedTemplate.content);
+      smartfileArrayToWrite.push(smartfile);
     }
 
     await plugins.smartfile.memory.smartfileArrayToFs(smartfileArrayToWrite, destinationDirArg);
@@ -122,8 +151,12 @@ export class ScafTemplate {
         templateSmartfile.contents.toString(),
         this.suppliedVariables
       );
+
+      // combine with other missingVars
       missingVars = [...missingVars, ...localMissingVars];
     }
+
+    // dedupe
     missingVars = missingVars.filter((value, index, self) => {
       return self.indexOf(value) === index;
     });
@@ -131,7 +164,7 @@ export class ScafTemplate {
   }
 
   /**
-   * checks the default.yml at the root of a template for default variables
+   * 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
@@ -143,16 +176,21 @@ export class ScafTemplate {
    * >>     - yourDeeperKey: yourValue
    */
   private async _checkDefaultVariables() {
-    let defaultsSmartfile = this.templateSmartfileArray.filter(smartfileArg => {
+    let smartscafSmartfile = this.templateSmartfileArray.find(smartfileArg => {
-      return smartfileArg.parsedPath.base === 'defaults.yml';
+      return smartfileArg.parsedPath.base === '.smartscaf.yml';
-    })[0];
+    });
 
-    if (defaultsSmartfile) {
+    if (smartscafSmartfile) {
-      let defaultObject = await plugins.smartyaml.yamlStringToObject(
+      const smartscafObject = await plugins.smartyaml.yamlStringToObject(
-        defaultsSmartfile.contents.toString()
+        smartscafSmartfile.contents.toString()
       );
+      const defaultObject = smartscafObject.defaults;
       this.defaultVariables = defaultObject;
-    } else {
+    }
+
+    // safeguard against non existent defaults
+    if (!this.defaultVariables) {
+      console.log('this template does not specify defaults');
       this.defaultVariables = {};
     }
   }
@@ -161,14 +199,36 @@ export class ScafTemplate {
    * resolve template dependencies
    */
   private async _resolveTemplateDependencies() {
-    const dependencies = this.templateSmartfileArray.find(smartfileArg => {
+    const smartscafSmartfile = this.templateSmartfileArray.find(smartfileArg => {
-      return smartfileArg.parsedPath.base === "dependencies.yml"
+      return smartfileArg.parsedPath.base === '.smartscaf.yml';
     });
-    if(!dependencies) {
+    if (!smartscafSmartfile) {
       console.log('No further template dependencies defined!');
       return;
     }
-    console.log('Found template dependencies! Resolving them now!')
+    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) {
+      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);
+    }
   }
 }

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }