7.0.8

.gitignore

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

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,108 +18,103 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
-    - npmci command npm install -g snyk
+    - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci node install lts
+    - npmci npm prepare
-  - npmci npm install
+    - npmci node install stable
-  - npmci npm test
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
-    
+    - priv
-testSTABLE:
+
+testBuild:
   stage: test
   script:
-  - npmci node install stable
+    - npmci npm prepare
-  - npmci npm install
+    - npmci node install stable
-  - npmci npm test
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
+    - npmci node install lts
-    - npmci command npmpage
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -127,15 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - 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.1
+ignore: {}
+patch: {}

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

README.md

@@ -1,43 +0,0 @@
-# @pushrocks/smartfile
-
-make files easily accessible for processing in javascript.
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartfile)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartfile)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartfile)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartfile/)
-
-## Status for master
-
-[![build status](https://gitlab.com/pushrocks/smartfile/badges/master/build.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)
-[![Dependency Status](https://david-dm.org/pushrocks/smartfile.svg)](https://david-dm.org/pushrocks/smartfile)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfile/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartfile/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartfile)
-[![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
-
-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 |
-
-For further information read the linked docs at the top of this README.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,10 +0,0 @@
-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';
-export declare let fs: typeof SmartfileFs;
-export declare let interpreter: typeof SmartfileInterpreter;
-export declare let memory: typeof SmartfileMemory;
-export declare let remote: typeof SmartfileRemote;
-export declare let requireReload: (path: string) => any;

dist/index.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const SmartfileFs = require("./smartfile.fs");
-const SmartfileInterpreter = require("./smartfile.interpreter");
-const SmartfileMemory = require("./smartfile.memory");
-const SmartfileRemote = require("./smartfile.remote");
-var smartfile_classes_smartfile_1 = require("./smartfile.classes.smartfile");
-exports.Smartfile = smartfile_classes_smartfile_1.Smartfile;
-exports.fs = SmartfileFs;
-exports.interpreter = SmartfileInterpreter;
-exports.memory = SmartfileMemory;
-exports.remote = SmartfileRemote;
-exports.requireReload = SmartfileFs.requireReload;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLDhDQUE4QztBQUM5QyxnRUFBZ0U7QUFDaEUsc0RBQXNEO0FBQ3RELHNEQUFzRDtBQUV0RCw2RUFBMEQ7QUFBakQsa0RBQUEsU0FBUyxDQUFBO0FBRVAsUUFBQSxFQUFFLEdBQUcsV0FBVyxDQUFDO0FBQ2pCLFFBQUEsV0FBVyxHQUFHLG9CQUFvQixDQUFDO0FBQ25DLFFBQUEsTUFBTSxHQUFHLGVBQWUsQ0FBQztBQUN6QixRQUFBLE1BQU0sR0FBRyxlQUFlLENBQUM7QUFDekIsUUFBQSxhQUFhLEdBQUcsV0FBVyxDQUFDLGFBQWEsQ0FBQyJ9

dist/smartfile.classes.smartfile.d.ts

@@ -1,79 +0,0 @@
-/// <reference types="node" />
-import * as plugins from './smartfile.plugins';
-export interface ISmartfileConstructorOptions {
-    path?: string;
-    contentString?: string;
-    contentBuffer?: Buffer;
-    base?: string;
-}
-/**
- * class Smartfile
- * -> is vinyl file compatible
- */
-export declare class Smartfile {
-    /**
-     * 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);
-    /**
-     * set contents from string
-     * @param contentString
-     */
-    setContentsFromString(contentString: string): void;
-    /**
-     * write file to disk
-     * Behaviours:
-     * - no argument write to exactly where the file was picked up
-     */
-    write(pathArg?: string): Promise<void>;
-    /**
-     * read file from disk
-     */
-    read(): Promise<void>;
-    /**
-     * vinyl-compatibility: alias of this.contentBuffer
-     */
-    contents: Buffer;
-    /**
-     * vinyl-compatibility
-     */
-    readonly cwd: string;
-    /**
-     * return relative path of file
-     */
-    readonly relative: string;
-    /**
-     * return truw when the file has content
-     */
-    isNull(): boolean;
-    /**
-     * return true if contents are Buffer
-     */
-    isBuffer(): boolean;
-    isDirectory(): boolean;
-    isStream(): boolean;
-    isSymbolic(): boolean;
-    updateFileName(fileNameArg: string): void;
-}

dist/smartfile.classes.smartfile.js

@@ -1,118 +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("./smartfile.plugins");
-const memory = require("./smartfile.memory");
-/**
- * class Smartfile
- * -> is vinyl file compatible
- */
-class Smartfile {
-    /**
-     * the constructor of Smartfile
-     * @param optionsArg
-     */
-    constructor(optionsArg) {
-        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) {
-        this.contents = new Buffer(contentString);
-    }
-    /**
-     * write file to disk
-     * Behaviours:
-     * - no argument write to exactly where the file was picked up
-     */
-    write(pathArg) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const stringToWrite = this.contentBuffer.toString();
-            yield memory.toFs(stringToWrite, this.path);
-        });
-    }
-    /**
-     * read file from disk
-     */
-    read() {
-        return __awaiter(this, void 0, void 0, function* () { });
-    }
-    // -----------------------------------------------
-    // vinyl compatibility
-    // -----------------------------------------------
-    /**
-     * vinyl-compatibility: alias of this.contentBuffer
-     */
-    get contents() {
-        return this.contentBuffer;
-    }
-    set contents(contentsArg) {
-        this.contentBuffer = contentsArg;
-    }
-    /**
-     * vinyl-compatibility
-     */
-    get cwd() {
-        return process.cwd();
-    }
-    /**
-     * return relative path of file
-     */
-    get relative() {
-        return plugins.path.relative(this.base, this.path);
-    }
-    /**
-     * return truw when the file has content
-     */
-    isNull() {
-        if (!this.contentBuffer) {
-            return true;
-        }
-        return false;
-    }
-    /**
-     * return true if contents are Buffer
-     */
-    isBuffer() {
-        if (this.contents instanceof Buffer) {
-            return true;
-        }
-        return false;
-    }
-    isDirectory() {
-        return false;
-    }
-    isStream() {
-        return false;
-    }
-    isSymbolic() {
-        return false;
-    }
-    // update things
-    updateFileName(fileNameArg) {
-        let oldFileName = this.parsedPath.base;
-        this.path = this.path.replace(new RegExp(oldFileName + '$'), fileNameArg);
-    }
-}
-exports.Smartfile = Smartfile;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSwrQ0FBK0M7QUFFL0MsNkNBQTZDO0FBUzdDOzs7R0FHRztBQUNIO0lBMkJFOzs7T0FHRztJQUVILFlBQVksVUFBd0M7UUFDbEQsSUFBSSxVQUFVLENBQUMsYUFBYSxFQUFFO1lBQzVCLElBQUksQ0FBQyxhQUFhLEdBQUcsVUFBVSxDQUFDLGFBQWEsQ0FBQztTQUMvQzthQUFNLElBQUksVUFBVSxDQUFDLGFBQWEsRUFBRTtZQUNuQyxJQUFJLENBQUMscUJBQXFCLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxDQUFDO1NBQ3REO2FBQU07WUFDTCxPQUFPLENBQUMsR0FBRyxDQUFDLDBCQUEwQixDQUFDLENBQUM7U0FDekM7UUFDRCxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUM7UUFDNUIsSUFBSSxDQUFDLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDaEQsSUFBSSxDQUFDLElBQUksR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDO0lBQzlCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxxQkFBcUIsQ0FBQyxhQUFxQjtRQUN6QyxJQUFJLENBQUMsUUFBUSxHQUFHLElBQUksTUFBTSxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0csS0FBSyxDQUFDLE9BQWdCOztZQUMxQixNQUFNLGFBQWEsR0FBRyxJQUFJLENBQUMsYUFBYSxDQUFDLFFBQVEsRUFBRSxDQUFDO1lBQ3BELE1BQU0sTUFBTSxDQUFDLElBQUksQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzlDLENBQUM7S0FBQTtJQUVEOztPQUVHO0lBQ0csSUFBSTs4REFBSSxDQUFDO0tBQUE7SUFFZixrREFBa0Q7SUFDbEQsc0JBQXNCO0lBQ3RCLGtEQUFrRDtJQUNsRDs7T0FFRztJQUNILElBQUksUUFBUTtRQUNWLE9BQU8sSUFBSSxDQUFDLGFBQWEsQ0FBQztJQUM1QixDQUFDO0lBQ0QsSUFBSSxRQUFRLENBQUMsV0FBVztRQUN0QixJQUFJLENBQUMsYUFBYSxHQUFHLFdBQVcsQ0FBQztJQUNuQyxDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJLEdBQUc7UUFDTCxPQUFPLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJLFFBQVE7UUFDVixPQUFPLE9BQU8sQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3JELENBQUM7SUFFRDs7T0FFRztJQUNILE1BQU07UUFDSixJQUFJLENBQUMsSUFBSSxDQUFDLGFBQWEsRUFBRTtZQUN2QixPQUFPLElBQUksQ0FBQztTQUNiO1FBQ0QsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQ7O09BRUc7SUFDSCxRQUFRO1FBQ04sSUFBSSxJQUFJLENBQUMsUUFBUSxZQUFZLE1BQU0sRUFBRTtZQUNuQyxPQUFPLElBQUksQ0FBQztTQUNiO1FBQ0QsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsV0FBVztRQUNULE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUVELFFBQVE7UUFDTixPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCxVQUFVO1FBQ1IsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUQsZ0JBQWdCO0lBQ2hCLGNBQWMsQ0FBQyxXQUFtQjtRQUNoQyxJQUFJLFdBQVcsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQztRQUN2QyxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksTUFBTSxDQUFDLFdBQVcsR0FBRyxHQUFHLENBQUMsRUFBRSxXQUFXLENBQUMsQ0FBQztJQUM1RSxDQUFDO0NBQ0Y7QUFwSUQsOEJBb0lDIn0=

dist/smartfile.fs.d.ts

@@ -1,143 +0,0 @@
-import { Smartfile } from './smartfile.classes.smartfile';
-/**
- *
- * @param filePath
- * @returns {boolean}
- */
-export declare let fileExistsSync: (filePath: any) => boolean;
-/**
- *
- * @param filePath
- * @returns {any}
- */
-export declare let fileExists: (filePath: any) => Promise<{}>;
-/**
- * Checks if given path points to an existing directory
- */
-export declare let isDirectory: (pathArg: any) => boolean;
-/**
- * Checks if a given path points to an existing file
- */
-export declare let isFile: (pathArg: any) => boolean;
-/**
- * copies a file from A to B on the local disk
- */
-export declare let copy: (fromArg: string, toArg: string) => Promise<{}>;
-/**
- * copies a file SYNCHRONOUSLY from A to B on the local disk
- */
-export declare let copySync: (fromArg: string, toArg: string) => boolean;
-/**
- * ensures that a directory is in place
- */
-export declare let ensureDir: (dirPathArg: string) => Promise<{}>;
-/**
- * ensures that a directory is in place
- */
-export declare let ensureDirSync: (dirPathArg: string) => void;
-/**
- * ensure an empty directory
- * @executes ASYNC
- */
-export declare let ensureEmptyDir: (dirPathArg: string) => Promise<{}>;
-/**
- * ensure an empty directory
- * @executes SYNC
- */
-export declare let ensureEmptyDirSync: (dirPathArg: string) => void;
-/**
- * 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 declare let ensureFile: (filePathArg: any, initFileStringArg: any) => Promise<void>;
-/**
- * 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 declare let ensureFileSync: (filePathArg: string, initFileStringArg: string) => void;
-/**
- * removes a file or folder from local disk
- */
-export declare let remove: (pathArg: string) => Promise<void>;
-/**
- * removes a file SYNCHRONOUSLY from local disk
- */
-export declare let removeSync: (pathArg: string) => boolean;
-/**
- * removes an array of filePaths from disk
- */
-export declare let removeMany: (filePathArrayArg: string[]) => Promise<void[]>;
-/**
- * like removeFilePathArray but SYNCHRONOUSLY
- */
-export declare let removeManySync: (filePathArrayArg: string[]) => void;
-/**
- *
- * @param filePathArg
- * @param fileTypeArg
- * @returns {any}
- */
-export declare let toObjectSync: (filePathArg: any, fileTypeArg?: any) => any;
-/**
- * reads a file content to a String
- * @param filePath
- * @returns {string|Buffer|any}
- */
-export declare let toStringSync: (filePath: string) => string;
-export declare let fileTreeToObject: (dirPathArg: string, miniMatchFilter: string) => Promise<Smartfile[]>;
-/**
- *
- * @param filePathArg
- * @param options
- * @returns {number}
- */
-export declare let toVinylSync: (filePathArg: any, options?: {}) => any;
-/**
- * lets you reload files hot.
- * @param path
- * @returns {any}
- */
-export declare let requireReload: (path: string) => any;
-/**
- * lists Folders in a directory on local disk
- * @returns Promise
- */
-export declare let listFolders: (pathArg: string, regexFilter?: RegExp) => Promise<{}>;
-/**
- * lists Folders SYNCHRONOUSLY in a directory on local disk
- * @returns an array with the folder names as strings
- */
-export declare let listFoldersSync: (pathArg: string, regexFilter?: RegExp) => string[];
-/**
- * lists Files in a directory on local disk
- * @returns Promise
- */
-export declare let listFiles: (pathArg: string, regexFilter?: RegExp) => Promise<{}>;
-/**
- * lists Files SYNCHRONOUSLY in a directory on local disk
- * @returns an array with the folder names as strings
- */
-export declare let listFilesSync: (pathArg: string, regexFilter?: RegExp) => string[];
-/**
- * lists all items (folders AND files) in a directory on local disk
- * @returns Promise<string[]>
- */
-export declare let listAllItems: (pathArg: string, regexFilter?: RegExp) => Promise<string[]>;
-/**
- * lists all items (folders AND files) in a directory on local disk
- * @returns an array with the folder names as strings
- * @executes SYNC
- */
-export declare let listAllItemsSync: (pathArg: string, regexFilter?: RegExp) => string[];
-/**
- * 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 declare let listFileTree: (dirPathArg: string, miniMatchFilter: string) => Promise<string[]>;

dist/smartfile.interpreter.d.ts

@@ -1,2 +0,0 @@
-export declare let filetype: (pathArg: string) => string;
-export declare let objectFile: (fileStringArg: string, fileTypeArg: any) => any;

dist/smartfile.interpreter.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const plugins = require("./smartfile.plugins");
-exports.filetype = (pathArg) => {
-    let extName = plugins.path.extname(pathArg);
-    let fileType = extName.replace(/\.([a-z]*)/, '$1'); // remove . form fileType
-    return fileType;
-};
-exports.objectFile = (fileStringArg, 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;
-    }
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmludGVycHJldGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmludGVycHJldGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsK0NBQWdEO0FBRXJDLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZSxFQUFVLEVBQUU7SUFDaEQsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDNUMsSUFBSSxRQUFRLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQyx5QkFBeUI7SUFDN0UsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFDO0FBRVMsUUFBQSxVQUFVLEdBQUcsQ0FBQyxhQUFxQixFQUFFLFdBQVcsRUFBRSxFQUFFO0lBQzdELFFBQVEsV0FBVyxFQUFFO1FBQ25CLEtBQUssS0FBSyxDQUFDO1FBQ1gsS0FBSyxNQUFNO1lBQ1QsT0FBTyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUM5QyxLQUFLLE1BQU07WUFDVCxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDbkM7WUFDRSxPQUFPLENBQUMsS0FBSyxDQUFDLFlBQVksR0FBRyxXQUFXLENBQUMsSUFBSSxHQUFHLGdCQUFnQixDQUFDLENBQUM7WUFDbEUsTUFBTTtLQUNUO0FBQ0gsQ0FBQyxDQUFDIn0=

dist/smartfile.memory.d.ts

@@ -1,25 +0,0 @@
-import { Smartfile } from './smartfile.classes.smartfile';
-/**
- * converts file to Object
- * @param fileStringArg
- * @param fileTypeArg
- * @returns {any|any}
- */
-export declare let toObject: (fileStringArg: string, fileTypeArg: string) => any;
-export interface IToFsOptions {
-    respectRelative?: boolean;
-}
-/**
- * writes string or Smartfile to disk.
- * @param fileArg
- * @param fileNameArg
- * @param fileBaseArg
- */
-export declare let toFs: (fileContentArg: string | Smartfile, filePathArg: any, optionsArg?: IToFsOptions) => Promise<{}>;
-/**
- * writes a string or a Smartfile to disk synchronously, only supports string
- * @param fileArg
- * @param filePathArg
- */
-export declare let toFsSync: (fileArg: string, filePathArg: string) => void;
-export declare let smartfileArrayToFs: (smartfileArrayArg: Smartfile[], dirArg: string) => Promise<void>;

dist/smartfile.memory.js

@@ -1,87 +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("./smartfile.plugins");
-const smartfile_classes_smartfile_1 = require("./smartfile.classes.smartfile");
-const smartfileFs = require("./smartfile.fs");
-const SmartfileInterpreter = require("./smartfile.interpreter");
-/**
- * converts file to Object
- * @param fileStringArg
- * @param fileTypeArg
- * @returns {any|any}
- */
-exports.toObject = function (fileStringArg, fileTypeArg) {
-    return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg);
-};
-/**
- * writes string or Smartfile to disk.
- * @param fileArg
- * @param fileNameArg
- * @param fileBaseArg
- */
-exports.toFs = (fileContentArg, filePathArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    let done = plugins.smartpromise.defer();
-    // check args
-    if (!fileContentArg || !filePathArg) {
-        throw new Error('expected valid arguments');
-    }
-    // prepare actual write action
-    let fileString;
-    let filePath = filePathArg;
-    // handle Smartfile
-    if (fileContentArg instanceof smartfile_classes_smartfile_1.Smartfile) {
-        let fileContentArg2 = fileContentArg;
-        fileString = fileContentArg.contentBuffer.toString();
-        // handle options
-        if (optionsArg.respectRelative) {
-            filePath = plugins.path.join(filePath, fileContentArg.path);
-        }
-    }
-    else if (typeof fileContentArg === 'string') {
-        fileString = fileContentArg;
-    }
-    else {
-        throw new Error('fileContent is neither string nor Smartfile');
-    }
-    yield smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
-    plugins.fsExtra.writeFile(filePath, fileString, { encoding: 'utf8' }, done.resolve);
-    return yield done.promise;
-});
-/**
- * writes a string or a Smartfile to disk synchronously, only supports string
- * @param fileArg
- * @param filePathArg
- */
-exports.toFsSync = function (fileArg, filePathArg) {
-    // function checks to abort if needed
-    if (!fileArg || !filePathArg) {
-        throw new Error('expected a valid arguments');
-    }
-    // prepare actual write action
-    let fileString;
-    let filePath = 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' });
-};
-exports.smartfileArrayToFs = (smartfileArrayArg, dirArg) => __awaiter(this, void 0, void 0, function* () {
-    yield smartfileFs.ensureDir(dirArg);
-    for (let smartfile of smartfileArrayArg) {
-        yield exports.toFs(smartfile, dirArg, {
-            respectRelative: true
-        });
-    }
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLm1lbW9yeS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5tZW1vcnkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7OztBQUFBLCtDQUFnRDtBQUNoRCwrRUFBMEQ7QUFDMUQsOENBQThDO0FBRTlDLGdFQUFpRTtBQUVqRTs7Ozs7R0FLRztBQUNRLFFBQUEsUUFBUSxHQUFHLFVBQVMsYUFBcUIsRUFBRSxXQUFtQjtJQUN2RSxPQUFPLG9CQUFvQixDQUFDLFVBQVUsQ0FBQyxhQUFhLEVBQUUsV0FBVyxDQUFDLENBQUM7QUFDckUsQ0FBQyxDQUFDO0FBTUY7Ozs7O0dBS0c7QUFDUSxRQUFBLElBQUksR0FBRyxDQUNoQixjQUFrQyxFQUNsQyxXQUFXLEVBQ1gsYUFBMkIsRUFBRSxFQUM3QixFQUFFO0lBQ0YsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUV4QyxhQUFhO0lBQ2IsSUFBSSxDQUFDLGNBQWMsSUFBSSxDQUFDLFdBQVcsRUFBRTtRQUNuQyxNQUFNLElBQUksS0FBSyxDQUFDLDBCQUEwQixDQUFDLENBQUM7S0FDN0M7SUFFRCw4QkFBOEI7SUFDOUIsSUFBSSxVQUFrQixDQUFDO0lBQ3ZCLElBQUksUUFBUSxHQUFXLFdBQVcsQ0FBQztJQUVuQyxtQkFBbUI7SUFDbkIsSUFBSSxjQUFjLFlBQVksdUNBQVMsRUFBRTtRQUN2QyxJQUFJLGVBQWUsR0FBUSxjQUFjLENBQUM7UUFDMUMsVUFBVSxHQUFHLGNBQWMsQ0FBQyxhQUFhLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDckQsaUJBQWlCO1FBQ2pCLElBQUksVUFBVSxDQUFDLGVBQWUsRUFBRTtZQUM5QixRQUFRLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLGNBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUM3RDtLQUNGO1NBQU0sSUFBSSxPQUFPLGNBQWMsS0FBSyxRQUFRLEVBQUU7UUFDN0MsVUFBVSxHQUFHLGNBQWMsQ0FBQztLQUM3QjtTQUFNO1FBQ0wsTUFBTSxJQUFJLEtBQUssQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFDO0tBQ2hFO0lBQ0QsTUFBTSxXQUFXLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzlELE9BQU8sQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLFFBQVEsRUFBRSxVQUFVLEVBQUUsRUFBRSxRQUFRLEVBQUUsTUFBTSxFQUFFLEVBQUUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3BGLE9BQU8sTUFBTSxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQzVCLENBQUMsQ0FBQSxDQUFDO0FBRUY7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLFVBQVMsT0FBZSxFQUFFLFdBQW1CO0lBQ2pFLHFDQUFxQztJQUNyQyxJQUFJLENBQUMsT0FBTyxJQUFJLENBQUMsV0FBVyxFQUFFO1FBQzVCLE1BQU0sSUFBSSxLQUFLLENBQUMsNEJBQTRCLENBQUMsQ0FBQztLQUMvQztJQUVELDhCQUE4QjtJQUM5QixJQUFJLFVBQWtCLENBQUM7SUFDdkIsSUFBSSxRQUFRLEdBQVcsV0FBVyxDQUFDO0lBRW5DLElBQUksT0FBTyxPQUFPLEtBQUssUUFBUSxFQUFFO1FBQy9CLE1BQU0sSUFBSSxLQUFLLENBQUMsZ0NBQWdDLENBQUMsQ0FBQztLQUNuRDtTQUFNLElBQUksT0FBTyxPQUFPLEtBQUssUUFBUSxFQUFFO1FBQ3RDLFVBQVUsR0FBRyxPQUFPLENBQUM7S0FDdEI7SUFDRCxPQUFPLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxRQUFRLEVBQUUsVUFBVSxFQUFFLEVBQUUsUUFBUSxFQUFFLE1BQU0sRUFBRSxDQUFDLENBQUM7QUFDNUUsQ0FBQyxDQUFDO0FBRVMsUUFBQSxrQkFBa0IsR0FBRyxDQUFPLGlCQUE4QixFQUFFLE1BQWMsRUFBRSxFQUFFO0lBQ3ZGLE1BQU0sV0FBVyxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNwQyxLQUFLLElBQUksU0FBUyxJQUFJLGlCQUFpQixFQUFFO1FBQ3ZDLE1BQU0sWUFBSSxDQUFDLFNBQVMsRUFBRSxNQUFNLEVBQUU7WUFDNUIsZUFBZSxFQUFFLElBQUk7U0FDdEIsQ0FBQyxDQUFDO0tBQ0o7QUFDSCxDQUFDLENBQUEsQ0FBQyJ9

dist/smartfile.plugins.d.ts

@@ -1,10 +0,0 @@
-export import fs = require('fs');
-export import fsExtra = require('fs-extra');
-export declare let glob: any;
-export import path = require('path');
-export import smartpromise = require('@pushrocks/smartpromise');
-export import smartrequest = require('@pushrocks/smartrequest');
-export declare let requireReload: any;
-export import smartpath = require('smartpath');
-export declare let vinylFile: any;
-export declare let yaml: any;

dist/smartfile.plugins.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fs = require("fs");
-exports.fsExtra = require("fs-extra");
-exports.glob = require('glob');
-exports.path = require("path");
-exports.smartpromise = require("@pushrocks/smartpromise");
-exports.smartrequest = require("@pushrocks/smartrequest");
-exports.requireReload = require('require-reload');
-exports.smartpath = require("smartpath");
-exports.vinylFile = require('vinyl-file');
-exports.yaml = require('js-yaml');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDJCQUFpQztBQUNqQyxzQ0FBNEM7QUFDakMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQ2xDLCtCQUFxQztBQUNyQywwREFBZ0U7QUFDaEUsMERBQWdFO0FBQ3JELFFBQUEsYUFBYSxHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0FBQ3JELHlDQUErQztBQUNwQyxRQUFBLFNBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7QUFDbEMsUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDIn0=

dist/smartfile.remote.d.ts

@@ -1,12 +0,0 @@
-/**
- *
- * @param fromArg
- * @returns {any}
- */
-export declare let toObject: (fromArg: string) => Promise<{}>;
-/**
- *
- * @param fromArg
- * @returns {any}
- */
-export declare let toString: (fromArg: string) => Promise<{}>;

dist/smartfile.remote.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const plugins = require("./smartfile.plugins");
-/* 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}
- */
-exports.toObject = function (fromArg) {
-    let done = plugins.smartpromise.defer();
-    plugins.smartrequest
-        .request(fromArg, {
-        method: 'get'
-    })
-        .then((res) => {
-        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}
- */
-exports.toString = (fromArg) => {
-    let done = plugins.smartpromise.defer();
-    plugins.smartrequest.get(fromArg).then((res) => {
-        if (res.statusCode === 200) {
-            done.resolve(res.body);
-        }
-        else {
-            done.reject(new Error('could not get remote file from ' + fromArg));
-        }
-    });
-    return done.promise;
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnJlbW90ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0ZmlsZS5yZW1vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSwrQ0FBZ0Q7QUFHaEQ7Ozs7Ozs7SUFPSTtBQUVKOzs7O0dBSUc7QUFDUSxRQUFBLFFBQVEsR0FBRyxVQUFTLE9BQWU7SUFDNUMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUN4QyxPQUFPLENBQUMsWUFBWTtTQUNqQixPQUFPLENBQUMsT0FBTyxFQUFFO1FBQ2hCLE1BQU0sRUFBRSxLQUFLO0tBQ2QsQ0FBQztTQUNELElBQUksQ0FBQyxDQUFDLEdBQVEsRUFBRSxFQUFFO1FBQ2pCLElBQUksR0FBRyxDQUFDLFVBQVUsS0FBSyxHQUFHLEVBQUU7WUFDMUIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7U0FDeEI7YUFBTTtZQUNMLE9BQU8sQ0FBQyxHQUFHLENBQUMsaUNBQWlDLEdBQUcsT0FBTyxDQUFDLENBQUM7WUFDekQsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLEtBQUssQ0FBQyxpQ0FBaUMsR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDO1NBQ3JFO0lBQ0gsQ0FBQyxDQUFDLENBQUM7SUFDTCxPQUFPLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDdEIsQ0FBQyxDQUFDO0FBRUY7Ozs7R0FJRztBQUNRLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBZSxFQUFFLEVBQUU7SUFDeEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUN4QyxPQUFPLENBQUMsWUFBWSxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxHQUFRLEVBQUUsRUFBRTtRQUNsRCxJQUFJLEdBQUcsQ0FBQyxVQUFVLEtBQUssR0FBRyxFQUFFO1lBQzFCLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQ3hCO2FBQU07WUFDTCxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksS0FBSyxDQUFDLGlDQUFpQyxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUM7U0FDckU7SUFDSCxDQUFDLENBQUMsQ0FBQztJQUNILE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN0QixDQUFDLENBQUMifQ==

docs/index.md

@@ -1,43 +0,0 @@
-# smartfile
-
-make files easily accessible for processing in javascript.
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartfile)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartfile)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartfile)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartfile/)
-
-## Status for master
-
-[![build status](https://gitlab.com/pushrocks/smartfile/badges/master/build.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)
-[![Dependency Status](https://david-dm.org/pushrocks/smartfile.svg)](https://david-dm.org/pushrocks/smartfile)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfile/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartfile/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartfile)
-[![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
-
-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 |
-
-For further information read the linked docs at the top of this README.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

npmextra.json

@@ -1,13 +1,22 @@
 {
-  "npmts":{
+  "npmts": {
-    "mode":"default",
+    "mode": "default",
-    "coverageTreshold":70
+    "coverageTreshold": 70
-  },
-  "npmdocker":{
-    
   },
+  "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,7 +1,7 @@
 {
   "name": "@pushrocks/smartfile",
   "private": false,
-  "version": "6.0.5",
+  "version": "7.0.8",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -28,22 +28,34 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartfile",
   "dependencies": {
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smarthash": "^2.0.6",
-    "@pushrocks/smartrequest": "^1.0.15",
+    "@pushrocks/smartpath": "^4.0.1",
-    "@types/fs-extra": "^5.0.3",
+    "@pushrocks/smartpromise": "^3.0.5",
-    "@types/vinyl": "^2.0.2",
+    "@pushrocks/smartrequest": "^1.1.27",
-    "fs-extra": "^6.0.1",
+    "@types/fs-extra": "^8.0.0",
-    "glob": "^7.1.2",
+    "fs-extra": "^8.1.0",
-    "js-yaml": "^3.10.0",
+    "glob": "^7.1.4",
-    "smartpath": "^3.2.8",
+    "js-yaml": "^3.13.1"
-    "vinyl-file": "^3.0.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.21",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.1.1",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.12",
+    "@gitzone/tstest": "^1.0.24",
-    "@types/node": "^10.5.1",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.8",
     "gulp-function": "^2.2.14",
-    "tapbundle": "^2.0.2"
+    "tslint": "^5.20.0",
-  }
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,45 @@
+# @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.ts

@@ -1,119 +1,139 @@
 import * as smartfile from '../ts/index';
 import path = require('path');
 
-import { expect, tap } from 'tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 
 // ---------------------------
 // smartfile.fs
 // ---------------------------
 
 tap.test('.fs.fileExistsSync -> should return an accurate boolean', async () => {
-  expect(smartfile.fs.fileExistsSync('./test/mytest.json')).to.be.true;
+  expect(smartfile.fs.fileExistsSync('./test/testassets/mytest.json')).to.be.true;
-  expect(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false;
+  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/mytest.json')).to.be.instanceof(Promise);
+  expect(smartfile.fs.fileExists('./test/testassets/mytest.json')).to.be.instanceof(Promise);
-  await smartfile.fs.fileExists('./test/mytest.json');
+  await smartfile.fs.fileExists('./test/testassets/mytest.json');
-  await smartfile.fs.fileExists('./test/notthere.json').catch(err => {
+  await smartfile.fs.fileExists('./test/testassets/notthere.json').catch(err => {
     return expect(err.message).to.equal(
-      "ENOENT: no such file or directory, access './test/notthere.json'"
+      "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/')).to.include('testfolder');
+  expect(smartfile.fs.listFoldersSync('./test/testassets/')).to.include('testfolder');
-  expect(smartfile.fs.listFoldersSync('./test/')).to.not.include('notExistentFolder');
+  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/');
+  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/')).to.include('mytest.json');
+  expect(smartfile.fs.listFilesSync('./test/testassets/')).to.include('mytest.json');
-  expect(smartfile.fs.listFilesSync('./test/')).to.not.include('notExistentFile');
+  expect(smartfile.fs.listFilesSync('./test/testassets/')).to.not.include('notExistentFile');
-  expect(smartfile.fs.listFilesSync('./test/', /mytest\.json/)).to.include('mytest.json');
+  expect(smartfile.fs.listFilesSync('./test/testassets/', /mytest\.json/)).to.include(
-  expect(smartfile.fs.listFilesSync('./test/', /mytests.json/)).to.not.include('mytest.json');
+    '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/');
+  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/'), '**/*.txt');
+  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/'), '**/*.txt');
+  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 () => {
-  smartfile.fs.copy('./test/testfolder/', './test/temp/');
+  await smartfile.fs.copy('./test/testassets/testfolder/', './test/testassets/temp/');
 });
 
 tap.test('.fs.copy() -> should copy a file', async () => {
-  smartfile.fs.copy('./test/mytest.yaml', './test/temp/');
+  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 () => {
-  smartfile.fs.copy('./test/mytest.yaml', './test/temp/mytestRenamed.yaml');
+  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/temp/mytestRenamed.yaml');
+  await smartfile.fs.remove('./test/testassets/temp/mytestRenamed.yaml');
 });
 
 tap.test('.fs.removeSync -> should remove single files synchronouly', async () => {
-  smartfile.fs.removeSync('./test/temp/testfile1.txt');
+  smartfile.fs.removeSync('./test/testassets/temp/testfile1.txt');
-  expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false;
+  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/temp/testfile1.txt', './test/temp/testfile2.txt']).then(() => {
+  smartfile.fs
-    expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false;
+    .removeMany(['./test/testassets/temp/testfile1.txt', './test/testassets/temp/testfile2.txt'])
-    expect(smartfile.fs.fileExistsSync('./test/temp/testfile2.txt')).to.be.false;
+    .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/temp/testfile1.txt', './test/temp/testfile2.txt']);
+  smartfile.fs.removeManySync([
-  expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false;
+    './test/testassets/temp/testfile1.txt',
-  expect(smartfile.fs.fileExistsSync('./test/temp/testfile2.txt')).to.be.false;
+    './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/mytest.yaml');
+  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/mytest.txt');
+    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/mytest.json');
+  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/mytest.txt')).to.equal('Some TestString &&%$');
+  expect(smartfile.fs.toStringSync('./test/testassets/mytest.txt')).to.equal(
+    'Some TestString &&%$'
+  );
 });
 
 // ---------------------------
@@ -130,7 +150,10 @@ tap.test('.interpreter.filetype() -> should get the file type from a string', as
 
 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/temp/testMemToFs.txt'));
+  await smartfile.memory.toFs(
+    localString,
+    path.join(process.cwd(), './test/testassets/temp/testMemToFs.txt')
+  );
 });
 
 tap.test(
@@ -139,20 +162,19 @@ tap.test(
     let localString = 'myString';
     smartfile.memory.toFsSync(
       localString,
-      path.join(process.cwd(), './test/temp/testMemToFsSync.txt')
+      path.join(process.cwd(), './test/testassets/temp/testMemToFsSync.txt')
     );
   }
 );
 
 tap.test('.remote.toString() -> should load a remote file to a variable', async () => {
-  let responseString = await smartfile.remote.toString(
+  const responseString = await smartfile.remote.toString(
-    'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/mytest.txt'
+    '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 => {
-  tools.returnError;
   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'
@@ -165,7 +187,10 @@ tap.test('.remote.toString() -> should reject a Promise when the link is false',
 // ---------------------------
 
 tap.test('.Smartfile -> should produce vinyl compatible files', async () => {
-  let smartfileArray = await smartfile.fs.fileTreeToObject(process.cwd(), './test/testfolder/**/*');
+  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);
@@ -178,7 +203,7 @@ tap.test('.Smartfile -> should produce vinyl compatible files', async () => {
 });
 
 tap.test('should output a smartfile array to disk', async () => {
-  let smartfileArray = await smartfile.fs.fileTreeToObject('./test/testfolder/', '*');
+  let smartfileArray = await smartfile.fs.fileTreeToObject('./test/testassets/testfolder/', '*');
   for (let smartfile of smartfileArray) {
     console.log(smartfile.relative);
     console.log(smartfile.path);
@@ -187,7 +212,7 @@ tap.test('should output a smartfile array to disk', async () => {
   }
   await smartfile.memory.smartfileArrayToFs(
     smartfileArray,
-    path.resolve('./test/temp/testoutput/')
+    path.resolve('./test/testassets/temp/testoutput/')
   );
 });
 

test/testassets/temp/mytest.yaml

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

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/smartfile.classes.smartfile.ts

@@ -14,6 +14,27 @@ export interface ISmartfileConstructorOptions {
  * -> 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
    */

ts/smartfile.fs.ts

@@ -13,7 +13,7 @@ import * as memory from './smartfile.memory';
  * @param filePath
  * @returns {boolean}
  */
-export let fileExistsSync = function(filePath): boolean {
+export const fileExistsSync = (filePath): boolean => {
   let fileExistsBool: boolean = false;
   try {
     plugins.fsExtra.readFileSync(filePath);
@@ -29,10 +29,10 @@ export let fileExistsSync = function(filePath): boolean {
  * @param filePath
  * @returns {any}
  */
-export let fileExists = function(filePath) {
+export const fileExists = async (filePath): Promise<boolean> => {
-  let done = plugins.smartpromise.defer();
+  const done = plugins.smartpromise.defer<boolean>();
-  plugins.fs.access(filePath, 4, function(err) {
+  plugins.fs.access(filePath, 4, err => {
-    err ? done.reject(err) : done.resolve();
+    err ? done.resolve(false) : done.resolve(true);
   });
   return done.promise;
 };
@@ -40,7 +40,7 @@ export let fileExists = function(filePath) {
 /**
  * Checks if given path points to an existing directory
  */
-export let isDirectory = function(pathArg): boolean {
+export const isDirectory = (pathArg): boolean => {
   try {
     return plugins.fsExtra.statSync(pathArg).isDirectory();
   } catch (err) {
@@ -51,7 +51,7 @@ export let isDirectory = function(pathArg): boolean {
 /**
  * Checks if a given path points to an existing file
  */
-export let isFile = function(pathArg): boolean {
+export const isFile = (pathArg): boolean => {
   return plugins.fsExtra.statSync(pathArg).isFile();
 };
 
@@ -62,10 +62,13 @@ export let isFile = function(pathArg): boolean {
 /**
  * copies a file from A to B on the local disk
  */
-export let copy = function(fromArg: string, toArg: string) {
+export const copy = async (fromArg: string, toArg: string): Promise<boolean> => {
-  let done = plugins.smartpromise.defer();
+  const done = plugins.smartpromise.defer<boolean>();
-  plugins.fsExtra.copy(fromArg, toArg, {}, function() {
+  plugins.fsExtra.copy(fromArg, toArg, {}, err => {
-    done.resolve();
+    if (err) {
+      throw new Error(`Could not copy from ${fromArg} to ${toArg}: ${err}`);
+    }
+    done.resolve(true);
   });
   return done.promise;
 };
@@ -73,7 +76,7 @@ export let copy = function(fromArg: string, toArg: string) {
 /**
  * copies a file SYNCHRONOUSLY from A to B on the local disk
  */
-export let copySync = function(fromArg: string, toArg: string): boolean {
+export const copySync = (fromArg: string, toArg: string): boolean => {
   plugins.fsExtra.copySync(fromArg, toArg);
   return true;
 };
@@ -81,16 +84,14 @@ export let copySync = function(fromArg: string, toArg: string): boolean {
 /**
  * ensures that a directory is in place
  */
-export let ensureDir = (dirPathArg: string) => {
+export const ensureDir = async (dirPathArg: string) => {
-  let done = plugins.smartpromise.defer();
+  await plugins.fsExtra.ensureDir(dirPathArg);
-  plugins.fsExtra.ensureDir(dirPathArg, done.resolve);
-  return done.promise;
 };
 
 /**
  * ensures that a directory is in place
  */
-export let ensureDirSync = (dirPathArg: string) => {
+export const ensureDirSync = (dirPathArg: string) => {
   plugins.fsExtra.ensureDirSync(dirPathArg);
 };
 
@@ -98,19 +99,16 @@ export let ensureDirSync = (dirPathArg: string) => {
  * ensure an empty directory
  * @executes ASYNC
  */
-export let ensureEmptyDir = (dirPathArg: string) => {
+export const ensureEmptyDir = async (dirPathArg: string) => {
-  let done = plugins.smartpromise.defer();
+  await plugins.fsExtra.ensureDir(dirPathArg);
-  plugins.fsExtra.ensureDir(dirPathArg, () => {
+  await plugins.fsExtra.emptyDir(dirPathArg);
-    plugins.fsExtra.emptyDir(dirPathArg, done.resolve);
-  });
-  return done.promise;
 };
 
 /**
  * ensure an empty directory
  * @executes SYNC
  */
-export let ensureEmptyDirSync = (dirPathArg: string) => {
+export const ensureEmptyDirSync = (dirPathArg: string) => {
   plugins.fsExtra.ensureDirSync(dirPathArg);
   plugins.fsExtra.emptyDirSync(dirPathArg);
 };
@@ -122,11 +120,8 @@ export let ensureEmptyDirSync = (dirPathArg: string) => {
  * @returns Promise<void>
  * @exec ASYNC
  */
-export let ensureFile = (filePathArg, initFileStringArg): Promise<void> => {
+export const ensureFile = async (filePathArg, initFileStringArg): Promise<void> => {
-  let done = plugins.smartpromise.defer<void>();
   ensureFileSync(filePathArg, initFileStringArg);
-  done.resolve();
-  return done.promise;
 };
 
 /**
@@ -136,7 +131,7 @@ export let ensureFile = (filePathArg, initFileStringArg): Promise<void> => {
  * @returns Promise<void>
  * @exec SYNC
  */
-export let ensureFileSync = (filePathArg: string, initFileStringArg: string): void => {
+export const ensureFileSync = (filePathArg: string, initFileStringArg: string): void => {
   if (fileExistsSync(filePathArg)) {
     return null;
   } else {
@@ -147,38 +142,33 @@ export let ensureFileSync = (filePathArg: string, initFileStringArg: string): vo
 /**
  * removes a file or folder from local disk
  */
-export let remove = function(pathArg: string): Promise<void> {
+export const remove = async (pathArg: string): Promise<void> => {
-  let done = plugins.smartpromise.defer<void>();
+  await plugins.fsExtra.remove(pathArg);
-  plugins.fsExtra.remove(pathArg, function() {
-    done.resolve();
-  });
-  return done.promise;
 };
 
 /**
  * removes a file SYNCHRONOUSLY from local disk
  */
-export let removeSync = function(pathArg: string): boolean {
+export const removeSync = (pathArg: string): void => {
   plugins.fsExtra.removeSync(pathArg);
-  return true;
 };
 
 /**
  * removes an array of filePaths from disk
  */
-export let removeMany = function(filePathArrayArg: string[]) {
+export const removeMany = async (filePathArrayArg: string[]) => {
-  let promiseArray: Promise<void>[] = [];
+  const promiseArray: Array<Promise<void>> = [];
-  for (let filePath of filePathArrayArg) {
+  for (const filePath of filePathArrayArg) {
     promiseArray.push(remove(filePath));
   }
-  return Promise.all(promiseArray);
+  await Promise.all(promiseArray);
 };
 
 /**
  * like removeFilePathArray but SYNCHRONOUSLY
  */
-export let removeManySync = function(filePathArrayArg: string[]): void {
+export const removeManySync = (filePathArrayArg: string[]): void => {
-  for (let filePath of filePathArrayArg) {
+  for (const filePath of filePathArrayArg) {
     removeSync(filePath);
   }
 };
@@ -193,8 +183,8 @@ export let removeManySync = function(filePathArrayArg: string[]): void {
  * @param fileTypeArg
  * @returns {any}
  */
-export let toObjectSync = function(filePathArg, fileTypeArg?) {
+export const toObjectSync = (filePathArg, fileTypeArg?) => {
-  let fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
+  const fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
   let fileType;
   fileTypeArg ? (fileType = fileTypeArg) : (fileType = SmartfileInterpreter.filetype(filePathArg));
   return SmartfileInterpreter.objectFile(fileString, fileType);
@@ -205,12 +195,27 @@ export let toObjectSync = function(filePathArg, fileTypeArg?) {
  * @param filePath
  * @returns {string|Buffer|any}
  */
-export let toStringSync = function(filePath: string): string {
+export const toStringSync = (filePath: string): string => {
-  let fileString: any = plugins.fsExtra.readFileSync(filePath, 'utf8');
+  const fileString: string = plugins.fsExtra.readFileSync(filePath, 'utf8');
   return fileString;
 };
 
-export let fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string) => {
+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)) {
@@ -219,22 +224,22 @@ export let fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string
     dirPath = dirPathArg;
   }
 
-  let fileTree = await listFileTree(dirPath, miniMatchFilter);
+  const fileTree = await listFileTree(dirPath, miniMatchFilter);
-  let smartfileArray: Smartfile[] = [];
+  const smartfileArray: Smartfile[] = [];
-  for (let filePath of fileTree) {
+  for (const filePath of fileTree) {
-    let readPath = ((): string => {
+    const readPath = ((): string => {
       if (!plugins.path.isAbsolute(filePath)) {
         return plugins.path.join(dirPath, filePath);
       } else {
         return filePath;
       }
     })();
-    let fileContentString = toStringSync(readPath);
+    const fileContentString = toStringSync(readPath);
 
     // push a read file as Smartfile
     smartfileArray.push(
       new Smartfile({
-        contentBuffer: new Buffer(fileContentString),
+        contentBuffer: Buffer.from(fileContentString),
         base: dirPath,
         path: filePath
       })
@@ -243,40 +248,20 @@ export let fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string
   return smartfileArray;
 };
 
-/**
- *
- * @param filePathArg
- * @param options
- * @returns {number}
- */
-export let toVinylSync = function(filePathArg, options = {}) {
-  return plugins.vinylFile.readSync(filePathArg, options);
-};
-
 /**
  * lists Folders in a directory on local disk
- * @returns Promise
+ * @returns Promise with an array that contains the folder names
  */
-export let listFolders = function(pathArg: string, regexFilter?: RegExp) {
+export const listFolders = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
-  let done = plugins.smartpromise.defer();
+  return listFoldersSync(pathArg, regexFilter);
-  let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
-    return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory();
-  });
-  if (regexFilter) {
-    folderArray = folderArray.filter(fileItem => {
-      return regexFilter.test(fileItem);
-    });
-  }
-  done.resolve(folderArray);
-  return done.promise;
 };
 
 /**
  * lists Folders SYNCHRONOUSLY in a directory on local disk
  * @returns an array with the folder names as strings
  */
-export let listFoldersSync = function(pathArg: string, regexFilter?: RegExp): string[] {
+export const listFoldersSync = (pathArg: string, regexFilter?: RegExp): string[] => {
-  let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
+  let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(file => {
     return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory();
   });
   if (regexFilter) {
@@ -291,26 +276,16 @@ export let listFoldersSync = function(pathArg: string, regexFilter?: RegExp): st
  * lists Files in a directory on local disk
  * @returns Promise
  */
-export let listFiles = function(pathArg: string, regexFilter?: RegExp) {
+export const listFiles = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
-  let done = plugins.smartpromise.defer();
+  return listFilesSync(pathArg, regexFilter);
-  let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
-    return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
-  });
-  if (regexFilter) {
-    fileArray = fileArray.filter(fileItem => {
-      return regexFilter.test(fileItem);
-    });
-  }
-  done.resolve(fileArray);
-  return done.promise;
 };
 
 /**
  * lists Files SYNCHRONOUSLY in a directory on local disk
  * @returns an array with the folder names as strings
  */
-export let listFilesSync = function(pathArg: string, regexFilter?: RegExp): string[] {
+export const listFilesSync = (pathArg: string, regexFilter?: RegExp): string[] => {
-  let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
+  let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(file => {
     return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
   });
   if (regexFilter) {
@@ -325,16 +300,8 @@ export let listFilesSync = function(pathArg: string, regexFilter?: RegExp): stri
  * lists all items (folders AND files) in a directory on local disk
  * @returns Promise<string[]>
  */
-export let listAllItems = function(pathArg: string, regexFilter?: RegExp): Promise<string[]> {
+export const listAllItems = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
-  let done = plugins.smartpromise.defer<string[]>();
+  return listAllItemsSync(pathArg, regexFilter);
-  let allItmesArray = plugins.fsExtra.readdirSync(pathArg);
-  if (regexFilter) {
-    allItmesArray = allItmesArray.filter(fileItem => {
-      return regexFilter.test(fileItem);
-    });
-  }
-  done.resolve(allItmesArray);
-  return done.promise;
 };
 
 /**
@@ -342,8 +309,8 @@ export let listAllItems = function(pathArg: string, regexFilter?: RegExp): Promi
  * @returns an array with the folder names as strings
  * @executes SYNC
  */
-export let listAllItemsSync = function(pathArg: string, regexFilter?: RegExp): string[] {
+export const listAllItemsSync = (pathArg: string, regexFilter?: RegExp): string[] => {
-  let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
+  let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter(file => {
     return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
   });
   if (regexFilter) {
@@ -359,8 +326,12 @@ export let listAllItemsSync = function(pathArg: string, regexFilter?: RegExp): s
  * 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 let listFileTree = (dirPathArg: string, miniMatchFilter: string): Promise<string[]> => {
+export const listFileTree = async (
-  let done = plugins.smartpromise.defer<string[]>();
+  dirPathArg: string,
+  miniMatchFilter: string,
+  absolutePathsBool: boolean = false
+): Promise<string[]> => {
+  const done = plugins.smartpromise.defer<string[]>();
 
   // handle absolute miniMatchFilter
   let dirPath: string;
@@ -370,7 +341,7 @@ export let listFileTree = (dirPathArg: string, miniMatchFilter: string): Promise
     dirPath = dirPathArg;
   }
 
-  let options = {
+  const options = {
     cwd: dirPath,
     nodir: true,
     dot: true
@@ -382,5 +353,13 @@ export let listFileTree = (dirPathArg: string, miniMatchFilter: string): Promise
     }
     done.resolve(files);
   });
-  return done.promise;
+
+  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

@@ -1,8 +1,8 @@
 import plugins = require('./smartfile.plugins');
 
 export let filetype = (pathArg: string): string => {
-  let extName = plugins.path.extname(pathArg);
+  const extName = plugins.path.extname(pathArg);
-  let fileType = extName.replace(/\.([a-z]*)/, '$1'); // remove . form fileType
+  const fileType = extName.replace(/\.([a-z]*)/, '$1'); // remove . form fileType
   return fileType;
 };
 

ts/smartfile.plugins.ts

@@ -1,9 +1,20 @@
-export import fs = require('fs');
+// node native scope
-export import fsExtra = require('fs-extra');
+import * as fs from 'fs';
-export let glob = require('glob');
+import * as path from 'path';
-export import path = require('path');
+
-export import smartpromise = require('@pushrocks/smartpromise');
+export { fs, path };
-export import smartrequest = require('@pushrocks/smartrequest');
+
-export import smartpath = require('smartpath');
+// @pushrocks scope
-export let vinylFile = require('vinyl-file');
+import * as smarthash from '@pushrocks/smarthash';
-export let yaml = require('js-yaml');
+import * as smartpath from '@pushrocks/smartpath';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrequest from '@pushrocks/smartrequest';
+
+export { smarthash, 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 };

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"
 }