add ensureEmptyDir() and ensureEmptyDirSync()

dist/smartfile.fs.d.ts

@@ -37,6 +37,16 @@ export declare let ensureDir: (dirPathArg: string) => plugins.q.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) => plugins.q.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
@@ -81,7 +91,7 @@ export declare let toObjectSync: (filePathArg: any, fileTypeArg?: any) => any;
  * @param filePath
  * @returns {string|Buffer|any}
  */
-export declare let toStringSync: (filePath: any) => string;
+export declare let toStringSync: (filePath: any) => any;
 /**
  *
  * @param filePathArg

dist/smartfile.memory.d.ts

@@ -1,7 +1,12 @@
-/// <reference types="vinyl" />
+/// <reference types="node" />
 /// <reference types="q" />
 import 'typings-global';
 import plugins = require('./smartfile.plugins');
+export interface vinyl {
+    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
@@ -9,7 +14,7 @@ import plugins = require('./smartfile.plugins');
  * @returns stream.Readable
  * @TODO: make it async;
  */
-export declare let toGulpStream: (fileArg: string | string[] | plugins.vinyl | plugins.vinyl[], baseArg?: string) => any;
+export declare let toGulpStream: (fileArg: string | string[] | vinyl | vinyl[], baseArg?: string) => any;
 /**
  * converts file to Object
  * @param fileStringArg
@@ -26,7 +31,7 @@ export declare let toVinylFileSync: (fileArg: string, optionsArg?: {
     filename?: string;
     base?: string;
     relPath?: string;
-}) => plugins.vinyl;
+}) => any;
 /**
  * takes a string array and some options and returns a vinylfile array
  * @param arrayArg
@@ -36,16 +41,16 @@ export declare let toVinylArraySync: (arrayArg: string[], optionsArg?: {
     filename?: string;
     base?: string;
     relPath?: string;
-}) => plugins.vinyl[];
+}) => any[];
 /**
  * takes a vinylFile object and converts it to String
  */
-export declare let toStringSync: (fileArg: plugins.vinyl) => any;
+export declare let vinylToStringSync: (fileArg: vinyl) => string;
 /**
  * writes string or vinyl file to disk.
  * @param fileArg
  * @param fileNameArg
  * @param fileBaseArg
  */
-export declare let toFs: (fileContentArg: string | plugins.vinyl, filePathArg: any) => plugins.q.Promise<{}>;
+export declare let toFs: (fileContentArg: string | vinyl, filePathArg: any) => plugins.q.Promise<{}>;
 export declare let toFsSync: (fileArg: any, filePathArg: string) => void;

dist/smartfile.plugins.d.ts

@@ -8,6 +8,5 @@ export import q = require('q');
 export declare let request: any;
 export declare let requireReload: any;
 export import smartpath = require('smartpath');
-export import vinyl = require('vinyl');
 export declare let vinylFile: any;
 export declare let yaml: any;

dist/smartfile.plugins.js

@@ -9,7 +9,6 @@ exports.q = require("q");
 exports.request = require('request');
 exports.requireReload = require('require-reload');
 exports.smartpath = require("smartpath");
-exports.vinyl = require("vinyl");
 exports.vinylFile = require('vinyl-file');
 exports.yaml = require('js-yaml');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHlDQUE4QztBQUM5QywyQkFBZ0M7QUFDaEMsc0NBQTJDO0FBQ2hDLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUNqQywrQkFBb0M7QUFDcEMseUJBQThCO0FBQ25CLFFBQUEsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQTtBQUM1QixRQUFBLGFBQWEsR0FBRyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FBQTtBQUNwRCx5Q0FBOEM7QUFDOUMsaUNBQXNDO0FBQzNCLFFBQUEsU0FBUyxHQUFHLE9BQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQTtBQUNqQyxRQUFBLElBQUksR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUEifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGZpbGUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHlDQUE4QztBQUM5QywyQkFBZ0M7QUFDaEMsc0NBQTJDO0FBQ2hDLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUNqQywrQkFBb0M7QUFDcEMseUJBQThCO0FBQ25CLFFBQUEsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQTtBQUM1QixRQUFBLGFBQWEsR0FBRyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FBQTtBQUNwRCx5Q0FBOEM7QUFDbkMsUUFBQSxTQUFTLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFBO0FBQ2pDLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FBQSJ9

package.json

@@ -28,24 +28,24 @@
   "dependencies": {
     "@types/fs-extra": "0.x.x",
     "@types/q": "0.x.x",
-    "@types/vinyl": "^1.1.29",
+    "@types/vinyl": "^2.0.0",
-    "beautylog": "^5.0.23",
+    "beautylog": "^6.0.0",
-    "fs-extra": "^0.30.0",
+    "fs-extra": "^1.0.0",
-    "glob": "^7.1.0",
+    "glob": "^7.1.1",
-    "js-yaml": "^3.6.1",
+    "js-yaml": "^3.7.0",
     "q": "^1.4.1",
-    "request": "^2.75.0",
+    "request": "^2.79.0",
     "require-reload": "0.2.2",
-    "smartpath": "^3.2.2",
+    "smartpath": "^3.2.7",
     "typings-global": "^1.0.14",
-    "vinyl": "^1.2.0",
+    "vinyl": "^2.0.1",
     "vinyl-file": "^2.0.0"
   },
   "devDependencies": {
     "@types/should": "^8.1.30",
-    "gulp-function": "^1.3.6",
+    "gulp-function": "^2.2.3",
-    "npmts-g": "^5.2.8",
+    "npmts-g": "^5.2.10",
-    "should": "^11.1.0",
+    "should": "^11.1.2",
     "typings-test": "^1.0.3"
   }
 }

test/test.ts

@@ -3,17 +3,17 @@ import * as smartfile from '../dist/index'
 import beautylog = require('beautylog')
 import path = require('path')
 import * as should from 'should'
-let vinyl = require('vinyl')
+import * as vinyl from 'vinyl'
 
-describe('smartfile'.yellow, function () {
+describe('smartfile', function () {
-    describe('.fs'.yellow, function () {
+    describe('.fs', function () {
-        describe('.fileExistsSync'.yellow, function () {
+        describe('.fileExistsSync', function () {
             it('should return an accurate boolean', function () {
                 should(smartfile.fs.fileExistsSync('./test/mytest.json')).be.true()
                 should(smartfile.fs.fileExistsSync('./test/notthere.json')).be.false()
             })
         })
-        describe('.fileExists'.yellow, function () {
+        describe('.fileExists', function () {
             it('should return a working promise', function () {
                 should(smartfile.fs.fileExists('./test/mytest.json')).be.Promise()
                 should(smartfile.fs.fileExists('./test/mytest.json')).be.fulfilled()
@@ -64,7 +64,7 @@ describe('smartfile'.yellow, function () {
                     })
             })
         })
-        describe('.copy()'.yellow, function () {
+        describe('.copy()', function () {
             it('should copy a directory', function () {
                 smartfile.fs.copy('./test/testfolder/', './test/temp/')
             })
@@ -110,9 +110,9 @@ describe('smartfile'.yellow, function () {
         })
     })
 
-    describe('.fs'.yellow, function () {
+    describe('.fs', function () {
-        describe('.toObjectSync()'.yellow, function () {
+        describe('.toObjectSync()', function () {
-            it('should read an ' + '.yaml'.blue + ' file to an object', function () {
+            it('should read an ' + '.yaml' + ' file to an object', function () {
                 let testData = smartfile.fs.toObjectSync('./test/mytest.yaml')
                 should(testData).have.property('key1', 'this works')
                 should(testData).have.property('key2', 'this works too')
@@ -121,14 +121,14 @@ describe('smartfile'.yellow, function () {
             it('should state unknown file type for unknown file types', function () {
                 let testData = smartfile.fs.toObjectSync('./test/mytest.txt')
             })
-            it('should read an ' + '.json'.blue + ' file to an object', function () {
+            it('should read an ' + '.json' + ' file to an object', function () {
                 let testData = smartfile.fs.toObjectSync('./test/mytest.json')
                 should(testData).have.property('key1', 'this works')
                 should(testData).have.property('key2', 'this works too')
 
             })
         })
-        describe('.toStringSync()'.yellow, function () {
+        describe('.toStringSync()', function () {
             it('should read a file to a string', function () {
                 should.equal(
                     smartfile.fs.toStringSync('./test/mytest.txt'),
@@ -136,8 +136,8 @@ describe('smartfile'.yellow, function () {
                 )
             })
         })
-        describe('.toVinylSync'.yellow, function () {
+        describe('.toVinylSync', function () {
-            it('should read an ' + '.json OR .yaml'.blue + ' file to an ' + 'vinyl file object'.cyan, function () {
+            it('should read an ' + '.json OR .yaml' + ' file to an ' + 'vinyl file object', function () {
                 let testData = smartfile.fs.toVinylSync('./test/mytest.json')
                 should(vinyl.isVinyl(testData)).be.true()
             })
@@ -170,9 +170,9 @@ describe('smartfile'.yellow, function () {
                 }
             })
         })
-        describe('toStringSync()', function () {
+        describe('vinylToStringSync()', function () {
             it('should produce a String from vinyl file', function () {
-                let localString = smartfile.memory.toStringSync(new vinyl({
+                let localString = smartfile.memory.vinylToStringSync(new vinyl({
                     base: '/',
                     path: '/test.txt',
                     contents: new Buffer('myString')

ts/smartfile.fs.ts

@@ -89,6 +89,27 @@ export let ensureDirSync = (dirPathArg: string) => {
     plugins.fsExtra.ensureDirSync(dirPathArg)
 }
 
+/**
+ * ensure an empty directory
+ * @executes ASYNC
+ */
+export let ensureEmptyDir = (dirPathArg: string) => {
+    let done = plugins.q.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
@@ -161,7 +182,6 @@ export let removeManySync = function(filePathArrayArg: string[]): void {
 ============================ Write/Read =========================
 ===============================================================*/
 
-
 /**
  *
  * @param filePathArg

ts/smartfile.memory.ts

@@ -2,9 +2,15 @@ import 'typings-global'
 
 import plugins = require('./smartfile.plugins')
 import SmartfileInterpreter = require('./smartfile.interpreter')
-import vinyl = require('vinyl')
+let vinyl = require('vinyl')
-let Readable = require('stream').Readable
 
+export interface vinyl {
+    contents: Buffer
+    base: string
+    path: string,
+}
+
+let Readable = require('stream').Readable
 
 /**
  * allows you to create a gulp stream
@@ -13,10 +19,10 @@ let Readable = require('stream').Readable
  * @returns stream.Readable
  * @TODO: make it async;
  */
-export let toGulpStream = function(fileArg: string|string[]|plugins.vinyl|plugins.vinyl[],baseArg: string = '/'){
+export let toGulpStream = function(fileArg: string|string[]|vinyl|vinyl[],baseArg: string = '/'){
     let fileArray = []
 
-    if (typeof fileArg === 'string' || fileArg instanceof plugins.vinyl) { // make sure we work with an array later on
+    if (typeof fileArg === 'string' || fileArg instanceof vinyl) { // make sure we work with an array later on
         fileArray.push(fileArg)
     } else if (Array.isArray(fileArg)) {
         fileArray = fileArg
@@ -24,11 +30,11 @@ export let toGulpStream = function(fileArg: string|string[]|plugins.vinyl|plugin
         throw new Error('fileArg has unknown format')
     }
 
-    let vinylFileArray: plugins.vinyl[] = [] // we want to have an array of vinylFiles
+    let vinylFileArray: vinyl[] = [] // we want to have an array of vinylFiles
 
     for (let fileIndexArg in fileArray) { // convert fileArray in vinylArray
         let file = fileArray[fileIndexArg]
-        file instanceof plugins.vinyl ?
+        file instanceof vinyl ?
             vinylFileArray.push(file) :
             vinylFileArray.push(toVinylFileSync(file,{filename: fileIndexArg,base: baseArg}))
     };
@@ -62,20 +68,27 @@ export let toVinylFileSync = function(fileArg: string,optionsArg?: {filename?: s
     optionsArg.filename ? void(0) : optionsArg.filename = 'vinylfile'
     optionsArg.base ? void(0) : optionsArg.base = '/'
     optionsArg.relPath ? void('0') : optionsArg.relPath = ''
-    let vinylFile = new plugins.vinyl({
+    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}){
+export let toVinylArraySync = function(
+    arrayArg: string[],
+    optionsArg?: {
+        filename?: string,
+        base?: string,
+        relPath?: string
+    }
+){
     let vinylArray = []
     for (let stringIndexArg in arrayArg) {
         let myString = arrayArg[stringIndexArg]
@@ -84,14 +97,12 @@ export let toVinylArraySync = function(arrayArg: string[],optionsArg?: {filename
     return vinylArray
 }
 
-
 /**
  * takes a vinylFile object and converts it to String
  */
-export let toStringSync = function(fileArg: plugins.vinyl){
+export let vinylToStringSync = function(fileArg: vinyl){
     return fileArg.contents.toString('utf8')
-};
+}
-
 
 /**
  * writes string or vinyl file to disk.
@@ -109,9 +120,9 @@ export let toFs = function(fileContentArg: string|vinyl,filePathArg){
 
     // prepare actual write action
     let fileString: string
-    let filePath: string = filePathArg;
+    let filePath: string = filePathArg
-    if (fileContentArg instanceof plugins.vinyl) {
+    if (fileContentArg instanceof vinyl) {
-        fileString = toStringSync(fileContentArg)
+        fileString = vinylToStringSync(fileContentArg)
     } else if (typeof fileContentArg === 'string') {
         fileString = fileContentArg
     }
@@ -129,11 +140,10 @@ export let toFsSync = function(fileArg,filePathArg: string){
     let fileString: string
     let filePath: string = filePathArg
 
-    if (fileArg instanceof plugins.vinyl) {
+    if (typeof fileArg !== 'string') {
-        fileString = toStringSync(fileArg)
+        fileString = vinylToStringSync(fileArg)
     } else if (typeof fileArg === 'string') {
         fileString = fileArg
     }
     plugins.fsExtra.writeFileSync(filePath,fileString,'utf8')
 }
-

ts/smartfile.plugins.ts

@@ -8,6 +8,5 @@ export import q = require('q')
 export let request = require('request')
 export let requireReload = require('require-reload')
 export import smartpath = require('smartpath')
-export import vinyl = require('vinyl')
 export let vinylFile = require('vinyl-file')
 export let yaml = require('js-yaml')