2.0.5

Master

See merge request pushrocks/tlt!1

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+coverage/
+public/
+pages/

.gitlab-ci.yml

@@ -1,59 +1,142 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone standard
+image: hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
-- trigger
+- metadata
-- pages
 
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+  - npmci git mirror
+  tags:
+  - docker
+  - notpriv
+
+snyk:
+  stage: security
+  script:
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# test stage
+# ====================
 testLEGACY:
   stage: test
   script:
-    - npmci test legacy
+  - npmci node install legacy
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
   allow_failure: true
 
 testLTS:
   stage: test
   script:
-    - npmci test lts
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
     
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  image: docker:stable
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
+  artifacts:
+    paths: [codeclimate.json]
+  tags:
+  - docker
+  - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
-    - npmci trigger
+  - npmci trigger
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
+  image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command npmpage --host gitlab
+    - npmci command npm install -g typedoc typescript
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     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

README.md

@@ -1,15 +1,41 @@
 # tlt
 templates done right
 
+## Availabililty
+[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/tlt)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/tlt)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/tlt)
+[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/tlt/)
+
+## Status for master
+[![build status](https://GitLab.com/pushrocks/tlt/badges/master/build.svg)](https://GitLab.com/pushrocks/tlt/commits/master)
+[![coverage report](https://GitLab.com/pushrocks/tlt/badges/master/coverage.svg)](https://GitLab.com/pushrocks/tlt/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/tlt.svg)](https://www.npmjs.com/package/tlt)
+[![Dependency Status](https://david-dm.org/pushrocks/tlt.svg)](https://david-dm.org/pushrocks/tlt)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/tlt/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/tlt/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/tlt/badges/code.svg)](https://www.bithound.io/github/pushrocks/tlt)
+[![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
-We recommend the use of TypeScript for best in class Intellisense
+Use TypeScript for best in class instellisense.
 
 ```javascript
-import * as tlt from 'tlt
+import { Tlt } from 'tlt'
 
-let myTlt = new tlt('my template String for {{somePlaceholder}} and {{anotherPlaceholder}}')
+let myTlt = new Tlt('my {{somePlaceholder}} are {{anotherPlaceholder}}!')
-myTlt.getStringFor({
+let appliedString = myTlt.applyData({
-    "somePlaceholder": "pushrocks",
+    "somePlaceholder": "horses",
-    "anotherPlaceholder": "anotherPlaceholder"
+    "anotherPlaceholder": "awesome"
 })
+
+// appliedString will be 'my horses are awesome!'
 ```
+
+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://push.rocks)

npmextra.json

@@ -0,0 +1,5 @@
+{
+  "npmci": {
+    "npmAccessLevel": "public"
+  }
+}

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "tlt",
+  "name": "@pushrocks/smartmustache",
-  "version": "1.0.1",
+  "version": "2.0.5",
   "description": "templates done right",
+  "private": false,
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -19,5 +21,14 @@
   "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.1.0"
+  },
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tstest": "^1.0.18",
+    "@pushrocks/tapbundle": "^3.0.7"
+  }
 }

test/test.ts

@@ -0,0 +1,18 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as tlt from '../ts/index';
+
+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).to.be.instanceOf(tlt.SmartMustache);
+});
+tap.test('should output a valid string with some data', async () => {
+  let appliedString = testMustache.applyData({
+    customString: 'horse',
+    license: 'MIT'
+  });
+  expect(appliedString).to.equal('some awesome horse that is MIT licensed');
+});
+
+tap.start();

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);
+  }
+}