update tsconfig

.gitignore

@@ -1,4 +1,22 @@
+.nogit/
+
+# artifacts
 coverage/
-node_modules/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,68 +1,118 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
+  - .npmci_cache/
   key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
-- trigger
-- pages
+- metadata
 
-testLEGACY:
-  stage: test
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
-  coverage: /\d+.?\d+?\%\s*coverage/
+  - npmci git mirror
   tags:
-    - docker
-  allow_failure: true
+  - docker
+  - notpriv
 
-testLTS:
+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 test lts
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
-    
-testSTABLE:
+  - docker
+  - priv
+
+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
+  - 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
+  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: trigger
+  stage: metadata
   script:
-    - npmci trigger
+  - npmci trigger
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
-  stage: pages
+  stage: metadata
   script:
-    - npmci command npmpage --publish gitlab
+    - npmci node install lts
+    - 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

README.md

@@ -1,29 +1,50 @@
-# smartsass
+# @pushrocks/smartsass
 smart wrapper for sass
 
-## Availabililty
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartsass)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartsass)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartsass)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartsass/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartsass)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsass)
+* [github.com (source mirror)](https://github.com/pushrocks/smartsass)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartsass/)
 
 ## Status for master
-[![build status](https://GitLab.com/pushrocks/smartsass/badges/master/build.svg)](https://GitLab.com/pushrocks/smartsass/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartsass/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartsass/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartsass.svg)](https://www.npmjs.com/package/smartsass)
-[![Dependency Status](https://david-dm.org/pushrocks/smartsass.svg)](https://david-dm.org/pushrocks/smartsass)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartsass/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartsass/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartsass/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartsass)
-[![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/)
+[![build status](https://gitlab.com/pushrocks/smartsass/badges/master/build.svg)](https://gitlab.com/pushrocks/smartsass/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartsass/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartsass/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartsass.svg)](https://www.npmjs.com/package/@pushrocks/smartsass)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartsass/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartsass)
+[![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/)
 
 ## Usage
+
 Use TypeScript for best in class instellisense.
 
+```javascript
+import * as smartsass from 'smartsass'
+import * as bourbon from 'bourbon
+import * as neat from 'neat'
+
+let mySmartsass = new smartsass.Smartsass({
+  filePath: './some.css',
+  includePaths: bourbon.includePaths
+})
+
+mySmartsass.addIncludePaths(neat.includePaths)
+
+let renderedString = mySmartsass.render()
+```
+
 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)
+> | 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)
+
+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)

dist/index.d.ts

@@ -1,18 +0,0 @@
-import { Result } from 'node-sass';
-export interface ISmartsassConstructorOptions {
-    entryFilePath: string;
-    includePaths?: string[];
-}
-export declare class Smartsass {
-    includePaths: any[];
-    entryFilePath: string;
-    constructor(optionsArg: ISmartsassConstructorOptions);
-    /**
-     * renders the Smartsass classes' entryfile and returns result as string
-     */
-    render(): Promise<Result>;
-    /**
-     * renders and stores
-     */
-    renderAndStore(outputFilePath: string): Promise<void>;
-}

dist/index.js

@@ -1,50 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const plugins = require("./smartsass.plugins");
-class Smartsass {
-    constructor(optionsArg) {
-        this.includePaths = [];
-        this.entryFilePath = optionsArg.entryFilePath;
-        if (optionsArg.includePaths) {
-            for (let includePath of optionsArg.includePaths) {
-                this.includePaths.push(includePath);
-            }
-        }
-    }
-    /**
-     * renders the Smartsass classes' entryfile and returns result as string
-     */
-    render() {
-        let done = plugins.smartq.defer();
-        plugins.sass.render({
-            file: this.entryFilePath,
-            includePaths: this.includePaths
-        }, function (err, result) {
-            if (err) {
-                console.log(err);
-                done.reject(err);
-            }
-            done.resolve(result);
-        });
-        return done.promise;
-    }
-    /**
-     * renders and stores
-     */
-    renderAndStore(outputFilePath) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let result = yield this.render();
-            yield plugins.smartfile.memory.toFs(result.css.toString(), outputFilePath);
-        });
-    }
-}
-exports.Smartsass = Smartsass;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBQUEsK0NBQThDO0FBVTlDO0lBR0UsWUFBWSxVQUF3QztRQUZwRCxpQkFBWSxHQUFHLEVBQUUsQ0FBQTtRQUdmLElBQUksQ0FBQyxhQUFhLEdBQUcsVUFBVSxDQUFDLGFBQWEsQ0FBQTtRQUM3QyxFQUFFLENBQUEsQ0FBQyxVQUFVLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQztZQUMzQixHQUFHLENBQUMsQ0FBQyxJQUFJLFdBQVcsSUFBSSxVQUFVLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQztnQkFDaEQsSUFBSSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUE7WUFDckMsQ0FBQztRQUNILENBQUM7SUFDSCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxNQUFNO1FBQ0osSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLEVBQXVCLENBQUE7UUFDdEQsT0FBTyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUM7WUFDbEIsSUFBSSxFQUFFLElBQUksQ0FBQyxhQUFhO1lBQ3hCLFlBQVksRUFBRSxJQUFJLENBQUMsWUFBWTtTQUNoQyxFQUFFLFVBQVUsR0FBRyxFQUFFLE1BQU07WUFDdEIsRUFBRSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztnQkFDUixPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFBO2dCQUNoQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFBO1lBQ2xCLENBQUM7WUFDRCxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO1FBQ3RCLENBQUMsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDckIsQ0FBQztJQUVEOztPQUVHO0lBQ0csY0FBYyxDQUFFLGNBQXNCOztZQUMxQyxJQUFJLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQTtZQUNoQyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLFFBQVEsRUFBRSxFQUFFLGNBQWMsQ0FBQyxDQUFBO1FBQzVFLENBQUM7S0FBQTtDQUNGO0FBckNELDhCQXFDQyJ9

dist/smartsass.includes.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzYXNzLmluY2x1ZGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzYXNzLmluY2x1ZGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

dist/smartsass.plugins.d.ts

@@ -1,5 +0,0 @@
-import 'typings-global';
-import * as sass from 'node-sass';
-import * as smartfile from 'smartfile';
-import * as smartq from 'smartq';
-export { sass, smartfile, smartq };

dist/smartsass.plugins.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require("typings-global");
-const sass = require("node-sass");
-exports.sass = sass;
-const smartfile = require("smartfile");
-exports.smartfile = smartfile;
-const smartq = require("smartq");
-exports.smartq = smartq;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzYXNzLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHNhc3MucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUN2QixrQ0FBaUM7QUFLL0Isb0JBQUk7QUFKTix1Q0FBc0M7QUFLcEMsOEJBQVM7QUFKWCxpQ0FBZ0M7QUFLOUIsd0JBQU0ifQ==

npmextra.json

@@ -1,7 +1,19 @@
 {
   "npmci": {
-    "globalNpmTools": [
-      "npmts"
-    ]
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartsass",
+      "shortDescription": "smart wrapper for sass",
+      "npmPackagename": "@push.rocks/smartsass",
+      "license": "MIT"
+    }
+  },
+  "tsdocs": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "smartsass",
-  "version": "1.0.4",
+  "name": "@push.rocks/smartsass",
+  "version": "2.0.6",
+  "private": false,
   "description": "smart wrapper for sass",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -23,10 +25,29 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartsass#README",
   "dependencies": {
-    "@types/node-sass": "^3.10.32",
-    "node-sass": "^4.5.0",
-    "smartfile": "^4.1.7",
-    "smartq": "^1.1.1",
-    "typings-global": "^1.0.14"
-  }
-}
+    "@pushrocks/smartfile": "^7.0.6",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@types/node-sass": "^4.11.0",
+    "node-sass": "^4.13.0"
+  },
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/node": "^13.1.6",
+    "tslint": "^5.20.1",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
+}

test/test.ts

@@ -0,0 +1,12 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as smartsass from '../ts/index';
+
+tap.test('should create a valid instance of smartsass', async () => {
+  const testsmartSass = new smartsass.Smartsass({
+    data: 'hello'
+  });
+  expect(testsmartSass).to.be.instanceof(smartsass.Smartsass);
+});
+
+tap.start();

ts/index.ts

@@ -1,48 +1,64 @@
-import * as plugins from './smartsass.plugins'
+import * as plugins from './smartsass.plugins';
 
 // interfaces
-import { Result } from 'node-sass'
+import { Result } from 'node-sass';
 
 export interface ISmartsassConstructorOptions {
-  entryFilePath: string,
-  includePaths?: string[]
+  data?: string;
+  entryFilePath?: string;
+  includePaths?: string[];
 }
 
 export class Smartsass {
-  includePaths = []
-  entryFilePath: string
+  includePaths = [];
+  entryFilePath: string;
+  data: string;
   constructor(optionsArg: ISmartsassConstructorOptions) {
-    this.entryFilePath = optionsArg.entryFilePath
-    if(optionsArg.includePaths) {
+    this.entryFilePath = optionsArg.entryFilePath;
+    this.data = optionsArg.data;
+    if (optionsArg.includePaths) {
       for (let includePath of optionsArg.includePaths) {
-        this.includePaths.push(includePath)
+        this.includePaths.push(includePath);
       }
     }
   }
 
+  /**
+   * add further include paths
+   */
+  addIncludePaths(includePathsArray: string[]) {
+    for (let includePath of includePathsArray) {
+      this.includePaths.push(includePath);
+    }
+  }
+
   /**
    * renders the Smartsass classes' entryfile and returns result as string
    */
   render() {
-    let done = plugins.smartq.defer<plugins.sass.Result>()
-    plugins.sass.render({
-      file: this.entryFilePath,
-      includePaths: this.includePaths
-    }, function (err, result) {
-      if (err) {
-        console.log(err)
-        done.reject(err)
+    let done = plugins.smartpromise.defer<plugins.sass.Result>();
+    plugins.sass.render(
+      {
+        data: this.data,
+        file: this.entryFilePath,
+        includePaths: this.includePaths
+      },
+      function(err, result) {
+        if (err) {
+          console.log(err);
+          done.reject(err);
+        }
+        done.resolve(result);
       }
-      done.resolve(result)
-    })
-    return done.promise
+    );
+    return done.promise;
   }
 
   /**
    * renders and stores
    */
-  async renderAndStore (outputFilePath: string) {
-    let result = await this.render()
-    await plugins.smartfile.memory.toFs(result.css.toString(), outputFilePath)
+  async renderAndStore(outputFilePath: string) {
+    let result = await this.render();
+    await plugins.smartfile.memory.toFs(result.css.toString(), outputFilePath);
   }
 }

ts/smartsass.includes.ts

@@ -1 +1 @@
-import * as plugins from './smartsass.plugins'
+import * as plugins from './smartsass.plugins';

ts/smartsass.plugins.ts

@@ -1,10 +1,5 @@
-import 'typings-global'
-import * as sass from 'node-sass'
-import * as smartfile from 'smartfile'
-import * as smartq from 'smartq'
+import * as sass from 'node-sass';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpromise from '@pushrocks/smartpromise';
 
-export {
-  sass,
-  smartfile,
-  smartq
-}
+export { sass, smartfile, smartpromise };

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

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