4.0.13

.gitea/workflows/gitzone_ci_default.yaml

@@ -0,0 +1,111 @@
+name: CI Pipeline
+
+on: push
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install pnpm and npmci
+      run: |
+        pnpm install -g pnpm
+        pnpm install -g @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

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -1,120 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/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
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - priv
-
-testBuild:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci command npm run build
-  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
-  allow_failure: true
-  script:
-    - npmci command npm install -g tslint typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-  tags:
-  - docker
-  - priv
-
-trigger:
-  stage: metadata
-  script:
-  - npmci trigger
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
-  stage: metadata
-  script:
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public
-  allow_failure: true

.snyk

@@ -1,23 +0,0 @@
-# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.5
-# ignores vulnerabilities until expiry date; change duration by modifying expiry date
-ignore:
-  SNYK-JS-JSYAML-173999:
-    - '@pushrocks/smartfm > gray-matter > js-yaml':
-        reason: None given
-        expires: '2019-10-10T16:23:38.993Z'
-    - '@pushrocks/smartyaml > js-yaml':
-        reason: None given
-        expires: '2019-10-10T16:23:38.993Z'
-  SNYK-JS-JSYAML-174129:
-    - '@pushrocks/smartfm > gray-matter > js-yaml':
-        reason: None given
-        expires: '2019-10-10T16:23:38.993Z'
-    - '@pushrocks/smartyaml > js-yaml':
-        reason: None given
-        expires: '2019-10-10T16:23:38.993Z'
-  SNYK-JS-LODASH-450202:
-    - '@pushrocks/smartinteract > inquirer > lodash':
-        reason: None given
-        expires: '2019-10-10T16:23:38.993Z'
-patch: {}

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

.vscode/settings.json

@@ -11,7 +11,13 @@
           },
           "gitzone": {
             "type": "object",
-            "description": "settings for gitzone"
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
           }
         }
       }

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.9",
+  "version": "4.0.13",
   "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,33 +26,37 @@
     "npm"
   ],
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.9",
-    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.18.0"
+    "@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.6",
+    "@pushrocks/lik": "^6.0.2",
+    "@pushrocks/smartfile": "^10.0.17",
     "@pushrocks/smartfm": "^2.0.4",
-    "@pushrocks/smarthbs": "^2.0.8",
-    "@pushrocks/smartinteract": "^2.0.4",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartshell": "^2.0.25",
-    "@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_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "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-prettier-ff69b4.svg)](https://prettier.io/)
+
+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)
+## 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)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

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/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.13',
+  description: 'scaffold projects quickly'
+}

ts/index.ts

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

ts/interfaces/index.ts

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

ts/interfaces/smartscaf.ts

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

ts/smartscaf.classes.smartscaf.ts

@@ -1,6 +1,5 @@
-import * as plugins from './smartscaf.plugins';
-import * as interfaces from './interfaces';
-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';
@@ -12,7 +11,9 @@ export interface ScafTemplateContructorOptions {
 }
 
 export class ScafTemplate {
-  public static async createTemplateFromDir() {}
+  public static async createTemplateFromDir(dirPathArg: string) {
+    return new ScafTemplate(dirPathArg);
+  }
 
   /**
    * the name of the template
@@ -58,19 +59,21 @@ export class ScafTemplate {
     let smartscafFile: interfaces.ISmartscafFile = {
       defaults: {},
       dependencies: {
-        merge: []
+        merge: [],
       },
-      runafter: []
+      runafter: [],
     };
 
-    const smartscafSmartfile = this.templateSmartfileArray.find(smartfileArg => {
+    const smartscafSmartfile = this.templateSmartfileArray.find((smartfileArg) => {
       return smartfileArg.parsedPath.base === '.smartscaf.yml';
     });
 
     if (smartscafSmartfile) {
       smartscafFile = {
         ...smartscafFile,
-        ...await plugins.smartyaml.yamlStringToObject(smartscafSmartfile.contentBuffer.toString())
+        ...(await plugins.smartyaml.yamlStringToObject(
+          smartscafSmartfile.contentBuffer.toString()
+        )),
       };
     }
     this.smartscafFile = smartscafFile;
@@ -88,7 +91,7 @@ export class ScafTemplate {
   public async supplyVariables(variablesArg) {
     this.suppliedVariables = {
       ...this.suppliedVariables,
-      ...variablesArg
+      ...variablesArg,
     };
     this.missingVariables = await this._checkSuppliedVariables();
   }
@@ -111,14 +114,15 @@ export class ScafTemplate {
               return 'undefined variable';
             }
           })(),
-          message: `What is the value of ${missingVariable}?`
-        }
+          message: `What is the value of ${missingVariable}?`,
+        },
       ]);
     }
     const answerBucket = await localSmartInteract.runQueue();
-    await answerBucket.answerMap.forEach(async answer => {
-      await helpers.deepAddToObject(this.suppliedVariables, answer.name, answer.value);
-    });
+    const answers = answerBucket.getAllAnswers();
+    for (const answer of answers) {
+      await plugins.smartparam.smartAdd(this.suppliedVariables, answer.name, answer.value);
+    }
   }
 
   /**
@@ -140,14 +144,14 @@ export class ScafTemplate {
 
       // handle frontmatter
       const smartfmInstance = new plugins.smartfm.Smartfm({
-        fmType: 'yaml'
+        fmType: 'yaml',
       });
       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);
     }
 
@@ -207,7 +211,7 @@ export class ScafTemplate {
    * >>     - yourDeeperKey: yourValue
    */
   private async _checkDefaultVariables() {
-    const smartscafSmartfile = this.templateSmartfileArray.find(smartfileArg => {
+    const smartscafSmartfile = this.templateSmartfileArray.find((smartfileArg) => {
       return smartfileArg.parsedPath.base === '.smartscaf.yml';
     });
 
@@ -248,12 +252,12 @@ export class ScafTemplate {
     }
   }
 
-  private async runScripts () {
+  private async runScripts() {
     if (!this.destinationPath) {
       throw new Error('cannot run scripts without an destinationdir');
     }
     const smartshellInstance = new plugins.smartshell.Smartshell({
-      executor: 'bash'
+      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,8 +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, smartshell };
+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"
-}