4.2.13

dist/smartfile.classes.smartfile.d.ts

@@ -1,8 +1,10 @@
 /// <reference types="node" />
+import * as plugins from './smartfile.plugins';
 export interface ISmartfileConstructorOptions {
     path?: string;
-    contentsString?: string;
+    contentString?: string;
     contentBuffer?: Buffer;
+    base?: string;
 }
 /**
  * class Smartfile
@@ -14,13 +16,18 @@ export declare class Smartfile {
      */
     path: string;
     /**
-     * The contents of the file as Buffer
+     *
      */
-    contents: Buffer;
+    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
      */
-    cwd: string;
+    base: string;
     /**
      * sync the file with disk
      */
@@ -30,11 +37,6 @@ export declare class Smartfile {
      * @param optionsArg
      */
     constructor(optionsArg: ISmartfileConstructorOptions);
-    /**
-     * return relative path of file
-     * ->
-     */
-    readonly relative: string;
     /**
      * set contents from string
      * @param contentString
@@ -48,4 +50,27 @@ export declare class Smartfile {
      * 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;
 }

dist/smartfile.classes.smartfile.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const plugins = require("./smartfile.plugins");
 /**
  * class Smartfile
  * -> is vinyl file compatible
@@ -19,19 +20,17 @@ class Smartfile {
      */
     constructor(optionsArg) {
         if (optionsArg.contentBuffer) {
-            this.contents = optionsArg.contentBuffer;
+            this.contentBuffer = optionsArg.contentBuffer;
         }
-        else if (optionsArg.contentsString) {
-            this.contents = new Buffer(optionsArg.contentsString);
+        else if (optionsArg.contentString) {
+            this.setContentsFromString(optionsArg.contentString);
+        }
+        else {
+            console.log('created empty Smartfile?');
         }
         this.path = optionsArg.path;
-    }
-    /**
-     * return relative path of file
-     * ->
-     */
-    get relative() {
-        return '';
+        this.parsedPath = plugins.path.parse(this.path);
+        this.base = optionsArg.base;
     }
     /**
      * set contents from string
@@ -54,6 +53,57 @@ class Smartfile {
         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;
+    }
 }
 exports.Smartfile = Smartfile;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFRQTs7O0dBR0c7QUFDSDtJQXFCRTs7O09BR0c7SUFDSCxZQUFhLFVBQXdDO1FBQ25ELEVBQUUsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDO1lBQzdCLElBQUksQ0FBQyxRQUFRLEdBQUcsVUFBVSxDQUFDLGFBQWEsQ0FBQTtRQUMxQyxDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDO1lBQ3JDLElBQUksQ0FBQyxRQUFRLEdBQUcsSUFBSSxNQUFNLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFBO1FBQ3ZELENBQUM7UUFDRCxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUE7SUFDN0IsQ0FBQztJQUVEOzs7T0FHRztJQUNILElBQUksUUFBUTtRQUNWLE1BQU0sQ0FBQyxFQUFFLENBQUE7SUFDWCxDQUFDO0lBR0Q7OztPQUdHO0lBQ0gscUJBQXFCLENBQUMsYUFBcUI7UUFDekMsSUFBSSxDQUFDLFFBQVEsR0FBRyxJQUFJLE1BQU0sQ0FBQyxhQUFhLENBQUMsQ0FBQTtJQUMzQyxDQUFDO0lBRUQ7O09BRUc7SUFDRyxLQUFLOztRQUVYLENBQUM7S0FBQTtJQUVEOztPQUVHO0lBQ0csSUFBSTs7UUFDVixDQUFDO0tBQUE7Q0FDRjtBQS9ERCw4QkErREMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFBQSwrQ0FBOEM7QUFTOUM7OztHQUdHO0FBQ0g7SUEyQkU7OztPQUdHO0lBR0gsWUFBYSxVQUF3QztRQUNuRCxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztZQUM3QixJQUFJLENBQUMsYUFBYSxHQUFHLFVBQVUsQ0FBQyxhQUFhLENBQUE7UUFDL0MsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztZQUNwQyxJQUFJLENBQUMscUJBQXFCLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxDQUFBO1FBQ3RELENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLE9BQU8sQ0FBQyxHQUFHLENBQUMsMEJBQTBCLENBQUMsQ0FBQTtRQUN6QyxDQUFDO1FBQ0QsSUFBSSxDQUFDLElBQUksR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFBO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO1FBQy9DLElBQUksQ0FBQyxJQUFJLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQTtJQUM3QixDQUFDO0lBR0Q7OztPQUdHO0lBQ0gscUJBQXFCLENBQUMsYUFBcUI7UUFDekMsSUFBSSxDQUFDLFFBQVEsR0FBRyxJQUFJLE1BQU0sQ0FBQyxhQUFhLENBQUMsQ0FBQTtJQUMzQyxDQUFDO0lBRUQ7O09BRUc7SUFDRyxLQUFLOztRQUVYLENBQUM7S0FBQTtJQUVEOztPQUVHO0lBQ0csSUFBSTs7UUFDVixDQUFDO0tBQUE7SUFFRCxrREFBa0Q7SUFDbEQsc0JBQXNCO0lBQ3RCLGtEQUFrRDtJQUNsRDs7T0FFRztJQUNILElBQUksUUFBUTtRQUNWLE1BQU0sQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFBO0lBQzNCLENBQUM7SUFDRCxJQUFJLFFBQVEsQ0FBRSxXQUFXO1FBQ3ZCLElBQUksQ0FBQyxhQUFhLEdBQUcsV0FBVyxDQUFBO0lBQ2xDLENBQUM7SUFFRDs7T0FFRztJQUNILElBQUksR0FBRztRQUNMLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7SUFDdEIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsSUFBSSxRQUFRO1FBQ1YsTUFBTSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO0lBQ3BELENBQUM7SUFFRDs7T0FFRztJQUNILE1BQU07UUFDSixFQUFFLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDO1lBQ3hCLE1BQU0sQ0FBQyxJQUFJLENBQUE7UUFDYixDQUFDO1FBQ0QsTUFBTSxDQUFDLEtBQUssQ0FBQTtJQUNkLENBQUM7SUFFRDs7T0FFRztJQUNILFFBQVE7UUFDTixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUSxZQUFZLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDcEMsTUFBTSxDQUFDLElBQUksQ0FBQTtRQUNiLENBQUM7UUFDRCxNQUFNLENBQUMsS0FBSyxDQUFBO0lBQ2QsQ0FBQztJQUVELFdBQVc7UUFDVCxNQUFNLENBQUMsS0FBSyxDQUFBO0lBQ2QsQ0FBQztJQUVELFFBQVE7UUFDTixNQUFNLENBQUMsS0FBSyxDQUFBO0lBQ2QsQ0FBQztJQUVELFVBQVU7UUFDUixNQUFNLENBQUMsS0FBSyxDQUFBO0lBQ2QsQ0FBQztDQUNGO0FBOUhELDhCQThIQyJ9

dist/smartfile.memory.d.ts

@@ -1,18 +1,5 @@
-/// <reference types="node" />
 import 'typings-global';
-export interface IVinylFile {
-    contents: Buffer;
-    base: string;
-    path: string;
-}
-/**
- * allows you to create a gulp stream
- * from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
- * @param fileArg
- * @returns stream.Readable
- * @TODO: make it async;
- */
-export declare let toGulpStream: (fileArg: string | string[] | IVinylFile | IVinylFile[], baseArg?: string) => any;
+import { Smartfile } from './smartfile.classes.smartfile';
 /**
  * converts file to Object
  * @param fileStringArg
@@ -20,35 +7,20 @@ export declare let toGulpStream: (fileArg: string | string[] | IVinylFile | IVin
  * @returns {any|any}
  */
 export declare let toObject: (fileStringArg: string, fileTypeArg: string) => any;
-/**
- * takes a string and converts it to vinyl file
- * @param fileArg
- * @param optionsArg
- */
-export declare let toVinylFileSync: (fileArg: string, optionsArg?: {
-    filename?: string;
-    base?: string;
-    relPath?: string;
-}) => any;
-/**
- * takes a string array and some options and returns a vinylfile array
- * @param arrayArg
- * @param optionsArg
- */
-export declare let toVinylArraySync: (arrayArg: string[], optionsArg?: {
-    filename?: string;
-    base?: string;
-    relPath?: string;
-}) => any[];
-/**
- * takes a vinylFile object and converts it to String
- */
-export declare let vinylToStringSync: (fileArg: IVinylFile) => string;
+export interface IToFsOptions {
+    respectRelative?: boolean;
+}
 /**
  * writes string or vinyl file to disk.
  * @param fileArg
  * @param fileNameArg
  * @param fileBaseArg
  */
-export declare let toFs: (fileContentArg: string | IVinylFile, filePathArg: any) => Promise<{}>;
-export declare let toFsSync: (fileArg: any, filePathArg: string) => void;
+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>;

docs/index.md

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartfile",
-  "version": "4.1.10",
+  "version": "4.2.13",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -26,9 +26,9 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartfile",
   "dependencies": {
-    "@types/fs-extra": "2.x.x",
+    "@types/fs-extra": "3.x.x",
     "@types/vinyl": "^2.0.0",
-    "fs-extra": "^3.0.0",
+    "fs-extra": "^3.0.1",
     "glob": "^7.1.1",
     "js-yaml": "^3.8.3",
     "require-reload": "0.2.2",
@@ -40,7 +40,7 @@
     "vinyl-file": "^3.0.0"
   },
   "devDependencies": {
-    "gulp-function": "^2.2.3",
-    "tapbundle": "^1.0.10"
+    "gulp-function": "^2.2.9",
+    "tapbundle": "^1.0.12"
   }
 }

test/test.ts

@@ -3,7 +3,9 @@ import path = require('path')
 
 import { expect, tap } from 'tapbundle'
 
-import * as vinyl from 'vinyl'
+// ---------------------------
+// smartfile.fs
+// ---------------------------
 
 tap.test('.fs.fileExistsSync -> should return an accurate boolean', async () => {
   expect(smartfile.fs.fileExistsSync('./test/mytest.json')).to.be.true
@@ -47,9 +49,10 @@ tap.test('.fs.listFileTree() -> should get a file tree', async () => {
   expect(folderArrayArg).to.not.deep.include('mytest.json')
 })
 
-tap.test('.fstoObjectFromFileTree -> should read a file tree into an Object', async () => {
+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[1]).to.be.instanceof(smartfile.Smartfile)
+  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 () => {
@@ -68,36 +71,28 @@ tap.test('.fs.remove() -> should remove an entire directory', async () => {
 
 })
 
-tap.test('smartfile.fs.remove -> should remove single files', async () => {
+tap.test('.fs.remove -> should remove single files', async () => {
   await expect(smartfile.fs.remove('./test/temp/mytestRenamed.yaml')).to.eventually.be.fulfilled
 })
 
-tap.test('smartfile.fs.removeSync -> should remove single files synchronouly', async () => {
+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('smartfile.fs.removeMany -> should remove and array of files', async () => {
+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('smartfile.fs.removeManySync -> should remove and array of single files synchronouly', async () => {
+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
 })
 
-// ---------------------------
-// .interpreter
-// ---------------------------
-
-tap.test('.interpreter.filetype() -> should get the file type from a string', async () => {
-  expect(smartfile.interpreter.filetype('./somefolder/data.json')).equal('json')
-})
-
 tap.test('.fs.toObjectSync() -> should read an ' + '.yaml' + ' file to an object', async () => {
   let testData = smartfile.fs.toObjectSync('./test/mytest.yaml')
   expect(testData).have.property('key1', 'this works')
@@ -120,45 +115,21 @@ tap.test('.fs.toStringSync() -> should read a file to a string', async () => {
     .to.equal('Some TestString &&%$')
 })
 
-tap.test('.fs.toVinylSync -> should read an ' + '.json OR .yaml' + ' file to an ' + 'vinyl file object', async () => {
-  let testData = smartfile.fs.toVinylSync('./test/mytest.json')
-  expect(vinyl.isVinyl(testData)).to.be.true
+// ---------------------------
+// smartfile.interpreter
+// ---------------------------
+
+tap.test('.interpreter.filetype() -> should get the file type from a string', async () => {
+  expect(smartfile.interpreter.filetype('./somefolder/data.json')).equal('json')
 })
 
-tap.test('.memory.toGulpStream() -> should produce a valid gulp stream', async () => {
-  let localArray = [ 'test1', 'test2', 'test3' ]
-  smartfile.memory.toGulpStream(localArray)
-})
-
-tap.test('.memory.toVinylFileSync() -> should produce a vinylFile', async () => {
-  let localString = 'myString'
-  let localOptions = { filename: 'vinylfile2', base: '/someDir' }
-  expect(smartfile.memory.toVinylFileSync(localString, localOptions) instanceof vinyl).to.be.true
-})
-
-tap.test('.memory.toVinylArraySync() -> should produce a an array of vinylfiles', async () => {
-  let localStringArray = [ 'string1', 'string2', 'string3' ]
-  let localOptions = { filename: 'vinylfile2', base: '/someDir' }
-  let testResult = smartfile.memory.toVinylArraySync(localStringArray, localOptions)
-  expect(testResult).to.be.a('array')
-  expect(testResult.length === 3).to.be.true
-  for (let myKey in testResult) {
-    expect(testResult[ myKey ] instanceof vinyl).to.be.true
-  }
-})
-
-tap.test('.memory.vinylToStringSync() -> should produce a String from vinyl file', async () => {
-  let localString = smartfile.memory.vinylToStringSync(new vinyl({
-    base: '/',
-    path: '/test.txt',
-    contents: new Buffer('myString')
-  }))
-  expect(localString).equal('myString')
-})
+// ---------------------------
+// smartfile.memory
+// ---------------------------
 
 tap.test('.memory.toFs() -> should write a file to disk and return a promise', async () => {
   let localString = 'myString'
-  smartfile.memory.toFs(
+  await smartfile.memory.toFs(
     localString,
     path.join(process.cwd(), './test/temp/testMemToFs.txt')
   )
@@ -184,4 +155,32 @@ tap.test('.remote.toString() -> should reject a Promise when the link is false',
     .to.eventually.be.rejected
 })
 
+// ---------------------------
+// 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/smartfile.classes.smartfile.ts

@@ -2,8 +2,9 @@ import * as plugins from './smartfile.plugins'
 
 export interface ISmartfileConstructorOptions {
   path?: string
-  contentsString?: string
+  contentString?: string
   contentBuffer?: Buffer
+  base?: string
 }
 
 /**
@@ -17,14 +18,20 @@ export class Smartfile {
   path: string
 
   /**
-   * The contents of the file as Buffer
+   * 
    */
-  contents: Buffer
+  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 
    */
-  cwd: string
+  base: string
 
   /**
    * sync the file with disk
@@ -35,21 +42,19 @@ export class Smartfile {
    * the constructor of Smartfile
    * @param optionsArg
    */
+
+
   constructor (optionsArg: ISmartfileConstructorOptions) {
     if (optionsArg.contentBuffer) {
-      this.contents = optionsArg.contentBuffer
-    } else if (optionsArg.contentsString) {
-      this.contents = new Buffer(optionsArg.contentsString)
+      this.contentBuffer = optionsArg.contentBuffer
+    } else if (optionsArg.contentString) {
+      this.setContentsFromString(optionsArg.contentString)
+    } else {
+      console.log('created empty Smartfile?')
     }
     this.path = optionsArg.path
-  }
-
-  /**
-   * return relative path of file
-   * -> 
-   */
-  get relative () {
-    return ''
+    this.parsedPath = plugins.path.parse(this.path)
+    this.base = optionsArg.base
   }
 
 
@@ -73,4 +78,63 @@ export class Smartfile {
    */
   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
+  }
 }

ts/smartfile.fs.ts

@@ -43,7 +43,11 @@ export let fileExists = function (filePath) {
  * Checks if given path points to an existing directory
  */
 export let isDirectory = function (pathArg): boolean {
-  return plugins.fsExtra.statSync(pathArg).isDirectory()
+  try {
+    return plugins.fsExtra.statSync(pathArg).isDirectory()
+  } catch (err) {
+    return false
+  }
 }
 
 /**
@@ -203,20 +207,32 @@ export let toObjectSync = function (filePathArg, fileTypeArg?) {
  * @param filePath
  * @returns {string|Buffer|any}
  */
-export let toStringSync = function (filePath: string) {
-  let fileString = plugins.fsExtra.readFileSync(filePath, 'utf8')
+export let toStringSync = function (filePath: string): string {
+  let fileString: any = plugins.fsExtra.readFileSync(filePath, 'utf8')
   return fileString
 }
 
 export let fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string) => {
-  let fileTree = await listFileTree(dirPathArg, miniMatchFilter)
+  // 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 fileContentString = toStringSync(
+      plugins.path.join(dirPath, filePath)
+    )
+
+    // push a read file as Smartfile
     smartfileArray.push(new Smartfile({
-      path: filePath,
-      contentBuffer: new Buffer(toStringSync(
-        plugins.path.join(dirPathArg, filePath)
-      ))
+      contentBuffer: new Buffer(fileContentString),
+      base: dirPath,
+      path: filePath
     }))
   }
   return smartfileArray
@@ -320,7 +336,7 @@ export let listAllItems = function (pathArg: string, regexFilter?: RegExp): Prom
     allItmesArray = allItmesArray.filter((fileItem) => {
       return regexFilter.test(fileItem)
     })
-  };
+  }
   done.resolve(allItmesArray)
   return done.promise
 }
@@ -359,7 +375,8 @@ export let listFileTree = (dirPathArg: string, miniMatchFilter: string): Promise
   }
 
   let options = {
-    cwd: dirPath
+    cwd: dirPath,
+    nodir: true
   }
   plugins.glob(miniMatchFilter, options, (err, files: string[]) => {
     if (err) {

ts/smartfile.memory.ts

@@ -1,52 +1,11 @@
 import 'typings-global'
 
 import plugins = require('./smartfile.plugins')
+import { Smartfile } from './smartfile.classes.smartfile'
+import * as smartfileFs from './smartfile.fs'
+
+
 import SmartfileInterpreter = require('./smartfile.interpreter')
-let vinyl = require('vinyl')
-
-export interface IVinylFile {
-    contents: Buffer
-    base: string
-    path: string,
-}
-
-let Readable = require('stream').Readable
-
-/**
- * allows you to create a gulp stream
- * from String, from an Array of Strings, from Vinyl File, from an Array of VinylFiles
- * @param fileArg
- * @returns stream.Readable
- * @TODO: make it async;
- */
-export let toGulpStream = function(fileArg: string|string[]|IVinylFile|IVinylFile[],baseArg: string = '/'){
-    let fileArray = []
-
-    if (typeof fileArg === 'string' || vinyl.isVinyl(fileArg)) { // make sure we work with an array later on
-        fileArray.push(fileArg)
-    } else if (Array.isArray(fileArg)) {
-        fileArray = fileArg
-    } else {
-        throw new Error('fileArg has unknown format')
-    }
-
-    let vinylFileArray: IVinylFile[] = [] // we want to have an array of vinylFiles
-
-    for (let fileIndexArg in fileArray) { // convert fileArray in vinylArray
-        let file = fileArray[fileIndexArg]
-        file instanceof vinyl ?
-            vinylFileArray.push(file) :
-            vinylFileArray.push(toVinylFileSync(file,{filename: fileIndexArg,base: baseArg}))
-    };
-
-    let stream = new Readable({ objectMode: true })
-    for (let vinylFileIndexArg in vinylFileArray) {
-        let vinylFile = vinylFileArray[vinylFileIndexArg]
-        stream.push(vinylFile)
-    };
-    stream.push(null) // signal end of stream;
-    return stream
-}
 
 /**
  * converts file to Object
@@ -54,54 +13,12 @@ export let toGulpStream = function(fileArg: string|string[]|IVinylFile|IVinylFil
  * @param fileTypeArg
  * @returns {any|any}
  */
-export let toObject = function(fileStringArg: string,fileTypeArg: string){
-    return SmartfileInterpreter.objectFile(fileStringArg,fileTypeArg)
+export let toObject = function (fileStringArg: string, fileTypeArg: string) {
+  return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg)
 }
 
-/**
- * takes a string and converts it to vinyl file
- * @param fileArg
- * @param optionsArg
- */
-export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: string,base?: string,relPath?: string}) {
-    optionsArg ? void(0) : optionsArg = {filename: 'vinylfile', base: '/'}
-    optionsArg.filename ? void(0) : optionsArg.filename = 'vinylfile'
-    optionsArg.base ? void(0) : optionsArg.base = '/'
-    optionsArg.relPath ? void('0') : optionsArg.relPath = ''
-    let vinylFile = new vinyl({
-        base: optionsArg.base,
-        path: plugins.path.join(optionsArg.base,optionsArg.relPath,optionsArg.filename),
-        contents: new Buffer(fileArg)
-    })
-    return vinylFile
-}
-
-/**
- * takes a string array and some options and returns a vinylfile array
- * @param arrayArg
- * @param optionsArg
- */
-export let toVinylArraySync = function(
-    arrayArg: string[],
-    optionsArg?: {
-        filename?: string,
-        base?: string,
-        relPath?: string
-    }
-){
-    let vinylArray = []
-    for (let stringIndexArg in arrayArg) {
-        let myString = arrayArg[stringIndexArg]
-        vinylArray.push(toVinylFileSync(myString,optionsArg))
-    }
-    return vinylArray
-}
-
-/**
- * takes a vinylFile object and converts it to String
- */
-export let vinylToStringSync = function(fileArg: IVinylFile): string {
-    return fileArg.contents.toString('utf8')
+export interface IToFsOptions {
+  respectRelative?: boolean
 }
 
 /**
@@ -110,41 +27,62 @@ export let vinylToStringSync = function(fileArg: IVinylFile): string {
  * @param fileNameArg
  * @param fileBaseArg
  */
-export let toFs = function(fileContentArg: string|IVinylFile,filePathArg){
-    let done = plugins.q.defer()
+export let toFs = async (fileContentArg: string | Smartfile, filePathArg, optionsArg: IToFsOptions = {} ) => {
+  let done = plugins.q.defer()
 
-    // function checks to abort if needed
-    if (!fileContentArg || !filePathArg) {
-        throw new Error('expected valid arguments')
-    }
+  // check args
+  if (!fileContentArg || !filePathArg) {
+    throw new Error('expected valid arguments')
+  }
 
-    // prepare actual write action
-    let fileString: string
-    let filePath: string = filePathArg
-    if (vinyl.isVinyl(fileContentArg)) {
-        let fileContentArg2: any = fileContentArg
-        fileString = vinylToStringSync(fileContentArg2)
-    } else if (typeof fileContentArg === 'string') {
-        fileString = fileContentArg
-    }
-    plugins.fsExtra.writeFile(filePath,fileString,'utf8',done.resolve)
-    return done.promise
+  // 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
+    optionsArg.respectRelative ? filePath = plugins.path.join(filePath, fileContentArg.path) : null
+  } else if (typeof fileContentArg === 'string') {
+    fileString = fileContentArg
+  } else {
+    throw new Error('fileContent is neither string nor Smartfile')
+  }
+  plugins.fsExtra.writeFile(filePath, fileString, 'utf8', done.resolve)
+  return await done.promise
 }
 
-export let toFsSync = function(fileArg,filePathArg: string){
-    // function checks to abort if needed
-    if (!fileArg || !filePathArg) {
-        throw new Error('expected a valid arguments')
-    }
+/**
+ * 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
+  // prepare actual write action
+  let fileString: string
+  let filePath: string = filePathArg
 
-    if (typeof fileArg !== 'string') {
-        fileString = vinylToStringSync(fileArg)
-    } else if (typeof fileArg === 'string') {
-        fileString = fileArg
-    }
-    plugins.fsExtra.writeFileSync(filePath,fileString,'utf8')
+  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, 'utf8')
+}
+
+export let smartfileArrayToFs = async (smartfileArrayArg: Smartfile[], dirArg: string) => {
+  await smartfileFs.ensureDir(dirArg)
+  for(let smartfile of smartfileArrayArg) {
+    await toFs(smartfile, dirArg, {
+      respectRelative: true
+    })
+  }
 }

yarn.lock

@@ -16,28 +16,24 @@
     "@types/chai" "*"
 
 "@types/chai@*", "@types/chai@^3.4.35":
-  version "3.5.1"
-  resolved "https://registry.yarnpkg.com/@types/chai/-/chai-3.5.1.tgz#9bd77fe12503ae00648b0945b38eab666adffe2e"
+  version "3.5.2"
+  resolved "https://registry.yarnpkg.com/@types/chai/-/chai-3.5.2.tgz#c11cd2817d3a401b7ba0f5a420f35c56139b1c1e"
 
-"@types/fs-extra@2.x.x":
-  version "2.1.0"
-  resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-2.1.0.tgz#8b350239c0455d92b8d3c626edac193860ff395f"
+"@types/fs-extra@3.x.x":
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-3.0.0.tgz#13e5566e4d780618ba52bd55e0dc713d7a687e59"
   dependencies:
     "@types/node" "*"
 
 "@types/node@*":
-  version "7.0.14"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.14.tgz#1470fa002a113316ac9d9ad163fc738c7a0de2a4"
+  version "7.0.18"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.18.tgz#cd67f27d3dc0cfb746f0bdd5e086c4c5d55be173"
 
 "@types/promises-a-plus@*":
   version "0.0.27"
   resolved "https://registry.yarnpkg.com/@types/promises-a-plus/-/promises-a-plus-0.0.27.tgz#c64651134614c84b8f5d7114ce8901d36a609780"
 
-"@types/q@0.0.32":
-  version "0.0.32"
-  resolved "https://registry.yarnpkg.com/@types/q/-/q-0.0.32.tgz#bd284e57c84f1325da702babfc82a5328190c0c5"
-
-"@types/through2@^2.0.31":
+"@types/through2@^2.0.32":
   version "2.0.32"
   resolved "https://registry.yarnpkg.com/@types/through2/-/through2-2.0.32.tgz#470024450f1ab7640f19f9ebf42d3da574c26129"
   dependencies:
@@ -78,7 +74,7 @@ bindings@^1.2.1:
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/bindings/-/bindings-1.2.1.tgz#14ad6113812d2d37d72e67b4cacb4bb726505f11"
 
-brace-expansion@^1.0.0:
+brace-expansion@^1.1.7:
   version "1.1.7"
   resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.7.tgz#3effc3c50e000531fb720eaff80f0ae8ef23cf59"
   dependencies:
@@ -163,9 +159,9 @@ first-chunk-stream@^2.0.0:
   dependencies:
     readable-stream "^2.0.2"
 
-fs-extra@^3.0.0:
-  version "3.0.0"
-  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-3.0.0.tgz#244e0c4b0b8818f54040ec049d8a2bddc1202861"
+fs-extra@^3.0.1:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-3.0.1.tgz#3794f378c58b342ea7dbbb23095109c4b3b62291"
   dependencies:
     graceful-fs "^4.1.2"
     jsonfile "^3.0.0"
@@ -190,15 +186,14 @@ graceful-fs@^4.1.2, graceful-fs@^4.1.6:
   version "4.1.11"
   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"
 
-gulp-function@^2.2.3:
-  version "2.2.3"
-  resolved "https://registry.yarnpkg.com/gulp-function/-/gulp-function-2.2.3.tgz#8f62de74ce74de3fa91c48ba247472c1f56873bd"
+gulp-function@^2.2.9:
+  version "2.2.9"
+  resolved "https://registry.yarnpkg.com/gulp-function/-/gulp-function-2.2.9.tgz#de513103db9d817e94bb8aab45f30bf286f19ae5"
   dependencies:
-    "@types/q" "0.0.32"
-    "@types/through2" "^2.0.31"
-    q "^1.4.1"
-    through2 "^2.0.1"
-    typings-global "^1.0.14"
+    "@types/through2" "^2.0.32"
+    smartq "^1.1.1"
+    through2 "^2.0.3"
+    typings-global "^1.0.16"
 
 home@^1.0.1:
   version "1.0.1"
@@ -267,10 +262,10 @@ memwatch-next@^0.3.0:
     nan "^2.3.2"
 
 minimatch@^3.0.2:
-  version "3.0.3"
-  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.3.tgz#2a4e4090b96b2db06a9d7df01055a62a77c9b774"
+  version "3.0.4"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083"
   dependencies:
-    brace-expansion "^1.0.0"
+    brace-expansion "^1.1.7"
 
 minimist@^1.2.0:
   version "1.2.0"
@@ -310,10 +305,6 @@ process-nextick-args@^1.0.6, process-nextick-args@~1.0.6:
   version "1.0.7"
   resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-1.0.7.tgz#150e20b756590ad3f91093f25a4f2ad8bff30ba3"
 
-q@^1.4.1:
-  version "1.5.0"
-  resolved "https://registry.yarnpkg.com/q/-/q-1.5.0.tgz#dd01bac9d06d30e6f219aecb8253ee9ebdc308f1"
-
 readable-stream@^2.0.2, readable-stream@^2.1.5:
   version "2.2.9"
   resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.2.9.tgz#cf78ec6f4a6d1eb43d26488cac97f042e74b7fc8"
@@ -429,9 +420,9 @@ strip-bom@^2.0.0:
   dependencies:
     is-utf8 "^0.2.0"
 
-tapbundle@^1.0.10:
-  version "1.0.10"
-  resolved "https://registry.yarnpkg.com/tapbundle/-/tapbundle-1.0.10.tgz#36fd40036f6b5b738cbb9b5fc400df4c4031bc26"
+tapbundle@^1.0.12:
+  version "1.0.12"
+  resolved "https://registry.yarnpkg.com/tapbundle/-/tapbundle-1.0.12.tgz#71d29273aad280f5c4e15b2700430b2456a5d364"
   dependencies:
     early "^2.1.1"
     leakage "^0.2.0"
@@ -440,7 +431,7 @@ tapbundle@^1.0.10:
     smartq "^1.1.1"
     typings-global "^1.0.16"
 
-through2@^2.0.1:
+through2@^2.0.1, through2@^2.0.3:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/through2/-/through2-2.0.3.tgz#0004569b37c7c74ba39c43f3ced78d1ad94140be"
   dependencies: