improve memory.toFs(Sync)

This commit is contained in:
Philipp Kunz 2016-06-24 03:36:51 +02:00
parent 4522907af3
commit fea9675b2a
8 changed files with 149 additions and 154 deletions

View File

@ -1,4 +1,24 @@
import "typings-global"; import "typings-global";
/**
*
* @param filePath
* @returns {boolean}
*/
export declare let fileExistsSync: (filePath: any) => boolean;
/**
*
* @param filePath
* @returns {any}
*/
export declare let fileExists: (filePath: any) => any;
/**
* 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 * copies a file from A to B on the local disk
*/ */
@ -15,10 +35,6 @@ export declare let remove: (pathArg: string) => any;
* removes a file SYNCHRONOUSLY from local disk * removes a file SYNCHRONOUSLY from local disk
*/ */
export declare let removeSync: (pathArg: string) => boolean; export declare let removeSync: (pathArg: string) => boolean;
export declare let toFS: (options: {
from: string;
toPath: string;
}, cb?: any) => void;
/** /**
* *
* @param filePathArg * @param filePathArg
@ -60,17 +76,3 @@ export declare let listFolders: (pathArg: string) => any;
* lists Folders SYNCHRONOUSLY in a directory on local disk * lists Folders SYNCHRONOUSLY in a directory on local disk
*/ */
export declare let listFoldersSync: (pathArg: any) => any; export declare let listFoldersSync: (pathArg: any) => any;
/**
*
* @param filePath
* @returns {boolean}
*/
export declare let fileExistsSync: (filePath: any) => boolean;
/**
*
* @param filePath
* @returns {any}
*/
export declare let fileExists: (filePath: any) => any;
export declare let isDirectory: (pathArg: any) => boolean;
export declare let isFile: (pathArg: any) => boolean;

82
dist/smartfile.fs.js vendored

File diff suppressed because one or more lines are too long

View File

@ -45,11 +45,5 @@ export declare let toStringSync: (fileArg: plugins.vinyl) => string;
* @param fileNameArg * @param fileNameArg
* @param fileBaseArg * @param fileBaseArg
*/ */
export declare let toFs: (fileArg: any, optionsArg: { export declare let toFs: (fileContentArg: string | plugins.vinyl, filePathArg: any) => any;
fileName: string; export declare let toFsSync: (fileArg: any, filePathArg: string) => void;
filePath: string;
}) => any;
export declare let toFsSync: (fileArg: any, optionsArg: {
fileName: string;
filePath: string;
}) => void;

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -3,6 +3,7 @@ import * as smartfile from "../dist/index";
let beautylog = require("beautylog"); let beautylog = require("beautylog");
let gulp = require("gulp"); let gulp = require("gulp");
let gFunction = require("gulp-function"); let gFunction = require("gulp-function");
import path = require("path");
import should = require("should"); import should = require("should");
let vinyl = require("vinyl"); let vinyl = require("vinyl");
@ -153,10 +154,7 @@ describe("smartfile".yellow,function(){
let localString = "myString"; let localString = "myString";
smartfile.memory.toFs( smartfile.memory.toFs(
localString, localString,
{ path.join(process.cwd(),"./test/temp/testMemToFs.txt")
fileName:"./test/temp/testMemToFs.txt",
filePath:process.cwd()
}
).then(done); ).then(done);
}); });
}); });
@ -164,10 +162,8 @@ describe("smartfile".yellow,function(){
it("should write a file to disk and return true if successfull",function(){ it("should write a file to disk and return true if successfull",function(){
let localString = "myString"; let localString = "myString";
smartfile.memory.toFsSync( smartfile.memory.toFsSync(
localString,{ localString,
fileName:"./test/temp/testMemToFsSync.txt", path.join(process.cwd(),"./test/temp/testMemToFsSync.txt")
filePath:process.cwd()
}
); );
}); });
}); });

View File

@ -3,6 +3,54 @@ import "typings-global";
import plugins = require("./smartfile.plugins"); import plugins = require("./smartfile.plugins");
import SmartfileInterpreter = require("./smartfile.interpreter"); import SmartfileInterpreter = require("./smartfile.interpreter");
/*===============================================================
============================ Checks =============================
===============================================================*/
/**
*
* @param filePath
* @returns {boolean}
*/
export let fileExistsSync = function(filePath):boolean {
let fileExistsBool:boolean = false;
try {
plugins.fs.readFileSync(filePath);
fileExistsBool = true
}
catch(err){
fileExistsBool = false;
}
return fileExistsBool;
};
/**
*
* @param filePath
* @returns {any}
*/
export let fileExists = function(filePath){
let done = plugins.q.defer();
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) {
err ? done.reject() : done.resolve();
});
return done.promise;
};
/**
* Checks if given path points to an existing directory
*/
export let isDirectory = function(pathArg):boolean{
return plugins.fs.statSync(pathArg).isDirectory();
};
/**
* Checks if a given path points to an existing file
*/
export let isFile = function(pathArg):boolean{
return plugins.fs.statSync(pathArg).isFile();
};
/*=============================================================== /*===============================================================
============================ FS ACTIONS ========================= ============================ FS ACTIONS =========================
===============================================================*/ ===============================================================*/
@ -50,11 +98,6 @@ export let removeSync = function(pathArg:string):boolean{
============================ Write/Read ========================= ============================ Write/Read =========================
===============================================================*/ ===============================================================*/
export let toFS = function(options:{from:string,toPath:string}, cb=undefined){
};
/** /**
* *
* @param filePathArg * @param filePathArg
@ -132,41 +175,3 @@ export let listFoldersSync = function(pathArg){
return plugins.fs.statSync(plugins.path.join(pathArg, file)).isDirectory(); return plugins.fs.statSync(plugins.path.join(pathArg, file)).isDirectory();
}); });
}; };
/**
*
* @param filePath
* @returns {boolean}
*/
export let fileExistsSync = function(filePath):boolean {
let fileExistsBool:boolean = false;
try {
plugins.fs.readFileSync(filePath);
fileExistsBool = true
}
catch(err){
fileExistsBool = false;
}
return fileExistsBool;
};
/**
*
* @param filePath
* @returns {any}
*/
export let fileExists = function(filePath){
let done = plugins.q.defer();
plugins.fs.access(filePath, plugins.fs.R_OK, function (err) {
err ? done.reject() : done.resolve();
});
return done.promise;
};
export let isDirectory = function(pathArg):boolean{
return plugins.fs.statSync(pathArg).isDirectory();
};
export let isFile = function(pathArg):boolean{
return plugins.fs.statSync(pathArg).isFile();
};

View File

@ -2,6 +2,7 @@ import "typings-global";
import plugins = require("./smartfile.plugins"); import plugins = require("./smartfile.plugins");
import SmartfileInterpreter = require("./smartfile.interpreter"); import SmartfileInterpreter = require("./smartfile.interpreter");
import vinyl = require("vinyl");
let Readable = require("stream").Readable; let Readable = require("stream").Readable;
/** /**
* allows you to create a gulp stream * allows you to create a gulp stream
@ -96,33 +97,31 @@ export let toStringSync = function(fileArg:plugins.vinyl){
* @param fileNameArg * @param fileNameArg
* @param fileBaseArg * @param fileBaseArg
*/ */
export let toFs = function(fileArg,optionsArg:{fileName:string,filePath:string}){ export let toFs = function(fileContentArg:string|vinyl,filePathArg){
let done = plugins.q.defer(); let done = plugins.q.defer();
//function checks to abort if needed //function checks to abort if needed
if (!fileArg || !optionsArg || !(typeof optionsArg.fileName === "string")) if (!fileContentArg || !filePathArg) throw new Error("expected valid arguments");
throw new Error("expected a valid arguments");
if (!(typeof optionsArg.filePath === "string")) optionsArg.filePath = "/";
let filePath:string = plugins.path.join(optionsArg.filePath,optionsArg.fileName); // prepare actual write action
let fileString:string; let fileString:string;
if (fileArg instanceof plugins.vinyl){ let filePath:string = filePathArg;
fileString = toStringSync(fileArg); if (fileContentArg instanceof plugins.vinyl){
} else if (typeof fileArg === "string") { fileString = toStringSync(fileContentArg);
fileString = fileArg; } else if (typeof fileContentArg === "string") {
fileString = fileContentArg;
} }
plugins.fs.writeFile(filePath,fileString,"utf8",done.resolve); plugins.fs.writeFile(filePath,fileString,"utf8",done.resolve);
return done.promise; return done.promise;
}; };
export let toFsSync = function(fileArg,optionsArg:{fileName:string,filePath:string}){ export let toFsSync = function(fileArg,filePathArg:string){
//function checks to abort if needed //function checks to abort if needed
if (!fileArg || !optionsArg || !(typeof optionsArg.fileName === "string")) if (!fileArg || !filePathArg) throw new Error("expected a valid arguments");
throw new Error("expected a valid arguments");
if (!(typeof optionsArg.filePath === "string")) optionsArg.filePath = "/";
let filePath = plugins.path.join(optionsArg.filePath,optionsArg.fileName); // prepare actual write action
let fileString:string; let fileString:string;
let filePath:string = filePathArg;
if (fileArg instanceof plugins.vinyl){ if (fileArg instanceof plugins.vinyl){
fileString = toStringSync(fileArg); fileString = toStringSync(fileArg);