9.0.2

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartfile",
   "private": false,
-  "version": "8.0.10",
+  "version": "9.0.2",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -27,23 +27,23 @@
     "@pushrocks/smartfile-interfaces": "^1.0.7",
     "@pushrocks/smarthash": "^2.1.10",
     "@pushrocks/smartjson": "^4.0.6",
-    "@pushrocks/smartmime": "^1.0.3",
+    "@pushrocks/smartmime": "^1.0.5",
     "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.1.3",
-    "@pushrocks/smartrequest": "^1.1.51",
-    "@types/fs-extra": "^9.0.10",
-    "@types/glob": "^7.1.3",
-    "@types/js-yaml": "^4.0.0",
-    "fs-extra": "^9.1.0",
-    "glob": "^7.1.6",
-    "js-yaml": "^4.0.0"
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartrequest": "^1.1.52",
+    "@types/fs-extra": "^9.0.13",
+    "@types/glob": "^7.2.0",
+    "@types/js-yaml": "^4.0.5",
+    "fs-extra": "^10.0.0",
+    "glob": "^7.2.0",
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.52",
+    "@gitzone/tsbuild": "^2.1.28",
+    "@gitzone/tsrun": "^1.2.18",
+    "@gitzone/tstest": "^1.0.60",
     "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^14.14.37",
+    "@types/node": "^16.11.11",
     "gulp-function": "^2.2.14",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"

ts/smartfile.classes.smartfile.ts

@@ -3,9 +3,9 @@ import * as fs from './smartfile.fs';
 import * as memory from './smartfile.memory';
 
 export interface ISmartfileConstructorOptions {
-  path?: string;
-  contentBuffer?: Buffer;
-  base?: string;
+  path: string;
+  contentBuffer: Buffer;
+  base: string;
 }
 
 /**
@@ -21,20 +21,26 @@ export class Smartfile extends plugins.smartjson.Smartjson {
    * creates a Smartfile from a filePath
    * @param filePath
    */
-  public static async fromFilePath(filePath: string) {
+  public static async fromFilePath(filePath: string, baseArg: string = process.cwd()) {
     filePath = plugins.path.resolve(filePath);
     const fileBuffer = fs.toBufferSync(filePath);
     const smartfile = new Smartfile({
-      path: filePath,
       contentBuffer: fileBuffer,
+      base: baseArg,
+      path: plugins.path.relative(baseArg, filePath),
     });
     return smartfile;
   }
 
-  public static async fromBuffer(filePath: string, contentBufferArg: Buffer) {
+  public static async fromBuffer(
+    filePath: string,
+    contentBufferArg: Buffer,
+    baseArg: string = process.cwd()
+  ) {
     const smartfile = new Smartfile({
       contentBuffer: contentBufferArg,
-      path: filePath,
+      base: baseArg,
+      path: plugins.path.relative(baseArg, filePath),
     });
 
     return smartfile;
@@ -43,11 +49,13 @@ export class Smartfile extends plugins.smartjson.Smartjson {
   public static async fromString(
     filePath: string,
     contentStringArg: string,
-    encodingArg: 'utf8' | 'binary'
+    encodingArg: 'utf8' | 'binary',
+    baseArg = process.cwd()
   ) {
     const smartfile = new Smartfile({
       contentBuffer: Buffer.from(contentStringArg, encodingArg),
-      path: filePath,
+      base: baseArg,
+      path: plugins.path.relative(baseArg, filePath),
     });
 
     return smartfile;
@@ -61,7 +69,7 @@ export class Smartfile extends plugins.smartjson.Smartjson {
   // INSTANCE
   // ========
   /**
-   * the full path of the file on disk
+   * the relative path of the file
    */
   @plugins.smartjson.foldDec()
   public path: string;
@@ -69,8 +77,16 @@ export class Smartfile extends plugins.smartjson.Smartjson {
   /**
    * a parsed path
    */
-  @plugins.smartjson.foldDec()
-  public parsedPath: plugins.path.ParsedPath;
+  public get parsedPath (): plugins.path.ParsedPath {
+    return plugins.path.parse(this.path);
+  };
+  public get absolutePath () {
+    return plugins.path.join(this.base, this.path);
+  }
+
+  public get absoluteParsedPath() {
+    return plugins.path.parse(this.absolutePath);
+  }
 
   /**
    * the content of the file as Buffer
@@ -104,7 +120,6 @@ export class Smartfile extends plugins.smartjson.Smartjson {
       console.log('created empty Smartfile?');
     }
     this.path = optionsArg.path;
-    this.parsedPath = plugins.path.parse(this.path);
     this.base = optionsArg.base;
   }
 
@@ -122,11 +137,12 @@ export class Smartfile extends plugins.smartjson.Smartjson {
    * - no argument write to exactly where the file was picked up
    */
   public async write() {
-    await memory.toFs(this.contentBuffer, this.path);
+    await memory.toFs(this.contentBuffer, plugins.path.join(this.base, this.path));
   }
 
   /**
    * writes the file to path given as argument
+   * note: if the path is not absolute, takes process.cwd() as base
    * @param filePathArg
    */
   public async writeToDiskAtPath(filePathArg: string) {
@@ -136,6 +152,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);
@@ -146,7 +167,16 @@ export class Smartfile extends plugins.smartjson.Smartjson {
   /**
    * read file from disk
    */
-  public async read() {}
+  public async read() {
+    this.contentBuffer = await fs.toBuffer(plugins.path.join(this.base, this.path));
+  }
+
+  /**
+   * deletes the file from disk at its original location
+   */
+  public async delete() {
+    await fs.remove(plugins.path.join(this.base, this.path));
+  }
 
   // -----------------------------------------------
   // vinyl compatibility
@@ -172,7 +202,7 @@ export class Smartfile extends plugins.smartjson.Smartjson {
    * return relative path of file
    */
   public get relative(): string {
-    return plugins.path.relative(this.base, this.path);
+    return this.path;
   }
 
   /**

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);
 };