2.0.5

.gitignore

@@ -1,5 +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,60 +1,118 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmts
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
-- trigger
+- metadata
-- pages
 
-testLEGACY:
+# ====================
-  stage: test
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+  - npmci git mirror
   tags:
   - docker
-  allow_failure: true
+  - notpriv
 
-testLTS:
+snyk:
-  stage: test
+  stage: security
   script:
-    - npmci test lts
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
   tags:
   - docker
+  - notpriv
 
-testSTABLE:
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test stable
+  - 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 publish
+  - 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: trigger
+  stage: metadata
   script:
   - npmci trigger
   only:
   - tags
   tags:
   - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
+  stage: metadata
-  stage: pages
   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,28 +1,50 @@
-# smartsass
+# @pushrocks/smartsass
 smart wrapper for sass
 
-## Availabililty
+## Availabililty and Links
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartsass)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartsass)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartsass)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsass)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartsass)
+* [github.com (source mirror)](https://github.com/pushrocks/smartsass)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/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)
+[![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)
+[![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)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartsass.svg)](https://www.npmjs.com/package/@pushrocks/smartsass)
-[![Dependency Status](https://david-dm.org/pushrocks/smartsass.svg)](https://david-dm.org/pushrocks/smartsass)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartsass/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartsass)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartsass/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartsass/master/dependencies/npm)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartsass/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartsass)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-[![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
+
 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)
 
 [![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)

npmextra.json

@@ -0,0 +1,16 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartsass",
+      "shortDescription": "smart wrapper for sass",
+      "npmPackagename": "@pushrocks/smartsass",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "smartsass",
+  "name": "@pushrocks/smartsass",
-  "version": "1.0.1",
+  "version": "2.0.5",
+  "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",
@@ -21,5 +23,31 @@
   "bugs": {
     "url": "https://gitlab.com/pushrocks/smartsass/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartsass#README"
+  "homepage": "https://gitlab.com/pushrocks/smartsass#README",
+  "dependencies": {
+    "@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

@@ -0,0 +1,64 @@
+import * as plugins from './smartsass.plugins';
+
+// interfaces
+import { Result } from 'node-sass';
+
+export interface ISmartsassConstructorOptions {
+  data?: string;
+  entryFilePath?: string;
+  includePaths?: string[];
+}
+
+export class Smartsass {
+  includePaths = [];
+  entryFilePath: string;
+  data: string;
+  constructor(optionsArg: ISmartsassConstructorOptions) {
+    this.entryFilePath = optionsArg.entryFilePath;
+    this.data = optionsArg.data;
+    if (optionsArg.includePaths) {
+      for (let includePath of optionsArg.includePaths) {
+        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.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);
+      }
+    );
+    return done.promise;
+  }
+
+  /**
+   * renders and stores
+   */
+  async renderAndStore(outputFilePath: string) {
+    let result = await this.render();
+    await plugins.smartfile.memory.toFs(result.css.toString(), outputFilePath);
+  }
+}

ts/smartsass.includes.ts

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

ts/smartsass.plugins.ts

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

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }