7.0.0

update to latest standards

See merge request !2

.gitignore

@@ -1,6 +1,7 @@
 node_modules/
-.settings/
-.idea/
+coverage/
+pages/
+public/
+
+test/temp/
 
-ts/*.js
-ts/*.js.map

.gitlab-ci.yml

@@ -0,0 +1,137 @@
+# gitzone standard
+image: 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:
+  - docker
+  - notpriv
+
+snyk:
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# test stage
+# ====================
+testLEGACY:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install legacy
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
+  - notpriv
+  allow_failure: true
+
+testLTS:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
+  - notpriv
+    
+testSTABLE:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
+  - notpriv
+
+release:
+  stage: release
+  script:
+  - npmci node install stable
+  - npmci npm publish
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  image: docker:stable
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
+  artifacts:
+    paths: [codeclimate.json]
+  tags:
+  - docker
+  - priv
+
+trigger:
+  stage: metadata
+  script:
+  - npmci trigger
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+pages:
+  image: hosttoday/ht-docker-node:npmci
+  stage: metadata
+  script:
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+  tags:
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public
+  allow_failure: true

.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=

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,39 +1,43 @@
-# gulp-bootstrap
-works with gulp, but does nothing. Use it to bootstrap your own gulp plugin with TypeScript, Travis and npm.
+# @pushrocks/smartfile
 
-### Buildstatus/Dependencies
-[![Build Status](https://travis-ci.org/pushrocks/gulp-bootstrap.svg?branch=master)](https://travis-ci.org/pushrocks/gulp-bootstrap)
-[![devDependency Status](https://david-dm.org/pushrocks/gulp-bootstrap/dev-status.svg)](https://david-dm.org/pushrocks/gulp-bootstrap#info=devDependencies)
+make files easily accessible for processing in javascript.
 
-### Usage
-This npm package comes with everything you need to start your own gulp plugin.
+## Availabililty
 
-Features:
+[![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/)
 
-* TypeScript: Code your plugin in TypeScript
-* Use gulp to compile TypeScript without the global gulp CLI Tool.
-* Use travis to deploy to npm
-* Have a master branch for the latest dev version
-* Have a release branch for the latest npm version
+## Status for master
 
-This package **doesn't require global gulp** (just local -> simply do npm install`) to compile TypeScript.
+[![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/)
 
-* to compile TypeScript do `npm test` (You should chain your own tests to this command later on)
-* to setup release do `npm run setup`
-* to release a patch do `npm run release`
+## Usage
 
-We recommend using travis for npm releasing and test integration.
+smartfile is an approach of being one tool to handle files in diverse environments.
 
-#### The structure
+### Smartfile Sections
 
-```
-gulp-bootstrap/
-|
-|- ts/
-|  |- compile/
-|  |  |- compile.js **** contains gulp task`
-|  |- index.ts **** Your main TypeScript file.
-|  
-|- index.js **** the compiled module
-```
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,14 @@
+"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

@@ -0,0 +1,79 @@
+/// <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

@@ -0,0 +1,118 @@
+"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

@@ -0,0 +1,143 @@
+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

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

dist/smartfile.interpreter.js

@@ -0,0 +1,21 @@
+"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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,87 @@
+"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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,13 @@
+"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

@@ -0,0 +1,12 @@
+/**
+ *
+ * @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

@@ -0,0 +1,51 @@
+"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

@@ -0,0 +1,43 @@
+# 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)

index.js

@@ -1,13 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var path = require("path");
-var pr = require("pushrocks");
-var fs = require("fs");
-var smartfile = {
-    //read File to  string
-    readFileToString: function (filePath) {
-        var fileString;
-        fileString = fs.readFileSync(filePath, "utf8");
-        return fileString;
-    }
-};
-module.exports = smartfile;

npmextra.json

@@ -0,0 +1,13 @@
+{
+  "npmts":{
+    "mode":"default",
+    "coverageTreshold":70
+  },
+  "npmdocker":{
+    
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}

package.json

@@ -1,17 +1,21 @@
 {
-  "name": "smartfile",
-  "version": "0.0.5",
+  "name": "@pushrocks/smartfile",
+  "private": false,
+  "version": "7.0.0",
   "description": "offers smart ways to work with files in nodejs",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(cd ts/compile && node compile.js) && (node test.js)",
+    "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)",
-    "startdev": "(git checkout master && git pull origin master)"
+    "update": "(git checkout master && git pull origin master && 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",
@@ -20,14 +24,28 @@
   "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": {
-    "pushrocks": "^1.0.18"
+    "@pushrocks/smartpath": "^4.0.1",
+    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartrequest": "^1.1.14",
+    "@types/fs-extra": "^5.0.5",
+    "@types/vinyl": "^2.0.2",
+    "fs-extra": "^7.0.1",
+    "glob": "^7.1.3",
+    "js-yaml": "^3.12.1",
+    "vinyl-file": "^3.0.0"
   },
   "devDependencies": {
-    "gulp": "3.9.0",
-    "gulp-typescript": "2.9.2"
+    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tstest": "^1.0.18",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^11.9.4",
+    "gulp-function": "^2.2.14",
+    "tslint": "^5.12.1",
+    "tslint-config-prettier": "^1.18.0"
   }
 }

test.js

@@ -1,4 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartfile = require("./index.js");
-var pr = require("pushrocks");
-pr.beautylog.info(smartfile.readFileToString("./test/mytest.txt"));

test/mytest.json

@@ -0,0 +1,8 @@
+{
+  "key1": "this works",
+  "key2": "this works too",
+  "key3": {
+    "nestedkey1": "hello"
+  }
+}
+

test/mytest.txt

@@ -1 +1 @@
-This is some test text stored in ./test/mytest.txt -> If this is displayed when running "npm test", then the test has succeeded.
+Some TestString &&%$

test/mytest.yaml

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

test/test.ts

@@ -0,0 +1,194 @@
+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/mytest.json')).to.be.true;
+  expect(smartfile.fs.fileExistsSync('./test/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);
+  await smartfile.fs.fileExists('./test/mytest.json');
+  await smartfile.fs.fileExists('./test/notthere.json').catch(err => {
+    return expect(err.message).to.equal(
+      "ENOENT: no such file or directory, access './test/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/')).to.not.include('notExistentFolder');
+});
+
+tap.test('.fs.listFolders() -> should get the file type from a string', async () => {
+  let folderArrayArg = await smartfile.fs.listFolders('./test/');
+  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/')).to.not.include('notExistentFile');
+  expect(smartfile.fs.listFilesSync('./test/', /mytest\.json/)).to.include('mytest.json');
+  expect(smartfile.fs.listFilesSync('./test/', /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/');
+  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');
+  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');
+  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/');
+});
+
+tap.test('.fs.copy() -> should copy a file', async () => {
+  smartfile.fs.copy('./test/mytest.yaml', './test/temp/');
+});
+
+tap.test('.fs.copy() -> should copy a file and rename it', async () => {
+  smartfile.fs.copy('./test/mytest.yaml', './test/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');
+});
+
+tap.test('.fs.removeSync -> should remove single files synchronouly', async () => {
+  smartfile.fs.removeSync('./test/temp/testfile1.txt');
+  expect(smartfile.fs.fileExistsSync('./test/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(() => {
+    expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false;
+    expect(smartfile.fs.fileExistsSync('./test/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']);
+  expect(smartfile.fs.fileExistsSync('./test/temp/testfile1.txt')).to.be.false;
+  expect(smartfile.fs.fileExistsSync('./test/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');
+  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');
+  }
+);
+
+tap.test('.fs.toObjectSync() -> should read an ' + '.json' + ' file to an object', async () => {
+  let testData = smartfile.fs.toObjectSync('./test/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 &&%$');
+});
+
+// ---------------------------
+// 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/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/temp/testMemToFsSync.txt')
+    );
+  }
+);
+
+tap.test('.remote.toString() -> should load a remote file to a variable', async () => {
+  let responseString = await smartfile.remote.toString(
+    'https://raw.githubusercontent.com/pushrocks/smartfile/master/test/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'
+    );
+  });
+});
+
+// ---------------------------
+// smartfile.Smartfile
+// ---------------------------
+
+tap.test('.Smartfile -> should produce vinyl compatible files', async () => {
+  let smartfileArray = await smartfile.fs.fileTreeToObject(process.cwd(), './test/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/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/temp/testoutput/')
+  );
+});
+
+tap.start();

test/testfolder/subfolder/deepsubfolder/deepsubtestfile.txt

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

test/testfolder/subfolder/subtestfile.txt

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

ts/compile/compile.js

@@ -1,30 +0,0 @@
-// import gulp
-var gulp = require("gulp")
-var gulpTypescript = require("gulp-typescript");
-var pr = require("pushrocks");
-
-gulp.task('compileTS', function() {
-	var stream = gulp.src('../index.ts')
-	  .pipe(gulpTypescript({
-	  	out: "index.js"
-	  }))
-	  .pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('compileTestTS', function() {
-	var stream = gulp.src('../test.ts')
-			.pipe(gulpTypescript({
-				out: "test.js"
-			}))
-			.pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('default',['compileTS','compileTestTS'], function() {
-	pr.beautylog.success('Typescript compiled');
-});
-
-//lets tell gulp to start with the default task.
-pr.beautylog.log('Starting Gulp to compile TypeScript');
-gulp.start.apply(gulp, ['default']);

ts/compile/readme.md

@@ -1,2 +0,0 @@
-# How to compile.
-Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.

ts/index.ts

@@ -1,16 +1,12 @@
-/// <reference path="typings/tsd.d.ts" />
-var path = require("path");
-var pr = require("pushrocks");
-var fs = require("fs");
+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';
 
-var smartfile:any = {
-    //read File to  string
-    readFileToString: (filePath) => {
-        var fileString;
-        fileString = fs.readFileSync(filePath, "utf8");
-        return fileString;
-    }
-};
+export { Smartfile } from './smartfile.classes.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,170 @@
+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,358 @@
+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 let fileExistsSync = function(filePath): boolean {
+  let fileExistsBool: boolean = false;
+  try {
+    plugins.fsExtra.readFileSync(filePath);
+    fileExistsBool = true;
+  } catch (err) {
+    fileExistsBool = false;
+  }
+  return fileExistsBool;
+};
+
+/**
+ *
+ * @param filePath
+ * @returns {any}
+ */
+export let fileExists = (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 let 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 let isFile = function(pathArg): boolean {
+  return plugins.fsExtra.statSync(pathArg).isFile();
+};
+
+/*===============================================================
+============================ FS ACTIONS =========================
+===============================================================*/
+
+/**
+ * copies a file from A to B on the local disk
+ */
+export let copy = function(fromArg: string, toArg: string) {
+  let done = plugins.smartpromise.defer();
+  plugins.fsExtra.copy(fromArg, toArg, {}, function() {
+    done.resolve();
+  });
+  return done.promise;
+};
+
+/**
+ * copies a file SYNCHRONOUSLY from A to B on the local disk
+ */
+export let copySync = function(fromArg: string, toArg: string): boolean {
+  plugins.fsExtra.copySync(fromArg, toArg);
+  return true;
+};
+
+/**
+ * ensures that a directory is in place
+ */
+export let ensureDir = (dirPathArg: string) => {
+  let done = plugins.smartpromise.defer();
+  plugins.fsExtra.ensureDir(dirPathArg, done.resolve);
+  return done.promise;
+};
+
+/**
+ * ensures that a directory is in place
+ */
+export let ensureDirSync = (dirPathArg: string) => {
+  plugins.fsExtra.ensureDirSync(dirPathArg);
+};
+
+/**
+ * ensure an empty directory
+ * @executes ASYNC
+ */
+export let ensureEmptyDir = (dirPathArg: string) => {
+  let done = plugins.smartpromise.defer();
+  plugins.fsExtra.ensureDir(dirPathArg, () => {
+    plugins.fsExtra.emptyDir(dirPathArg, done.resolve);
+  });
+  return done.promise;
+};
+
+/**
+ * ensure an empty directory
+ * @executes SYNC
+ */
+export let 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 let ensureFile = (filePathArg, initFileStringArg): Promise<void> => {
+  let done = plugins.smartpromise.defer<void>();
+  ensureFileSync(filePathArg, initFileStringArg);
+  done.resolve();
+  return done.promise;
+};
+
+/**
+ * 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 let 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 let remove = function(pathArg: string): Promise<void> {
+  let done = plugins.smartpromise.defer<void>();
+  plugins.fsExtra.remove(pathArg, function() {
+    done.resolve();
+  });
+  return done.promise;
+};
+
+/**
+ * removes a file SYNCHRONOUSLY from local disk
+ */
+export let removeSync = function(pathArg: string): boolean {
+  plugins.fsExtra.removeSync(pathArg);
+  return true;
+};
+
+/**
+ * removes an array of filePaths from disk
+ */
+export let removeMany = function(filePathArrayArg: string[]) {
+  let promiseArray: Promise<void>[] = [];
+  for (let filePath of filePathArrayArg) {
+    promiseArray.push(remove(filePath));
+  }
+  return Promise.all(promiseArray);
+};
+
+/**
+ * like removeFilePathArray but SYNCHRONOUSLY
+ */
+export let removeManySync = function(filePathArrayArg: string[]): void {
+  for (let filePath of filePathArrayArg) {
+    removeSync(filePath);
+  }
+};
+
+/*===============================================================
+============================ Write/Read =========================
+===============================================================*/
+
+/**
+ *
+ * @param filePathArg
+ * @param fileTypeArg
+ * @returns {any}
+ */
+export let toObjectSync = function(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
+ * @param filePath
+ * @returns {string|Buffer|any}
+ */
+export let toStringSync = function(filePath: string): string {
+  const fileString: string = plugins.fsExtra.readFileSync(filePath, 'utf8');
+  return fileString;
+};
+
+export let fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string) => {
+  // handle absolute miniMatchFilter
+  let dirPath: string;
+  if (plugins.path.isAbsolute(miniMatchFilter)) {
+    dirPath = '/';
+  } else {
+    dirPath = dirPathArg;
+  }
+
+  let fileTree = await listFileTree(dirPath, miniMatchFilter);
+  let smartfileArray: Smartfile[] = [];
+  for (let filePath of fileTree) {
+    let readPath = ((): string => {
+      if (!plugins.path.isAbsolute(filePath)) {
+        return plugins.path.join(dirPath, filePath);
+      } else {
+        return filePath;
+      }
+    })();
+    let fileContentString = toStringSync(readPath);
+
+    // push a read file as Smartfile
+    smartfileArray.push(
+      new Smartfile({
+        contentBuffer: new Buffer(fileContentString),
+        base: dirPath,
+        path: filePath
+      })
+    );
+  }
+  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 with an array that contains the folder names
+ */
+export let 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 let 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 let 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 let 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 let 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 let listAllItemsSync = (pathArg: string, regexFilter?: RegExp): string[] => {
+  let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter(function(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 let listFileTree = (dirPathArg: string, miniMatchFilter: string): 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);
+  });
+  return done.promise;
+};

ts/smartfile.interpreter.ts

@@ -0,0 +1,20 @@
+import plugins = require('./smartfile.plugins');
+
+export let filetype = (pathArg: string): string => {
+  let extName = plugins.path.extname(pathArg);
+  let 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,91 @@
+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 | Smartfile,
+  filePathArg,
+  optionsArg: IToFsOptions = {}
+) => {
+  let done = plugins.smartpromise.defer();
+
+  // check args
+  if (!fileContentArg || !filePathArg) {
+    throw new Error('expected valid arguments');
+  }
+
+  // prepare actual write action
+  let fileString: string;
+  let filePath: string = filePathArg;
+
+  // handle Smartfile
+  if (fileContentArg instanceof Smartfile) {
+    let fileContentArg2: any = 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');
+  }
+  await smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
+  plugins.fsExtra.writeFile(filePath, fileString, { encoding: 'utf8' }, 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

@@ -0,0 +1,9 @@
+export import fs = require('fs');
+export import fsExtra = require('fs-extra');
+export let glob = require('glob');
+export import path = require('path');
+export import smartpromise = require('@pushrocks/smartpromise');
+export import smartrequest = require('@pushrocks/smartrequest');
+export import smartpath = require('@pushrocks/smartpath');
+export let vinylFile = require('vinyl-file');
+export let yaml = require('js-yaml');

ts/smartfile.remote.ts

@@ -0,0 +1,50 @@
+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 = function(fromArg: string) {
+  let 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) => {
+  let done = plugins.smartpromise.defer();
+  plugins.smartrequest.getBinary(fromArg).then((res: any) => {
+    if (res.statusCode === 200) {
+      done.resolve(res.body);
+    } else {
+      done.reject(new Error('could not get remote file from ' + fromArg));
+    }
+  });
+  return done.promise;
+};

ts/test.ts

@@ -1,4 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartfile = require("./index.js");
-var pr = require("pushrocks")
-pr.beautylog.info(smartfile.readFileToString("./test/mytest.txt"));

ts/tsd.json

@@ -1,12 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
-    }
-  }
-}

ts/typings/tsd.d.ts

@@ -1 +0,0 @@
-/// <reference path="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"
+}