8.0.11

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartfile",
   "private": false,
-  "version": "8.0.8",
+  "version": "8.0.11",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -25,25 +25,25 @@
   "homepage": "https://gitlab.com/pushrocks/smartfile",
   "dependencies": {
     "@pushrocks/smartfile-interfaces": "^1.0.7",
-    "@pushrocks/smarthash": "^2.1.6",
+    "@pushrocks/smarthash": "^2.1.10",
-    "@pushrocks/smartjson": "^4.0.3",
+    "@pushrocks/smartjson": "^4.0.6",
-    "@pushrocks/smartmime": "^1.0.3",
+    "@pushrocks/smartmime": "^1.0.5",
     "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.6",
-    "@pushrocks/smartrequest": "^1.1.51",
+    "@pushrocks/smartrequest": "^1.1.52",
-    "@types/fs-extra": "^9.0.1",
+    "@types/fs-extra": "^9.0.13",
-    "@types/glob": "^7.1.3",
+    "@types/glob": "^7.2.0",
-    "@types/js-yaml": "^3.12.5",
+    "@types/js-yaml": "^4.0.5",
-    "fs-extra": "^9.0.1",
+    "fs-extra": "^10.0.0",
-    "glob": "^7.1.6",
+    "glob": "^7.2.0",
-    "js-yaml": "^3.14.0"
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbuild": "^2.1.28",
-    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tsrun": "^1.2.18",
-    "@gitzone/tstest": "^1.0.52",
+    "@gitzone/tstest": "^1.0.60",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^14.11.2",
+    "@types/node": "^16.11.11",
     "gulp-function": "^2.2.14",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"

test/testassets/test/subfolder/deepsubfolder/deepsubtestfile.txt

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

test/testassets/test/subfolder/subtestfile.txt

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

ts/index.ts

@@ -4,7 +4,7 @@ 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 { Smartfile, ISmartfileConstructorOptions } from './smartfile.classes.smartfile';
 export { VirtualDirectory } from './smartfile.classes.virtualdirectory';
 
 export let fs = SmartfileFs;

ts/smartfile.classes.smartfile.ts

@@ -53,6 +53,10 @@ export class Smartfile extends plugins.smartjson.Smartjson {
     return smartfile;
   }
 
+  public static async fromFoldedJson(foldedJsonArg: string) {
+    return new Smartfile(plugins.smartjson.parse(foldedJsonArg));
+  }
+
   // ========
   // INSTANCE
   // ========
@@ -132,6 +136,11 @@ export class Smartfile extends plugins.smartjson.Smartjson {
     await memory.toFs(this.contentBuffer, filePathArg);
   }
 
+  /**
+   * writes the file to a directory combined with the relative path portion
+   * @param dirPathArg
+   * @returns
+   */
   public async writeToDir(dirPathArg: string) {
     dirPathArg = plugins.smartpath.transform.toAbsolute(dirPathArg);
     const filePath = plugins.path.join(dirPathArg, this.path);
@@ -142,7 +151,16 @@ export class Smartfile extends plugins.smartjson.Smartjson {
   /**
    * read file from disk
    */
-  public async read() {}
+  public async read() {
+    this.contentBuffer = await fs.toBuffer(this.path);
+  }
+
+  /**
+   * deletes the file from disk at its original location
+   */
+  public async delete() {
+    await fs.remove(this.path);
+  }
 
   // -----------------------------------------------
   // vinyl compatibility

ts/smartfile.fs.ts

@@ -202,6 +202,10 @@ export const toStringSync = (filePath: string): string => {
   return fileString;
 };
 
+export const toBuffer = async (filePath: string): Promise<Buffer> => {
+  return plugins.fsExtra.readFile(filePath);
+};
+
 export const toBufferSync = (filePath: string): Buffer => {
   return plugins.fsExtra.readFileSync(filePath);
 };

ts/smartfile.interpreter.ts

@@ -10,7 +10,7 @@ export let objectFile = (fileStringArg: string, fileTypeArg) => {
   switch (fileTypeArg) {
     case 'yml':
     case 'yaml':
-      return plugins.yaml.safeLoad(fileStringArg);
+      return plugins.yaml.load(fileStringArg);
     case 'json':
       return JSON.parse(fileStringArg);
     default: