handle gulp in seperate module

dist/smartfile.memory.d.ts

@@ -5,14 +5,6 @@ export interface IVinylFile {
     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;
 /**
  * converts file to Object
  * @param fileStringArg

test/test.ts

@@ -5,6 +5,10 @@ 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
   expect(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false
@@ -91,7 +95,7 @@ tap.test('smartfile.fs.removeManySync -> should remove and array of single files
 })
 
 // ---------------------------
-// .interpreter
+// smartfile.interpreter
 // ---------------------------
 
 tap.test('.interpreter.filetype() -> should get the file type from a string', async () => {
@@ -125,11 +129,6 @@ tap.test('.fs.toVinylSync -> should read an ' + '.json OR .yaml' + ' file to an
   expect(vinyl.isVinyl(testData)).to.be.true
 })
 
-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' }

ts/smartfile.memory.ts

@@ -10,52 +10,14 @@ export interface IVinylFile {
   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
  * @param fileStringArg
  * @param fileTypeArg
  * @returns {any|any}
  */
-export let toObject = function(fileStringArg: string,fileTypeArg: string){
+export let toObject = function (fileStringArg: string, fileTypeArg: string) {
-    return SmartfileInterpreter.objectFile(fileStringArg,fileTypeArg)
+  return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg)
 }
 
 /**
@@ -63,14 +25,14 @@ export let toObject = function(fileStringArg: string,fileTypeArg: string){
  * @param fileArg
  * @param optionsArg
  */
-export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: string,base?: string,relPath?: string}) {
+export let toVinylFileSync = function (fileArg: string, optionsArg?: { filename?: string, base?: string, relPath?: string }) {
-    optionsArg ? void(0) : optionsArg = {filename: 'vinylfile', base: '/'}
+  optionsArg ? void (0) : optionsArg = { filename: 'vinylfile', base: '/' }
-    optionsArg.filename ? void(0) : optionsArg.filename = 'vinylfile'
+  optionsArg.filename ? void (0) : optionsArg.filename = 'vinylfile'
-    optionsArg.base ? void(0) : optionsArg.base = '/'
+  optionsArg.base ? void (0) : optionsArg.base = '/'
-    optionsArg.relPath ? void('0') : optionsArg.relPath = ''
+  optionsArg.relPath ? void ('0') : optionsArg.relPath = ''
   let vinylFile = new vinyl({
     base: optionsArg.base,
-        path: plugins.path.join(optionsArg.base,optionsArg.relPath,optionsArg.filename),
+    path: plugins.path.join(optionsArg.base, optionsArg.relPath, optionsArg.filename),
     contents: new Buffer(fileArg)
   })
   return vinylFile
@@ -81,18 +43,18 @@ export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: s
  * @param arrayArg
  * @param optionsArg
  */
-export let toVinylArraySync = function(
+export let toVinylArraySync = function (
   arrayArg: string[],
   optionsArg?: {
     filename?: string,
     base?: string,
     relPath?: string
   }
-){
+) {
   let vinylArray = []
   for (let stringIndexArg in arrayArg) {
-        let myString = arrayArg[stringIndexArg]
+    let myString = arrayArg[ stringIndexArg ]
-        vinylArray.push(toVinylFileSync(myString,optionsArg))
+    vinylArray.push(toVinylFileSync(myString, optionsArg))
   }
   return vinylArray
 }
@@ -100,7 +62,7 @@ export let toVinylArraySync = function(
 /**
  * takes a vinylFile object and converts it to String
  */
-export let vinylToStringSync = function(fileArg: IVinylFile): string {
+export let vinylToStringSync = function (fileArg: IVinylFile): string {
   return fileArg.contents.toString('utf8')
 }
 
@@ -110,7 +72,7 @@ export let vinylToStringSync = function(fileArg: IVinylFile): string {
  * @param fileNameArg
  * @param fileBaseArg
  */
-export let toFs = function(fileContentArg: string|IVinylFile,filePathArg){
+export let toFs = function (fileContentArg: string | IVinylFile, filePathArg) {
   let done = plugins.q.defer()
 
   // function checks to abort if needed
@@ -127,11 +89,11 @@ export let toFs = function(fileContentArg: string|IVinylFile,filePathArg){
   } else if (typeof fileContentArg === 'string') {
     fileString = fileContentArg
   }
-    plugins.fsExtra.writeFile(filePath,fileString,'utf8',done.resolve)
+  plugins.fsExtra.writeFile(filePath, fileString, 'utf8', done.resolve)
   return done.promise
 }
 
-export let toFsSync = function(fileArg,filePathArg: string){
+export let toFsSync = function (fileArg, filePathArg: string) {
   // function checks to abort if needed
   if (!fileArg || !filePathArg) {
     throw new Error('expected a valid arguments')
@@ -146,5 +108,5 @@ export let toFsSync = function(fileArg,filePathArg: string){
   } else if (typeof fileArg === 'string') {
     fileString = fileArg
   }
-    plugins.fsExtra.writeFileSync(filePath,fileString,'utf8')
+  plugins.fsExtra.writeFileSync(filePath, fileString, 'utf8')
 }