2.0.6

Master

See merge request pushrocks/tlt!1

.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
-- pages
+- metadata
 
+# ====================
+# 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
+  - 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
+  - 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
+  - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
   only:
   - tags
   tags:
   - 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
   only:
   - tags
   tags:
   - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
-  stage: pages
+  image: hosttoday/ht-docker-node:npmci
+  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

.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.3
+ignore: {}
+patch: {}

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 { Tlt } from 'tlt'
 
-let myTlt = new Tlt('my template String for {{somePlaceholder}} and {{anotherPlaceholder}}')
-myTlt.getStringFor({
-    "somePlaceholder": "pushrocks",
-    "anotherPlaceholder": "anotherPlaceholder"
+let myTlt = new Tlt('my {{somePlaceholder}} are {{anotherPlaceholder}}!')
+let appliedString = myTlt.applyData({
+    "somePlaceholder": "horses",
+    "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)

dist/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * class Tlt allows templates to be used with different sets of data
- */
-export declare class Tlt {
-    templateString: string;
-    /**
-     * constructor of class Tlt
-     */
-    constructor(templateStringArg: string);
-    /**
-     * returns template string with data applied
-     */
-    applyData(data: any): string;
-    /**
-     * set a new template string
-     */
-    setTemplate(templateStringArg: string): void;
-}

dist/index.js

@@ -1,27 +0,0 @@
-"use strict";
-const mustache = require("mustache");
-/**
- * class Tlt allows templates to be used with different sets of data
- */
-class Tlt {
-    /**
-     * constructor of class Tlt
-     */
-    constructor(templateStringArg) {
-        this.templateString = templateStringArg;
-    }
-    /**
-     * returns template string with data applied
-     */
-    applyData(data) {
-        return mustache.render(this.templateString, data);
-    }
-    /**
-     * set a new template string
-     */
-    setTemplate(templateStringArg) {
-        this.templateString = templateStringArg;
-    }
-}
-exports.Tlt = Tlt;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEscUNBQW9DO0FBRXBDOztHQUVHO0FBQ0g7SUFHSTs7T0FFRztJQUNILFlBQVksaUJBQXlCO1FBQ2pDLElBQUksQ0FBQyxjQUFjLEdBQUcsaUJBQWlCLENBQUE7SUFDM0MsQ0FBQztJQUVEOztPQUVHO0lBQ0gsU0FBUyxDQUFDLElBQVM7UUFDZixNQUFNLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsY0FBYyxFQUFFLElBQUksQ0FBQyxDQUFBO0lBQ3JELENBQUM7SUFFRDs7T0FFRztJQUNILFdBQVcsQ0FBQyxpQkFBeUI7UUFDakMsSUFBSSxDQUFDLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQTtJQUMzQyxDQUFDO0NBQ0o7QUF2QkQsa0JBdUJDIn0=

npmextra.json

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

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "tlt",
-  "version": "1.0.2",
+  "name": "@pushrocks/smartmustache",
+  "version": "2.0.6",
   "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",
@@ -21,13 +23,12 @@
   },
   "homepage": "https://gitlab.com/pushrocks/tlt#README",
   "dependencies": {
-    "@types/mustache": "^0.8.29",
-    "mustache": "^2.3.0",
-    "typings-global": "^1.0.14"
+    "handlebars": "^4.1.0"
   },
   "devDependencies": {
-    "@types/should": "^8.1.30",
-    "should": "^11.1.1",
-    "typings-test": "^1.0.3"
+    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tstest": "^1.0.18",
+    "@pushrocks/tapbundle": "^3.0.7"
   }
 }

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,16 +0,0 @@
-"use strict";
-require("typings-test");
-const should = require("should");
-const tlt = require("../dist/index");
-describe('tlt', function () {
-    let testTlt;
-    it('should create a valid instance of tlt', function () {
-        testTlt = new tlt.Tlt('some awesome {{customString}}');
-        should(testTlt).be.instanceOf(tlt.Tlt);
-    });
-    it('should output a valid string with some data', function () {
-        let appliedString = testTlt.applyData({ customString: 'horse' });
-        should(appliedString).equal('some awesome horse');
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQixpQ0FBZ0M7QUFFaEMscUNBQW9DO0FBRXBDLFFBQVEsQ0FBQyxLQUFLLEVBQUU7SUFDWixJQUFJLE9BQWdCLENBQUE7SUFDcEIsRUFBRSxDQUFDLHVDQUF1QyxFQUFFO1FBQ3hDLE9BQU8sR0FBRyxJQUFJLEdBQUcsQ0FBQyxHQUFHLENBQUMsK0JBQStCLENBQUMsQ0FBQTtRQUN0RCxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUE7SUFDMUMsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsNkNBQTZDLEVBQUU7UUFDOUMsSUFBSSxhQUFhLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFDLFlBQVksRUFBRSxPQUFPLEVBQUMsQ0FBQyxDQUFBO1FBQzlELE1BQU0sQ0FBQyxhQUFhLENBQUMsQ0FBQyxLQUFLLENBQUMsb0JBQW9CLENBQUMsQ0FBQTtJQUNyRCxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=

test/test.ts

@@ -1,16 +1,18 @@
-import 'typings-test'
-import * as should from 'should'
+import { tap, expect } from '@pushrocks/tapbundle';
 
-import * as tlt from '../dist/index'
+import * as tlt from '../ts/index';
 
-describe('tlt', function() {
-    let testTlt: tlt.Tlt
-    it('should create a valid instance of tlt', function() {
-        testTlt = new tlt.Tlt('some awesome {{customString}}')
-        should(testTlt).be.instanceOf(tlt.Tlt)
-    })
-    it('should output a valid string with some data', function(){
-        let appliedString = testTlt.applyData({customString: 'horse'})
-        should(appliedString).equal('some awesome horse')
-    })
-})
+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

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