7.0.10

update to latest standards

See merge request !2

.gitignore

@@ -1,7 +1,20 @@
-node_modules/
-.settings/
-.idea/
+.nogit/
 
-ts/*.js
-ts/*.js.map
-ts/typings/
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -0,0 +1,127 @@
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
+
+stages:
+  - security
+  - test
+  - release
+  - metadata
+
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+    - npmci git mirror
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+audit:
+  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=moderate
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testStable:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
+    - 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:
+    - lossless
+    - docker
+    - notpriv
+
+release:
+  stage: release
+  script:
+    - npmci node install stable
+    - npmci npm publish
+  only:
+    - tags
+  tags:
+    - lossless
+    - 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:
+    - lossless
+    - docker
+    - priv
+
+trigger:
+  stage: metadata
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+pages:
+  stage: metadata
+  script:
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - public
+  allow_failure: true

.npmignore

@@ -0,0 +1,4 @@
+coverage/
+docs/
+test/
+ts/

.snyk

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

.travis.yml

@@ -1,16 +0,0 @@
-language: node_js
-node_js:
-- '4.1'
-before_install:
-- npm install -g tsd
-deploy:
-  provider: npm
-  email: npm@smart-coordination.com
-  api_key:
-    secure: 3RdzAcS9d6sLJs3tHM2uCVU2wV2NsKiLiYWue98DevgijIqTFDHtYuoP29p7fbB4SV87JRbTK1y41QM2u/CCjnbB+mrAUg/Pn08dTibmzi9liom67sLczIPD4eZeMznXPRaddESQdzqrtQfc/6P+1JQO7XWexLNebgYtMrUzYcOrHPWf/Uktk2cKiYfrO8piSR+HOFh2rzC5HjVZ/7fKDIa9bqTlBETkNc7s2NgB++jKRF9LNMVGI/9EmxjBzSSE1juOz26Ahp4+/+P3Lc5LngnTFOYsPoW5iWNY+AQltZxhu9K+rrtfn90rmQDnO7RCGO5yZgMS2+0UjJedwV+4ancU3nzoNmiuoIL7DjQ7NQlt0QKMmIqZuBFBc3tdxqotxNoJDk8/Ui0yfHWzJz0Fd22OI+VdTWNH1y5Vyywsql6wwkl2+Da1WhZf/Mn2gPgLPI0lssPTIl/u3Bey+167tZ3HvX0yqlvPO/JbqK02+5VrRBaV67vT00DG+dh4nnwqcX14Umx2a3JHt3tSGkDnDKpsLbvqjhPhkMRsCIloju+wMnyKjtScMZW+2FeO2n4PgbjNhF+5SG8pDmTS8p0Vy7iohUOiGIJty7K/1r6sQ1FNluhO5Ol3mBDs6wjg6S5QCSNL9eylpV52FV0UX4cRCijmzso+n48I2BbSwjghTB8=
-  on:
-    tags: true
-    repo: pushrocks/smartfile
-notifications:
-  slack:
-    secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Push.Rocks
+Copyright (c) 2015 Lossless GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +0,0 @@
-# smartfile
-make files easily accessible for processing in javascript.
-
-## Supported file types:
-* .yml .yaml
-* .json

index.d.ts

@@ -1,31 +0,0 @@
-/// <reference path="ts/typings/main.d.ts" />
-declare module SmartfilePlugins {
-    var init: () => {
-        beautylog: any;
-        fs: any;
-        path: any;
-        vinyl: any;
-        vinylFile: any;
-        yaml: any;
-        requireReload: any;
-    };
-}
-declare module SmartfileSimple {
-    var init: (objectArg: any) => void;
-}
-declare module SmartfileVinyl {
-    var init: (objectArg: any) => void;
-}
-declare module SmartfileRequire {
-    var init: (objectArg: any) => void;
-}
-declare var plugins: {
-    beautylog: any;
-    fs: any;
-    path: any;
-    vinyl: any;
-    vinylFile: any;
-    yaml: any;
-    requireReload: any;
-};
-declare var smartfile: any;

index.js

@@ -1,93 +0,0 @@
-#!/usr/bin/env node
-
-/// <reference path="./index.ts" />
-var SmartfilePlugins;
-(function (SmartfilePlugins) {
-    SmartfilePlugins.init = function () {
-        var plugins = {
-            beautylog: require("beautylog"),
-            fs: require("fs-extra"),
-            path: require("path"),
-            vinyl: require("vinyl"),
-            vinylFile: require("vinyl-file"),
-            yaml: require("js-yaml"),
-            requireReload: require("require-reload")
-        };
-        return plugins;
-    };
-})(SmartfilePlugins || (SmartfilePlugins = {}));
-/// <reference path="./index.ts" />
-var SmartfileSimple;
-(function (SmartfileSimple) {
-    /**
-     * reads a file content to a String
-     * @param filePath
-     * @returns {string|Buffer|any}
-     */
-    var readFileToString = function (filePath) {
-        var fileString;
-        fileString = plugins.fs.readFileSync(filePath, "utf8");
-        return fileString;
-    };
-    var readFileToObject = function (filePath, fileTypeArg) {
-        if (fileTypeArg === void 0) { fileTypeArg = "undefined"; }
-        var fileType;
-        if (fileTypeArg == "undefined") {
-            fileType = plugins.path.extname(filePath);
-        }
-        else {
-            fileType = fileTypeArg;
-        }
-        fileType = fileType.replace(/\.([a-z]*)/, "$1"); //remove . form fileType
-        switch (fileType) {
-            case "yml":
-            case "yaml":
-                try {
-                    return plugins.yaml.safeLoad(plugins.fs.readFileSync(filePath, 'utf8'));
-                }
-                catch (e) {
-                    plugins.beautylog.error("check that " + filePath.blue + " points to a valid file");
-                }
-                break;
-            case "json":
-                return plugins.fs.readJsonSync(filePath, {});
-                break;
-        }
-    };
-    SmartfileSimple.init = function (objectArg) {
-        objectArg.readFileToString = readFileToString;
-        objectArg.readFileToObject = readFileToObject;
-    };
-})(SmartfileSimple || (SmartfileSimple = {}));
-/// <reference path="./index.ts" />
-var SmartfileVinyl;
-(function (SmartfileVinyl) {
-    var readFileToVinyl = function (filePathArg, options) {
-        if (options === void 0) { options = {}; }
-        return plugins.vinylFile.readSync(filePathArg, options);
-    };
-    SmartfileVinyl.init = function (objectArg) {
-        objectArg.readFileToVinyl = readFileToVinyl;
-    };
-})(SmartfileVinyl || (SmartfileVinyl = {}));
-/// <reference path="./index.ts" />
-var SmartfileRequire;
-(function (SmartfileRequire) {
-    var requireReload = function (path) {
-        return plugins.requireReload(path);
-    };
-    SmartfileRequire.init = function (objectArg) {
-        objectArg.requireReload = requireReload;
-    };
-})(SmartfileRequire || (SmartfileRequire = {}));
-/// <reference path="./typings/main.d.ts" />
-/// <reference path="./smartfile.plugins.ts" />
-/// <reference path="./smartfile.simple.ts" />
-/// <reference path="./smartfile.vinyl.ts" />
-/// <reference path="./smartfile.require.ts" />
-var plugins = SmartfilePlugins.init();
-var smartfile = {};
-SmartfileSimple.init(smartfile);
-SmartfileVinyl.init(smartfile);
-SmartfileRequire.init(smartfile);
-module.exports = smartfile;

npmextra.json

@@ -0,0 +1,22 @@
+{
+  "npmts": {
+    "mode": "default",
+    "coverageTreshold": 70
+  },
+  "npmdocker": {},
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartfile",
+      "shortDescription": "smart ways to work with files in nodejs",
+      "npmPackagename": "@pushrocks/smartfile",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,18 +1,21 @@
 {
-  "name": "smartfile",
-  "version": "0.0.10",
+  "name": "@pushrocks/smartfile",
+  "private": false,
+  "version": "7.0.10",
   "description": "offers smart ways to work with files in nodejs",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)",
+    "test": "(tstest test/)",
     "reinstall": "(rm -r node_modules && npm install)",
     "release": "(git pull origin master && npm version patch && git push origin master && git checkout release && git merge master && git push origin release && git checkout master)",
     "update": "(git checkout master && git pull origin master && npm install)",
-    "upgrade": "(npm run update) && (ncu upgradeAll && npm install)"
+    "upgrade": "(npm run update) && (ncu upgradeAll && npm install)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/pushrocks/smartfile.git"
+    "url": "https://gitlab.com/pushrocks/smartfile.git"
   },
   "keywords": [
     "filesystem",
@@ -21,20 +24,40 @@
   "author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pushrocks/smartfile/issues"
+    "url": "https://gitlab.com/pushrocks/smartfile/issues"
   },
-  "homepage": "https://github.com/pushrocks/smartfile",
+  "homepage": "https://gitlab.com/pushrocks/smartfile",
   "dependencies": {
-    "beautylog": "2.0.6",
-    "fs-extra": "0.26.5",
-    "js-yaml": "3.5.2",
-    "require-reload": "0.2.2",
-    "vinyl": "1.1.1",
-    "vinyl-file": "2.0.0"
+    "@pushrocks/smarthash": "^2.1.6",
+    "@pushrocks/smartmime": "^1.0.3",
+    "@pushrocks/smartpath": "^4.0.1",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrequest": "^1.1.47",
+    "@types/fs-extra": "^8.1.0",
+    "fs-extra": "^8.1.0",
+    "glob": "^7.1.6",
+    "js-yaml": "^3.13.1"
   },
   "devDependencies": {
-    "beautylog": "2.0.7",
-    "npmts": "2.0.3",
-    "should": "^8.2.1"
-  }
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/node": "^13.7.7",
+    "gulp-function": "^2.2.14",
+    "tslint": "^6.0.0",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,44 @@
+# @pushrocks/smartfile
+smart ways to work with files in nodejs
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartfile)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartfile)
+* [github.com (source mirror)](https://github.com/pushrocks/smartfile)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartfile/)
+
+## Status for master
+[![pipeline status](https://gitlab.com/pushrocks/smartfile/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartfile/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartfile/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartfile/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartfile.svg)](https://www.npmjs.com/package/@pushrocks/smartfile)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartfile/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartfile)
+[![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
+
+smartfile is an approach of being one tool to handle files in diverse environments.
+
+### Smartfile Sections
+
+smartfile thinks in sections:
+
+| section     | description                                                                  |
+| ----------- | ---------------------------------------------------------------------------- |
+| fs          | (object) gets data from fs to somewhere                                      |
+| memory      | gets data from memory to somewhere                                           |
+| remote      | gets data from remote locations to somewhere                                 |
+| interpreter | (object) handles yaml and json                                               |
+| smartfile   | (class) a virtual representation of a file, alternative to vinyl file format |
+
+## 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.js

@@ -1,30 +0,0 @@
-/// <reference path="typings/main.d.ts" />
-var smartfile = require("../index.js");
-var beautylog = require("beautylog");
-var should = require("should");
-var vinyl = require("vinyl");
-describe("smartfile", function () {
-    describe(".readFileToString".yellow, function () {
-        it("should read a file to a string", function () {
-            should.equal(smartfile.readFileToString("./test/mytest.txt"), "Some TestString &&%$");
-        });
-    });
-    describe(".readFileToObject".yellow, function () {
-        it("should read an " + ".yaml".blue + " file to an object", function () {
-            var testData = smartfile.readFileToObject("./test/mytest.yaml");
-            testData.should.have.property("key1", "this works");
-            testData.should.have.property("key2", "this works too");
-        });
-        it("should read an " + ".json".blue + " file to an object", function () {
-            var testData = smartfile.readFileToObject("./test/mytest.json");
-            testData.should.have.property("key1", "this works");
-            testData.should.have.property("key2", "this works too");
-        });
-    });
-    describe(".readFileToVinyl".yellow, function () {
-        it("should read an " + ".json OR .yaml".blue + " file to an " + "vinyl file object".cyan, function () {
-            var testData = smartfile.readFileToVinyl("./test/mytest.json");
-            (vinyl.isVinyl(testData)).should.be.true();
-        });
-    });
-});

test/test.ts

@@ -0,0 +1,219 @@
+import * as smartfile from '../ts/index';
+import path = require('path');
+
+import { expect, tap } from '@pushrocks/tapbundle';
+
+// ---------------------------
+// smartfile.fs
+// ---------------------------
+
+tap.test('.fs.fileExistsSync -> should return an accurate boolean', async () => {
+  expect(smartfile.fs.fileExistsSync('./test/testassets/mytest.json')).to.be.true;
+  expect(smartfile.fs.fileExistsSync('./test/testassets/notthere.json')).be.false;
+});
+
+tap.test('.fs.fileExists -> should resolve or reject a promise', async () => {
+  expect(smartfile.fs.fileExists('./test/testassets/mytest.json')).to.be.instanceof(Promise);
+  await smartfile.fs.fileExists('./test/testassets/mytest.json');
+  await smartfile.fs.fileExists('./test/testassets/notthere.json').catch(err => {
+    return expect(err.message).to.equal(
+      "ENOENT: no such file or directory, access './test/testassets/notthere.json'"
+    );
+  });
+});
+
+tap.test('.fs.listFoldersSync() -> should get the file type from a string', async () => {
+  expect(smartfile.fs.listFoldersSync('./test/testassets/')).to.include('testfolder');
+  expect(smartfile.fs.listFoldersSync('./test/testassets/')).to.not.include('notExistentFolder');
+});
+
+tap.test('.fs.listFolders() -> should get the file type from a string', async () => {
+  let folderArrayArg = await smartfile.fs.listFolders('./test/testassets/');
+  expect(folderArrayArg).to.include('testfolder');
+  expect(folderArrayArg).to.not.include('notExistentFolder');
+});
+
+tap.test('.fs.listFilesSync() -> should get the file type from a string', async () => {
+  expect(smartfile.fs.listFilesSync('./test/testassets/')).to.include('mytest.json');
+  expect(smartfile.fs.listFilesSync('./test/testassets/')).to.not.include('notExistentFile');
+  expect(smartfile.fs.listFilesSync('./test/testassets/', /mytest\.json/)).to.include(
+    'mytest.json'
+  );
+  expect(smartfile.fs.listFilesSync('./test/testassets/', /mytests.json/)).to.not.include(
+    'mytest.json'
+  );
+});
+
+tap.test('.fs.listFiles() -> should get the file type from a string', async () => {
+  let folderArrayArg = await smartfile.fs.listFiles('./test/testassets/');
+  expect(folderArrayArg).to.include('mytest.json');
+  expect(folderArrayArg).to.not.include('notExistentFile');
+});
+
+tap.test('.fs.listFileTree() -> should get a file tree', async () => {
+  let folderArrayArg = await smartfile.fs.listFileTree(
+    path.resolve('./test/testassets/'),
+    '**/*.txt'
+  );
+  expect(folderArrayArg).to.include('testfolder/testfile1.txt');
+  expect(folderArrayArg).to.not.include('mytest.json');
+});
+
+tap.test('.fs.fileTreeToObject -> should read a file tree into an Object', async () => {
+  let fileArrayArg = await smartfile.fs.fileTreeToObject(
+    path.resolve('./test/testassets/'),
+    '**/*.txt'
+  );
+  expect(fileArrayArg[0]).to.be.instanceof(smartfile.Smartfile);
+  expect(fileArrayArg[0].contents.toString()).to.equal(fileArrayArg[0].contentBuffer.toString());
+});
+
+tap.test('.fs.copy() -> should copy a directory', async () => {
+  await smartfile.fs.copy('./test/testassets/testfolder/', './test/testassets/temp/');
+});
+
+tap.test('.fs.copy() -> should copy a file', async () => {
+  await smartfile.fs.copy('./test/testassets/mytest.yaml', './test/testassets/temp/mytest.yaml');
+});
+
+tap.test('.fs.copy() -> should copy a file and rename it', async () => {
+  await smartfile.fs.copy(
+    './test/testassets/mytest.yaml',
+    './test/testassets/temp/mytestRenamed.yaml'
+  );
+});
+
+tap.test('.fs.remove() -> should remove an entire directory', async () => {});
+
+tap.test('.fs.remove -> should remove single files', async () => {
+  await smartfile.fs.remove('./test/testassets/temp/mytestRenamed.yaml');
+});
+
+tap.test('.fs.removeSync -> should remove single files synchronouly', async () => {
+  smartfile.fs.removeSync('./test/testassets/temp/testfile1.txt');
+  expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).to.be.false;
+});
+
+tap.test('.fs.removeMany -> should remove and array of files', async () => {
+  smartfile.fs
+    .removeMany(['./test/testassets/temp/testfile1.txt', './test/testassets/temp/testfile2.txt'])
+    .then(() => {
+      expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).to.be.false;
+      expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile2.txt')).to.be.false;
+    });
+});
+
+tap.test('.fs.removeManySync -> should remove and array of single files synchronouly', async () => {
+  smartfile.fs.removeManySync([
+    './test/testassets/temp/testfile1.txt',
+    './test/testassets/temp/testfile2.txt'
+  ]);
+  expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).to.be.false;
+  expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile2.txt')).to.be.false;
+});
+
+tap.test('.fs.toObjectSync() -> should read an ' + '.yaml' + ' file to an object', async () => {
+  let testData = smartfile.fs.toObjectSync('./test/testassets/mytest.yaml');
+  expect(testData).to.include({ key1: 'this works' });
+  expect(testData).to.include({ key2: 'this works too' });
+});
+tap.test(
+  '.fs.toObjectSync() -> should state unknown file type for unknown file types',
+  async () => {
+    let testData = smartfile.fs.toObjectSync('./test/testassets/mytest.txt');
+  }
+);
+
+tap.test('.fs.toObjectSync() -> should read an ' + '.json' + ' file to an object', async () => {
+  let testData = smartfile.fs.toObjectSync('./test/testassets/mytest.json');
+  expect(testData).to.include({ key1: 'this works' });
+  expect(testData).to.include({ key2: 'this works too' });
+});
+
+tap.test('.fs.toStringSync() -> should read a file to a string', async () => {
+  expect(smartfile.fs.toStringSync('./test/testassets/mytest.txt')).to.equal(
+    'Some TestString &&%$'
+  );
+});
+
+// ---------------------------
+// smartfile.interpreter
+// ---------------------------
+
+tap.test('.interpreter.filetype() -> should get the file type from a string', async () => {
+  expect(smartfile.interpreter.filetype('./somefolder/data.json')).equal('json');
+});
+
+// ---------------------------
+// smartfile.memory
+// ---------------------------
+
+tap.test('.memory.toFs() -> should write a file to disk and return a promise', async () => {
+  let localString = 'myString';
+  await smartfile.memory.toFs(
+    localString,
+    path.join(process.cwd(), './test/testassets/temp/testMemToFs.txt')
+  );
+});
+
+tap.test(
+  '.memory.toFsSync() -> should write a file to disk and return true if successfull',
+  async () => {
+    let localString = 'myString';
+    smartfile.memory.toFsSync(
+      localString,
+      path.join(process.cwd(), './test/testassets/temp/testMemToFsSync.txt')
+    );
+  }
+);
+
+tap.test('.remote.toString() -> should load a remote file to a variable', async () => {
+  const responseString = await smartfile.remote.toString(
+    'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/testassets/mytest.txt'
+  );
+  expect(responseString).to.equal('Some TestString &&%$');
+});
+
+tap.test('.remote.toString() -> should reject a Promise when the link is false', async tools => {
+  await smartfile.remote.toString('https://push.rocks/doesnotexist.txt').catch(err => {
+    return expect(err.message).to.equal(
+      'could not get remote file from https://push.rocks/doesnotexist.txt'
+    );
+  });
+});
+
+// ---------------------------
+// smartfile.Smartfile
+// ---------------------------
+
+tap.test('.Smartfile -> should produce vinyl compatible files', async () => {
+  let smartfileArray = await smartfile.fs.fileTreeToObject(
+    process.cwd(),
+    './test/testassets/testfolder/**/*'
+  );
+  let localSmartfile = smartfileArray[0];
+  expect(localSmartfile).to.be.instanceof(smartfile.Smartfile);
+  expect(localSmartfile.contents).to.be.instanceof(Buffer);
+  // tslint:disable-next-line:no-unused-expression
+  expect(localSmartfile.isBuffer()).to.be.true;
+  // tslint:disable-next-line:no-unused-expression
+  expect(localSmartfile.isDirectory()).to.be.false;
+  // tslint:disable-next-line:no-unused-expression
+  expect(localSmartfile.isNull()).to.be.false;
+});
+
+tap.test('should output a smartfile array to disk', async () => {
+  let smartfileArray = await smartfile.fs.fileTreeToObject('./test/testassets/testfolder/', '*');
+  for (let smartfile of smartfileArray) {
+    console.log(smartfile.relative);
+    console.log(smartfile.path);
+    console.log(smartfile.base);
+    console.log(smartfile.parsedPath);
+  }
+  await smartfile.memory.smartfileArrayToFs(
+    smartfileArray,
+    path.resolve('./test/testassets/temp/testoutput/')
+  );
+});
+
+tap.start();

test/testassets/temp/mytest.yaml

@@ -0,0 +1,4 @@
+key1: this works
+key2: this works too
+key3:
+  nestedkey1: hello

test/testassets/temp/subfolder/deepsubfolder/deepsubtestfile.txt

@@ -0,0 +1 @@
+okidoks

test/testassets/temp/subfolder/subtestfile.txt

@@ -0,0 +1 @@
+hi

test/testassets/temp/testMemToFs.txt

@@ -0,0 +1 @@
+myString

test/testassets/temp/testMemToFsSync.txt

@@ -0,0 +1 @@
+myString

test/testassets/testfolder/subfolder/deepsubfolder/deepsubtestfile.txt

@@ -0,0 +1 @@
+okidoks

test/testassets/testfolder/subfolder/subtestfile.txt

@@ -0,0 +1 @@
+hi

ts/index.ts

@@ -1,17 +1,12 @@
-/// <reference path="./typings/main.d.ts" />
-/// <reference path="./smartfile.plugins.ts" />
-/// <reference path="./smartfile.simple.ts" />
-/// <reference path="./smartfile.vinyl.ts" />
-/// <reference path="./smartfile.require.ts" />
-var plugins = SmartfilePlugins.init();
+import * as plugins from './smartfile.plugins';
+import * as SmartfileFs from './smartfile.fs';
+import * as SmartfileInterpreter from './smartfile.interpreter';
+import * as SmartfileMemory from './smartfile.memory';
+import * as SmartfileRemote from './smartfile.remote';
 
+export { Smartfile } from './smartfile.classes.smartfile';
 
-var smartfile:any = {};
-SmartfileSimple.init(smartfile);
-SmartfileVinyl.init(smartfile);
-SmartfileRequire.init(smartfile);
-
-
-
-
-module.exports = smartfile;
+export let fs = SmartfileFs;
+export let interpreter = SmartfileInterpreter;
+export let memory = SmartfileMemory;
+export let remote = SmartfileRemote;

ts/smartfile.classes.smartfile.ts

@@ -0,0 +1,169 @@
+import * as plugins from './smartfile.plugins';
+import * as fs from './smartfile.fs';
+import * as memory from './smartfile.memory';
+
+export interface ISmartfileConstructorOptions {
+  path?: string;
+  contentString?: string;
+  contentBuffer?: Buffer;
+  base?: string;
+}
+
+/**
+ * class Smartfile
+ * -> is vinyl file compatible
+ */
+export class Smartfile {
+  // ======
+  // STATIC
+  // ======
+
+  /**
+   * creates a Smartfile from a filePath
+   * @param filePath
+   */
+  public static async fromFilePath(filePath: string) {
+    filePath = plugins.path.resolve(filePath);
+    const fileString = fs.toStringSync(filePath);
+    const smartfile = new Smartfile({
+      path: filePath,
+      contentString: fileString
+    });
+    return smartfile;
+  }
+
+  // ========
+  // INSTANCE
+  // ========
+  /**
+   * the full path of the file on disk
+   */
+  path: string;
+
+  /**
+   *
+   */
+  parsedPath: plugins.path.ParsedPath;
+
+  /**
+   * the content of the file as Buffer
+   */
+  contentBuffer: Buffer;
+
+  /**
+   * The current working directory of the file
+   * Note:this is similar to gulp and different from native node path base
+   */
+  base: string;
+
+  /**
+   * sync the file with disk
+   */
+  sync: boolean;
+
+  /**
+   * the constructor of Smartfile
+   * @param optionsArg
+   */
+
+  constructor(optionsArg: ISmartfileConstructorOptions) {
+    if (optionsArg.contentBuffer) {
+      this.contentBuffer = optionsArg.contentBuffer;
+    } else if (optionsArg.contentString) {
+      this.setContentsFromString(optionsArg.contentString);
+    } else {
+      console.log('created empty Smartfile?');
+    }
+    this.path = optionsArg.path;
+    this.parsedPath = plugins.path.parse(this.path);
+    this.base = optionsArg.base;
+  }
+
+  /**
+   * set contents from string
+   * @param contentString
+   */
+  setContentsFromString(contentString: string) {
+    this.contents = new Buffer(contentString);
+  }
+
+  /**
+   * write file to disk
+   * Behaviours:
+   * - no argument write to exactly where the file was picked up
+   */
+  async write(pathArg?: string) {
+    const stringToWrite = this.contentBuffer.toString();
+    await memory.toFs(stringToWrite, this.path);
+  }
+
+  /**
+   * read file from disk
+   */
+  async read() {}
+
+  // -----------------------------------------------
+  // vinyl compatibility
+  // -----------------------------------------------
+  /**
+   * vinyl-compatibility: alias of this.contentBuffer
+   */
+  get contents(): Buffer {
+    return this.contentBuffer;
+  }
+  set contents(contentsArg) {
+    this.contentBuffer = contentsArg;
+  }
+
+  /**
+   * vinyl-compatibility
+   */
+  get cwd() {
+    return process.cwd();
+  }
+
+  /**
+   * return relative path of file
+   */
+  get relative(): string {
+    return plugins.path.relative(this.base, this.path);
+  }
+
+  /**
+   * return truw when the file has content
+   */
+  isNull(): boolean {
+    if (!this.contentBuffer) {
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * return true if contents are Buffer
+   */
+  isBuffer(): boolean {
+    if (this.contents instanceof Buffer) {
+      return true;
+    }
+    return false;
+  }
+
+  isDirectory() {
+    return false;
+  }
+
+  isStream() {
+    return false;
+  }
+
+  isSymbolic() {
+    return false;
+  }
+
+  // update things
+  updateFileName(fileNameArg: string) {
+    let oldFileName = this.parsedPath.base;
+    this.path = this.path.replace(new RegExp(oldFileName + '$'), fileNameArg);
+  }
+}

ts/smartfile.fs.ts

@@ -0,0 +1,368 @@
+import plugins = require('./smartfile.plugins');
+import SmartfileInterpreter = require('./smartfile.interpreter');
+
+import { Smartfile } from './smartfile.classes.smartfile';
+
+import * as memory from './smartfile.memory';
+/*===============================================================
+============================ Checks =============================
+===============================================================*/
+
+/**
+ *
+ * @param filePath
+ * @returns {boolean}
+ */
+export const fileExistsSync = (filePath): boolean => {
+  let fileExistsBool: boolean = false;
+  try {
+    plugins.fsExtra.readFileSync(filePath);
+    fileExistsBool = true;
+  } catch (err) {
+    fileExistsBool = false;
+  }
+  return fileExistsBool;
+};
+
+/**
+ *
+ * @param filePath
+ * @returns {any}
+ */
+export const fileExists = async (filePath): Promise<boolean> => {
+  const done = plugins.smartpromise.defer<boolean>();
+  plugins.fs.access(filePath, 4, err => {
+    err ? done.resolve(false) : done.resolve(true);
+  });
+  return done.promise;
+};
+
+/**
+ * Checks if given path points to an existing directory
+ */
+export const isDirectory = (pathArg): boolean => {
+  try {
+    return plugins.fsExtra.statSync(pathArg).isDirectory();
+  } catch (err) {
+    return false;
+  }
+};
+
+/**
+ * Checks if a given path points to an existing file
+ */
+export const isFile = (pathArg): boolean => {
+  return plugins.fsExtra.statSync(pathArg).isFile();
+};
+
+/*===============================================================
+============================ FS ACTIONS =========================
+===============================================================*/
+
+/**
+ * copies a file from A to B on the local disk
+ */
+export const copy = async (fromArg: string, toArg: string): Promise<boolean> => {
+  const done = plugins.smartpromise.defer<boolean>();
+  plugins.fsExtra.copy(fromArg, toArg, {}, err => {
+    if (err) {
+      throw new Error(`Could not copy from ${fromArg} to ${toArg}: ${err}`);
+    }
+    done.resolve(true);
+  });
+  return done.promise;
+};
+
+/**
+ * copies a file SYNCHRONOUSLY from A to B on the local disk
+ */
+export const copySync = (fromArg: string, toArg: string): boolean => {
+  plugins.fsExtra.copySync(fromArg, toArg);
+  return true;
+};
+
+/**
+ * ensures that a directory is in place
+ */
+export const ensureDir = async (dirPathArg: string) => {
+  await plugins.fsExtra.ensureDir(dirPathArg);
+};
+
+/**
+ * ensures that a directory is in place
+ */
+export const ensureDirSync = (dirPathArg: string) => {
+  plugins.fsExtra.ensureDirSync(dirPathArg);
+};
+
+/**
+ * ensure an empty directory
+ * @executes ASYNC
+ */
+export const ensureEmptyDir = async (dirPathArg: string) => {
+  await plugins.fsExtra.ensureDir(dirPathArg);
+  await plugins.fsExtra.emptyDir(dirPathArg);
+};
+
+/**
+ * ensure an empty directory
+ * @executes SYNC
+ */
+export const ensureEmptyDirSync = (dirPathArg: string) => {
+  plugins.fsExtra.ensureDirSync(dirPathArg);
+  plugins.fsExtra.emptyDirSync(dirPathArg);
+};
+
+/**
+ * ensures that a file is on disk
+ * @param filePath the filePath to ensureDir
+ * @param the fileContent to place into a new file in case it doesn't exist yet
+ * @returns Promise<void>
+ * @exec ASYNC
+ */
+export const ensureFile = async (filePathArg, initFileStringArg): Promise<void> => {
+  ensureFileSync(filePathArg, initFileStringArg);
+};
+
+/**
+ * ensures that a file is on disk
+ * @param filePath the filePath to ensureDir
+ * @param the fileContent to place into a new file in case it doesn't exist yet
+ * @returns Promise<void>
+ * @exec SYNC
+ */
+export const ensureFileSync = (filePathArg: string, initFileStringArg: string): void => {
+  if (fileExistsSync(filePathArg)) {
+    return null;
+  } else {
+    memory.toFsSync(initFileStringArg, filePathArg);
+  }
+};
+
+/**
+ * removes a file or folder from local disk
+ */
+export const remove = async (pathArg: string): Promise<void> => {
+  await plugins.fsExtra.remove(pathArg);
+};
+
+/**
+ * removes a file SYNCHRONOUSLY from local disk
+ */
+export const removeSync = (pathArg: string): void => {
+  plugins.fsExtra.removeSync(pathArg);
+};
+
+/**
+ * removes an array of filePaths from disk
+ */
+export const removeMany = async (filePathArrayArg: string[]) => {
+  const promiseArray: Array<Promise<void>> = [];
+  for (const filePath of filePathArrayArg) {
+    promiseArray.push(remove(filePath));
+  }
+  await Promise.all(promiseArray);
+};
+
+/**
+ * like removeFilePathArray but SYNCHRONOUSLY
+ */
+export const removeManySync = (filePathArrayArg: string[]): void => {
+  for (const filePath of filePathArrayArg) {
+    removeSync(filePath);
+  }
+};
+
+/*===============================================================
+============================ Write/Read =========================
+===============================================================*/
+
+/**
+ *
+ * @param filePathArg
+ * @param fileTypeArg
+ * @returns {any}
+ */
+export const toObjectSync = (filePathArg, fileTypeArg?) => {
+  const fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
+  let fileType;
+  fileTypeArg ? (fileType = fileTypeArg) : (fileType = SmartfileInterpreter.filetype(filePathArg));
+  return SmartfileInterpreter.objectFile(fileString, fileType);
+};
+
+/**
+ * reads a file content to a String
+ */
+export const toStringSync = (filePath: string): string => {
+  const encoding = plugins.smartmime.getEncoding(filePath);
+  const fileString: string = plugins.fsExtra.readFileSync(filePath, encoding);
+  return fileString;
+};
+
+export const toBufferSync = (filePath: string): Buffer => {
+  return plugins.fsExtra.readFileSync(filePath);
+};
+
+export const fileTreeToHash = async (dirPathArg: string, miniMatchFilter: string) => {
+  const fileTreeObject = await fileTreeToObject(dirPathArg, miniMatchFilter);
+  let combinedString = '';
+  for (const smartfile of fileTreeObject) {
+    combinedString += smartfile.contentBuffer.toString();
+  }
+  const hash = await plugins.smarthash.sha256FromString(combinedString);
+  return hash;
+};
+
+/**
+ * creates a smartfile array from a directory
+ * @param dirPathArg the directory to start from
+ * @param miniMatchFilter a minimatch filter of what files to include
+ */
+export const fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string) => {
+  // handle absolute miniMatchFilter
+  let dirPath: string;
+  if (plugins.path.isAbsolute(miniMatchFilter)) {
+    dirPath = '/';
+  } else {
+    dirPath = dirPathArg;
+  }
+
+  const fileTree = await listFileTree(dirPath, miniMatchFilter);
+  const smartfileArray: Smartfile[] = [];
+  for (const filePath of fileTree) {
+    const readPath = ((): string => {
+      if (!plugins.path.isAbsolute(filePath)) {
+        return plugins.path.join(dirPath, filePath);
+      } else {
+        return filePath;
+      }
+    })();
+    const fileContentString = toStringSync(readPath);
+
+    // push a read file as Smartfile
+    smartfileArray.push(
+      new Smartfile({
+        contentBuffer: Buffer.from(fileContentString),
+        base: dirPath,
+        path: filePath
+      })
+    );
+  }
+  return smartfileArray;
+};
+
+/**
+ * lists Folders in a directory on local disk
+ * @returns Promise with an array that contains the folder names
+ */
+export const listFolders = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
+  return listFoldersSync(pathArg, regexFilter);
+};
+
+/**
+ * lists Folders SYNCHRONOUSLY in a directory on local disk
+ * @returns an array with the folder names as strings
+ */
+export const listFoldersSync = (pathArg: string, regexFilter?: RegExp): string[] => {
+  let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(file => {
+    return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory();
+  });
+  if (regexFilter) {
+    folderArray = folderArray.filter(fileItem => {
+      return regexFilter.test(fileItem);
+    });
+  }
+  return folderArray;
+};
+
+/**
+ * lists Files in a directory on local disk
+ * @returns Promise
+ */
+export const listFiles = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
+  return listFilesSync(pathArg, regexFilter);
+};
+
+/**
+ * lists Files SYNCHRONOUSLY in a directory on local disk
+ * @returns an array with the folder names as strings
+ */
+export const listFilesSync = (pathArg: string, regexFilter?: RegExp): string[] => {
+  let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(file => {
+    return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
+  });
+  if (regexFilter) {
+    fileArray = fileArray.filter(fileItem => {
+      return regexFilter.test(fileItem);
+    });
+  }
+  return fileArray;
+};
+
+/**
+ * lists all items (folders AND files) in a directory on local disk
+ * @returns Promise<string[]>
+ */
+export const listAllItems = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
+  return listAllItemsSync(pathArg, regexFilter);
+};
+
+/**
+ * lists all items (folders AND files) in a directory on local disk
+ * @returns an array with the folder names as strings
+ * @executes SYNC
+ */
+export const listAllItemsSync = (pathArg: string, regexFilter?: RegExp): string[] => {
+  let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter(file => {
+    return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
+  });
+  if (regexFilter) {
+    allItmesArray = allItmesArray.filter(fileItem => {
+      return regexFilter.test(fileItem);
+    });
+  }
+  return allItmesArray;
+};
+
+/**
+ * lists a file tree using a miniMatch filter
+ * note: if the miniMatch Filter is an absolute path, the cwdArg will be omitted
+ * @returns Promise<string[]> string array with the absolute paths of all matching files
+ */
+export const listFileTree = async (
+  dirPathArg: string,
+  miniMatchFilter: string,
+  absolutePathsBool: boolean = false
+): Promise<string[]> => {
+  const done = plugins.smartpromise.defer<string[]>();
+
+  // handle absolute miniMatchFilter
+  let dirPath: string;
+  if (plugins.path.isAbsolute(miniMatchFilter)) {
+    dirPath = '/';
+  } else {
+    dirPath = dirPathArg;
+  }
+
+  const options = {
+    cwd: dirPath,
+    nodir: true,
+    dot: true
+  };
+  plugins.glob(miniMatchFilter, options, (err, files: string[]) => {
+    if (err) {
+      console.log(err);
+      done.reject(err);
+    }
+    done.resolve(files);
+  });
+
+  let fileList = await done.promise;
+  if (absolutePathsBool) {
+    fileList = fileList.map(filePath => {
+      return plugins.path.resolve(plugins.path.join(dirPath, filePath));
+    });
+  }
+
+  return fileList;
+};

ts/smartfile.interpreter.ts

@@ -0,0 +1,20 @@
+import plugins = require('./smartfile.plugins');
+
+export let filetype = (pathArg: string): string => {
+  const extName = plugins.path.extname(pathArg);
+  const fileType = extName.replace(/\.([a-z]*)/, '$1'); // remove . form fileType
+  return fileType;
+};
+
+export let objectFile = (fileStringArg: string, fileTypeArg) => {
+  switch (fileTypeArg) {
+    case 'yml':
+    case 'yaml':
+      return plugins.yaml.safeLoad(fileStringArg);
+    case 'json':
+      return JSON.parse(fileStringArg);
+    default:
+      console.error('file type ' + fileTypeArg.blue + ' not supported');
+      break;
+  }
+};

ts/smartfile.memory.ts

@@ -0,0 +1,94 @@
+import plugins = require('./smartfile.plugins');
+import { Smartfile } from './smartfile.classes.smartfile';
+import * as smartfileFs from './smartfile.fs';
+
+import SmartfileInterpreter = require('./smartfile.interpreter');
+
+/**
+ * converts file to Object
+ * @param fileStringArg
+ * @param fileTypeArg
+ * @returns {any|any}
+ */
+export let toObject = function(fileStringArg: string, fileTypeArg: string) {
+  return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg);
+};
+
+export interface IToFsOptions {
+  respectRelative?: boolean;
+}
+
+/**
+ * writes string or Smartfile to disk.
+ * @param fileArg
+ * @param fileNameArg
+ * @param fileBaseArg
+ */
+export let toFs = async (
+  fileContentArg: string | Buffer | Smartfile,
+  filePathArg: string,
+  optionsArg: IToFsOptions = {}
+) => {
+  const done = plugins.smartpromise.defer();
+
+  // check args
+  if (!fileContentArg || !filePathArg) {
+    throw new Error('expected valid arguments');
+  }
+
+  // prepare actual write action
+  let fileString: string;
+  let fileEncoding: string = 'utf8';
+  let filePath: string = filePathArg;
+
+  // handle Smartfile
+  if (fileContentArg instanceof Smartfile) {
+    fileString = fileContentArg.contentBuffer.toString();
+    // handle options
+    if (optionsArg.respectRelative) {
+      filePath = plugins.path.join(filePath, fileContentArg.path);
+    }
+  } else if (Buffer.isBuffer(fileContentArg)) {
+    fileString = fileContentArg.toString('binary');
+    fileEncoding = 'binary';
+  } else if (typeof fileContentArg === 'string') {
+    fileString = fileContentArg;
+  } else {
+    throw new Error('fileContent is neither string nor Smartfile');
+  }
+  await smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
+  plugins.fsExtra.writeFile(filePath, fileString, { encoding: fileEncoding }, done.resolve);
+  return await done.promise;
+};
+
+/**
+ * writes a string or a Smartfile to disk synchronously, only supports string
+ * @param fileArg
+ * @param filePathArg
+ */
+export let toFsSync = function(fileArg: string, filePathArg: string) {
+  // function checks to abort if needed
+  if (!fileArg || !filePathArg) {
+    throw new Error('expected a valid arguments');
+  }
+
+  // prepare actual write action
+  let fileString: string;
+  let filePath: string = filePathArg;
+
+  if (typeof fileArg !== 'string') {
+    throw new Error('fileArg is not of type String.');
+  } else if (typeof fileArg === 'string') {
+    fileString = fileArg;
+  }
+  plugins.fsExtra.writeFileSync(filePath, fileString, { encoding: 'utf8' });
+};
+
+export let smartfileArrayToFs = async (smartfileArrayArg: Smartfile[], dirArg: string) => {
+  await smartfileFs.ensureDir(dirArg);
+  for (let smartfile of smartfileArrayArg) {
+    await toFs(smartfile, dirArg, {
+      respectRelative: true
+    });
+  }
+};

ts/smartfile.plugins.ts

@@ -1,15 +1,21 @@
-/// <reference path="./index.ts" />
-module SmartfilePlugins {
-    export var init = function() {
-        var plugins = {
-            beautylog: require("beautylog"),
-            fs: require("fs-extra"),
-            path: require("path"),
-            vinyl: require("vinyl"),
-            vinylFile: require("vinyl-file"),
-            yaml: require("js-yaml"),
-            requireReload: require("require-reload")
-        };
-        return plugins;
-    }
-}
+// node native scope
+import * as fs from 'fs';
+import * as path from 'path';
+
+export { fs, path };
+
+// @pushrocks scope
+import * as smarthash from '@pushrocks/smarthash';
+import * as smartmime from '@pushrocks/smartmime';
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrequest from '@pushrocks/smartrequest';
+
+export { smarthash, smartmime, smartpath, smartpromise, smartrequest };
+
+// third party scope
+import * as fsExtra from 'fs-extra';
+import glob from 'glob';
+import yaml from 'js-yaml';
+
+export { fsExtra, glob, yaml };

ts/smartfile.remote.ts

@@ -0,0 +1,51 @@
+import plugins = require('./smartfile.plugins');
+import SmartfileInterpreter = require('./smartfile.interpreter');
+
+/* export let toFs = function (from: string, toPath: string) {
+  let done = plugins.q.defer()
+  let stream = plugins.smartrequest(from).pipe(plugins.fsExtra.createWriteStream(toPath))
+  stream.on('finish', function () {
+    done.resolve(toPath)
+  })
+  return done.promise
+} */
+
+/**
+ *
+ * @param fromArg
+ * @returns {any}
+ */
+export let toObject = (fromArg: string) => {
+  const done = plugins.smartpromise.defer();
+  plugins.smartrequest
+    .request(fromArg, {
+      method: 'get'
+    })
+    .then((res: any) => {
+      if (res.statusCode === 200) {
+        done.resolve(res.body);
+      } else {
+        console.log('could not get remote file from ' + fromArg);
+        done.reject(new Error('could not get remote file from ' + fromArg));
+      }
+    });
+  return done.promise;
+};
+
+/**
+ *
+ * @param fromArg
+ * @returns {any}
+ */
+export let toString = (fromArg: string): Promise<string> => {
+  const done = plugins.smartpromise.defer<string>();
+  plugins.smartrequest.getBinary(fromArg).then((res: any) => {
+    if (res.statusCode === 200) {
+      const encoding = plugins.smartmime.getEncoding(fromArg);
+      done.resolve(res.body.toString(encoding));
+    } else {
+      done.reject(new Error('could not get remote file from ' + fromArg));
+    }
+  });
+  return done.promise;
+};

ts/smartfile.require.ts

@@ -1,10 +0,0 @@
-/// <reference path="./index.ts" />
-module SmartfileRequire {
-    var requireReload = function(path:string){
-        return plugins.requireReload(path);
-    };
-
-    export var init = function(objectArg){
-        objectArg.requireReload = requireReload;
-    }
-}

ts/smartfile.simple.ts

@@ -1,39 +0,0 @@
-/// <reference path="./index.ts" />
-module SmartfileSimple {
-    /**
-     * reads a file content to a String
-     * @param filePath
-     * @returns {string|Buffer|any}
-     */
-    var readFileToString = function(filePath) {
-        var fileString;
-        fileString = plugins.fs.readFileSync(filePath, "utf8");
-        return fileString;
-    };
-    var readFileToObject = function(filePath,fileTypeArg = "undefined") {
-        var fileType;
-        if (fileTypeArg == "undefined") {
-            fileType = plugins.path.extname(filePath);
-        } else {
-            fileType = fileTypeArg;
-        }
-        fileType = fileType.replace(/\.([a-z]*)/,"$1"); //remove . form fileType
-        switch (fileType) {
-            case "yml" :
-            case "yaml":
-                try {
-                    return plugins.yaml.safeLoad(plugins.fs.readFileSync(filePath, 'utf8'));
-                } catch (e){
-                    plugins.beautylog.error("check that " + filePath.blue + " points to a valid file");
-                }
-                break;
-            case "json":
-                return plugins.fs.readJsonSync(filePath,{});
-                break;
-        }
-    };
-    export var init = function(objectArg) {
-        objectArg.readFileToString = readFileToString;
-        objectArg.readFileToObject = readFileToObject;
-    };
-}

ts/smartfile.vinyl.ts

@@ -1,9 +0,0 @@
-/// <reference path="./index.ts" />
-module SmartfileVinyl {
-    var readFileToVinyl = function(filePathArg,options = {}) {
-        return plugins.vinylFile.readSync(filePathArg,options);
-    };
-    export var init = function(objectArg) {
-        objectArg.readFileToVinyl = readFileToVinyl;
-    };
-}

ts/test.ts

@@ -1,36 +0,0 @@
-/// <reference path="typings/main.d.ts" />
-var smartfile = require("../index.js");
-var beautylog = require("beautylog");
-var should = require("should");
-var vinyl = require("vinyl");
-describe("smartfile",function(){
-    describe(".readFileToString".yellow,function(){
-        it("should read a file to a string",function(){
-            should.equal(
-                smartfile.readFileToString("./test/mytest.txt"),
-                "Some TestString &&%$"
-            );
-        });
-    });
-    describe(".readFileToObject".yellow,function(){
-        it("should read an " + ".yaml".blue + " file to an object",function(){
-            var testData = smartfile.readFileToObject("./test/mytest.yaml");
-            testData.should.have.property("key1","this works");
-            testData.should.have.property("key2","this works too");
-
-        });
-        it("should read an " + ".json".blue + " file to an object",function(){
-            var testData = smartfile.readFileToObject("./test/mytest.json");
-            testData.should.have.property("key1","this works");
-            testData.should.have.property("key2","this works too");
-
-        });
-    });
-    describe(".readFileToVinyl".yellow,function(){
-        it("should read an " + ".json OR .yaml".blue + " file to an " + "vinyl file object".cyan,function(){
-            var testData = smartfile.readFileToVinyl("./test/mytest.json");
-            (vinyl.isVinyl(testData)).should.be.true();
-
-        });
-    });
-});

ts/typings.json

@@ -1,7 +0,0 @@
-{
-  "ambientDependencies": {
-    "browserify": "github:DefinitelyTyped/DefinitelyTyped/browserify/browserify.d.ts",
-    "mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
-    "node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts"
-  }
-}

tslint.json

@@ -0,0 +1,17 @@
+{
+  "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"
+}