4.2.3

update fileTreeToObject method
4.2.2
2017-04-30 15:37:36 +02:00 · 2017-04-30 15:37:34 +02:00 · 2017-04-30 15:12:37 +02:00 · 2017-04-30 15:12:35 +02:00 · 2017-04-29 23:07:13 +02:00 · 2017-04-29 17:20:15 +02:00
8 changed files with 101 additions and 34 deletions
--- a/dist/smartfile.classes.smartfile.d.ts
+++ b/dist/smartfile.classes.smartfile.d.ts
@ -1,8 +1,9 @@
 /// <reference types="node" />
 export interface ISmartfileConstructorOptions {
    path?: string;
-    contentsString?: string;
+    contentString?: string;
    contentBuffer?: Buffer;
+    cwd?: string;
 }
 /**
 * class Smartfile
@ -14,9 +15,13 @@ export declare class Smartfile {
     */
    path: string;
    /**
-     * The contents of the file as Buffer
+     * gulp-compatibility: alias of this.contentBuffer
     */
    contents: Buffer;
+    /**
+     * the content of the file as Buffer
+     */
+    contentBuffer: Buffer;
    /**
     * The current working directory of the file
     */
--- a/dist/smartfile.classes.smartfile.js
+++ b/dist/smartfile.classes.smartfile.js
@ -19,12 +19,18 @@ class Smartfile {
     */
    constructor(optionsArg) {
        if (optionsArg.contentBuffer) {
+            this.contentBuffer = optionsArg.contentBuffer;
            this.contents = optionsArg.contentBuffer;
        }
-        else if (optionsArg.contentsString) {
-            this.contents = new Buffer(optionsArg.contentsString);
+        else if (optionsArg.contentString) {
+            this.contentBuffer = optionsArg.contentBuffer;
+            this.contents = Buffer.from(optionsArg.contentString);
+        }
+        else {
+            console.log('created empty Smartfile?');
        }
        this.path = optionsArg.path;
+        this.cwd = optionsArg.cwd;
    }
    /**
     * return relative path of file
@ -56,4 +62,4 @@ class Smartfile {
    }
 }
 exports.Smartfile = Smartfile;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFRQTs7O0dBR0c7QUFDSDtJQXFCRTs7O09BR0c7SUFDSCxZQUFhLFVBQXdDO1FBQ25ELEVBQUUsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDO1lBQzdCLElBQUksQ0FBQyxRQUFRLEdBQUcsVUFBVSxDQUFDLGFBQWEsQ0FBQTtRQUMxQyxDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDO1lBQ3JDLElBQUksQ0FBQyxRQUFRLEdBQUcsSUFBSSxNQUFNLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFBO1FBQ3ZELENBQUM7UUFDRCxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUE7SUFDN0IsQ0FBQztJQUVEOzs7T0FHRztJQUNILElBQUksUUFBUTtRQUNWLE1BQU0sQ0FBQyxFQUFFLENBQUE7SUFDWCxDQUFDO0lBR0Q7OztPQUdHO0lBQ0gscUJBQXFCLENBQUMsYUFBcUI7UUFDekMsSUFBSSxDQUFDLFFBQVEsR0FBRyxJQUFJLE1BQU0sQ0FBQyxhQUFhLENBQUMsQ0FBQTtJQUMzQyxDQUFDO0lBRUQ7O09BRUc7SUFDRyxLQUFLOztRQUVYLENBQUM7S0FBQTtJQUVEOztPQUVHO0lBQ0csSUFBSTs7UUFDVixDQUFDO0tBQUE7Q0FDRjtBQS9ERCw4QkErREMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRmaWxlLmNsYXNzZXMuc21hcnRmaWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7QUFTQTs7O0dBR0c7QUFDSDtJQTBCRTs7O09BR0c7SUFDSCxZQUFhLFVBQXdDO1FBQ25ELEVBQUUsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDO1lBQzdCLElBQUksQ0FBQyxhQUFhLEdBQUcsVUFBVSxDQUFDLGFBQWEsQ0FBQTtZQUM3QyxJQUFJLENBQUMsUUFBUSxHQUFHLFVBQVUsQ0FBQyxhQUFhLENBQUE7UUFDMUMsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztZQUNwQyxJQUFJLENBQUMsYUFBYSxHQUFHLFVBQVUsQ0FBQyxhQUFhLENBQUE7WUFDN0MsSUFBSSxDQUFDLFFBQVEsR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxhQUFhLENBQUMsQ0FBQTtRQUN2RCxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDTixPQUFPLENBQUMsR0FBRyxDQUFDLDBCQUEwQixDQUFDLENBQUE7UUFDekMsQ0FBQztRQUNELElBQUksQ0FBQyxJQUFJLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQTtRQUMzQixJQUFJLENBQUMsR0FBRyxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUE7SUFDM0IsQ0FBQztJQUVEOzs7T0FHRztJQUNILElBQUksUUFBUTtRQUNWLE1BQU0sQ0FBQyxFQUFFLENBQUE7SUFDWCxDQUFDO0lBR0Q7OztPQUdHO0lBQ0gscUJBQXFCLENBQUMsYUFBcUI7UUFDekMsSUFBSSxDQUFDLFFBQVEsR0FBRyxJQUFJLE1BQU0sQ0FBQyxhQUFhLENBQUMsQ0FBQTtJQUMzQyxDQUFDO0lBRUQ7O09BRUc7SUFDRyxLQUFLOztRQUVYLENBQUM7S0FBQTtJQUVEOztPQUVHO0lBQ0csSUFBSTs7UUFDVixDQUFDO0tBQUE7Q0FDRjtBQXpFRCw4QkF5RUMifQ==
--- a/dist/smartfile.fs.js
+++ b/dist/smartfile.fs.js
--- a/docs/index.md
+++ b/docs/index.md
@ -0,0 +1,38 @@
+# smartfile
+make files easily accessible for processing in javascript.
+
+## Availabililty
+[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartfile)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartfile)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartfile)
+[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartfile/)
+
+## Status for master
+[![build status](https://gitlab.com/pushrocks/smartfile/badges/master/build.svg)](https://gitlab.com/pushrocks/smartfile/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartfile/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartfile/commits/master)
+[![Dependency Status](https://david-dm.org/pushrocks/smartfile.svg)](https://david-dm.org/pushrocks/smartfile)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfile/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/smartfile/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartfile)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
+## Usage
+smartfile is an approach of being one tool to handle files in diverse environments.
+
+### Smartfile Sections
+smartfile thinks in sections:
+
+section | description
+--- | ---
+fs | (object) gets data from fs to somewhere
+memory | gets data from memory to somewhere
+remote | gets data from remote locations to somewhere
+interpreter | (object) handles yaml and json
+smartfile | (class) a virtual representation of a file, alternative to vinyl file format
+
+For further information read the linked docs at the top of this README.
+
+> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+
+[![npm](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
  "name": "smartfile",
-  "version": "4.2.0",
+  "version": "4.2.3",
  "description": "offers smart ways to work with files in nodejs",
  "main": "dist/index.js",
  "typings": "dist/index.d.ts",
--- a/ts/smartfile.classes.smartfile.ts
+++ b/ts/smartfile.classes.smartfile.ts
@ -2,8 +2,9 @@ import * as plugins from './smartfile.plugins'

 export interface ISmartfileConstructorOptions {
  path?: string
-  contentsString?: string
+  contentString?: string
  contentBuffer?: Buffer
+  cwd?: string
 }

 /**
@ -17,10 +18,15 @@ export class Smartfile {
  path: string

  /**
-   * The contents of the file as Buffer
+   * gulp-compatibility: alias of this.contentBuffer
   */
  contents: Buffer

+  /**
+   * the content of the file as Buffer
+   */
+  contentBuffer: Buffer
+
  /**
   * The current working directory of the file
   */
@ -37,11 +43,16 @@ export class Smartfile {
   */
  constructor (optionsArg: ISmartfileConstructorOptions) {
    if (optionsArg.contentBuffer) {
+      this.contentBuffer = optionsArg.contentBuffer
      this.contents = optionsArg.contentBuffer
-    } else if (optionsArg.contentsString) {
-      this.contents = new Buffer(optionsArg.contentsString)
+    } else if (optionsArg.contentString) {
+      this.contentBuffer = optionsArg.contentBuffer
+      this.contents = Buffer.from(optionsArg.contentString)
+    } else {
+      console.log('created empty Smartfile?')
    }
    this.path = optionsArg.path
+    this.cwd = optionsArg.cwd
  }

  /**
--- a/ts/smartfile.fs.ts
+++ b/ts/smartfile.fs.ts
@ -209,13 +209,21 @@ export let toStringSync = function (filePath: string) {
 }

 export let fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string) => {
-  let fileTree = await listFileTree(dirPathArg, miniMatchFilter)
+  // handle absolute miniMatchFilter
+  let dirPath: string
+  if (plugins.path.isAbsolute(miniMatchFilter)) {
+    dirPath = '/'
+  } else {
+    dirPath = dirPathArg
+  }
+
+  let fileTree = await listFileTree(dirPath, miniMatchFilter)
  let smartfileArray: Smartfile[] = []
  for (let filePath of fileTree) {
    smartfileArray.push(new Smartfile({
      path: filePath,
      contentBuffer: new Buffer(toStringSync(
-        plugins.path.join(dirPathArg, filePath)
+        plugins.path.join(dirPath, filePath)
      ))
    }))
  }
--- a/yarn.lock
+++ b/yarn.lock
@ -16,8 +16,8 @@
    "@types/chai" "*"

 "@types/chai@*", "@types/chai@^3.4.35":
-  version "3.5.1"
-  resolved "https://registry.yarnpkg.com/@types/chai/-/chai-3.5.1.tgz#9bd77fe12503ae00648b0945b38eab666adffe2e"
+  version "3.5.2"
+  resolved "https://registry.yarnpkg.com/@types/chai/-/chai-3.5.2.tgz#c11cd2817d3a401b7ba0f5a420f35c56139b1c1e"

 "@types/fs-extra@2.x.x":
  version "2.1.0"
@ -33,11 +33,7 @@
  version "0.0.27"
  resolved "https://registry.yarnpkg.com/@types/promises-a-plus/-/promises-a-plus-0.0.27.tgz#c64651134614c84b8f5d7114ce8901d36a609780"

-"@types/q@0.0.32":
-  version "0.0.32"
-  resolved "https://registry.yarnpkg.com/@types/q/-/q-0.0.32.tgz#bd284e57c84f1325da702babfc82a5328190c0c5"
-
-"@types/through2@^2.0.31":
+"@types/through2@^2.0.32":
  version "2.0.32"
  resolved "https://registry.yarnpkg.com/@types/through2/-/through2-2.0.32.tgz#470024450f1ab7640f19f9ebf42d3da574c26129"
  dependencies:
@ -191,14 +187,13 @@ graceful-fs@^4.1.2, graceful-fs@^4.1.6:
  resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"

 gulp-function@^2.2.3:
-  version "2.2.3"
-  resolved "https://registry.yarnpkg.com/gulp-function/-/gulp-function-2.2.3.tgz#8f62de74ce74de3fa91c48ba247472c1f56873bd"
+  version "2.2.6"
+  resolved "https://registry.yarnpkg.com/gulp-function/-/gulp-function-2.2.6.tgz#e14c1eefdab4d4ac11d9f4abfdbe94115a12d10d"
  dependencies:
-    "@types/q" "0.0.32"
-    "@types/through2" "^2.0.31"
-    q "^1.4.1"
-    through2 "^2.0.1"
-    typings-global "^1.0.14"
+    "@types/through2" "^2.0.32"
+    smartq "^1.1.1"
+    through2 "^2.0.3"
+    typings-global "^1.0.16"

 home@^1.0.1:
  version "1.0.1"
@ -310,10 +305,6 @@ process-nextick-args@^1.0.6, process-nextick-args@~1.0.6:
  version "1.0.7"
  resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-1.0.7.tgz#150e20b756590ad3f91093f25a4f2ad8bff30ba3"

-q@^1.4.1:
-  version "1.5.0"
-  resolved "https://registry.yarnpkg.com/q/-/q-1.5.0.tgz#dd01bac9d06d30e6f219aecb8253ee9ebdc308f1"
-
 readable-stream@^2.0.2, readable-stream@^2.1.5:
  version "2.2.9"
  resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.2.9.tgz#cf78ec6f4a6d1eb43d26488cac97f042e74b7fc8"
@ -440,7 +431,7 @@ tapbundle@^1.0.10:
    smartq "^1.1.1"
    typings-global "^1.0.16"

-through2@^2.0.1:
+through2@^2.0.1, through2@^2.0.3:
  version "2.0.3"
  resolved "https://registry.yarnpkg.com/through2/-/through2-2.0.3.tgz#0004569b37c7c74ba39c43f3ced78d1ad94140be"
  dependencies:
Author	SHA1	Message	Date
Phil Kunz	9d02fccc01	4.2.3	2017-04-30 15:37:36 +02:00
Phil Kunz	a5b24a7c33	update fileTreeToObject method	2017-04-30 15:37:34 +02:00
Phil Kunz	06fb0acd52	4.2.2	2017-04-30 15:12:37 +02:00
Phil Kunz	97bf5ff74b	improve creation of Smartfiles	2017-04-30 15:12:35 +02:00
Phil Kunz	531f169c11	update yarn lock	2017-04-29 23:07:13 +02:00
Phil Kunz	e25675cc49	4.2.1	2017-04-29 17:20:15 +02:00
Phil Kunz	32cdac5b38	fix Smartfile class	2017-04-29 17:20:09 +02:00
Phil Kunz	7457093476	update docs	2017-04-29 16:57:23 +02:00