3.0.0

Master

See merge request pushrocks/tlt!1

.gitignore

@@ -0,0 +1,20 @@
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,59 +1,128 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
+  - security
   - test
   - release
-- trigger
-- pages
+  - metadata
 
-testLEGACY:
-  stage: test
+before_script:
+  - npm install -g @shipzone/npmci
+
+# ====================
+# security stage
+# ====================
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
   script:
-    - npmci test legacy
+    - 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
 
 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:npmpage
-  stage: pages
+  stage: metadata
   script:
-    - npmci command npmpage --host gitlab
+    - 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
+  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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,15 +0,0 @@
-# tlt
-templates done right
-
-## Usage
-We recommend the use of TypeScript for best in class Intellisense
-
-```javascript
-import * as tlt from 'tlt
-
-let myTlt = new tlt('my template String for {{somePlaceholder}} and {{anotherPlaceholder}}')
-myTlt.getStringFor({
-    "somePlaceholder": "pushrocks",
-    "anotherPlaceholder": "anotherPlaceholder"
-})
-```

npmextra.json

@@ -0,0 +1,16 @@
+{
+  "npmci": {
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartmustache",
+      "description": "templates done right",
+      "npmPackagename": "@pushrocks/smartmustache",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,11 +1,15 @@
 {
-  "name": "tlt",
-  "version": "1.0.1",
+  "name": "@pushrocks/smartmustache",
+  "version": "3.0.0",
   "description": "templates done right",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "private": false,
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -19,5 +23,29 @@
   "bugs": {
     "url": "https://gitlab.com/pushrocks/tlt/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/tlt#README"
+  "homepage": "https://gitlab.com/pushrocks/tlt#README",
+  "dependencies": {
+    "handlebars": "^4.7.7"
+  },
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.65",
+    "@gitzone/tsrun": "^1.2.37",
+    "@gitzone/tstest": "^1.0.73",
+    "@pushrocks/tapbundle": "^5.0.4"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,51 @@
+# @pushrocks/smartmustache
+templates done right
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartmustache)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartmustache)
+* [github.com (source mirror)](https://github.com/pushrocks/smartmustache)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartmustache/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartmustache/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartmustache/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartmustache)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartmustache)](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/smartmustache)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartmustache)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartmustache)](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.
+
+```javascript
+import { SmartMustache } from '@pushrocks/smartmustache';
+
+const mySmartmustache = new SmartMustache('my {{somePlaceholder}} are {{anotherPlaceholder}}!');
+const appliedString = myTlt.applyData({
+  somePlaceholder: 'horses',
+  anotherPlaceholder: 'awesome',
+});
+
+// appliedString will be 'my horses are awesome!'
+```
+
+## 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

@@ -0,0 +1,20 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as tlt from '../ts/index.js';
+
+let testMustache: tlt.SmartMustache;
+tap.test('should create a valid instance of tlt', async () => {
+  testMustache = new tlt.SmartMustache(
+    'some awesome {{customString}} that is {{license}} licensed'
+  );
+  expect(testMustache).toBeInstanceOf(tlt.SmartMustache);
+});
+tap.test('should output a valid string with some data', async () => {
+  let appliedString = testMustache.applyData({
+    customString: 'horse',
+    license: 'MIT',
+  });
+  expect(appliedString).toEqual('some awesome horse that is MIT licensed');
+});
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartmustache',
+  version: '3.0.0',
+  description: 'templates done right'
+}

ts/index.ts

@@ -0,0 +1,29 @@
+import * as handlebars from 'handlebars';
+
+/**
+ * class Tlt allows templates to be used with different sets of data
+ */
+export class SmartMustache {
+  template: any;
+
+  /**
+   * constructor of class Tlt
+   */
+  constructor(templateStringArg: string) {
+    this.template = handlebars.compile(templateStringArg);
+  }
+
+  /**
+   * returns template string with data applied
+   */
+  applyData(data: any): string {
+    return this.template(data);
+  }
+
+  /**
+   * set a new template string
+   */
+  setTemplate(templateStringArg: string) {
+    this.template = handlebars.compile(templateStringArg);
+  }
+}

tslint.json

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