7.0.2

.gitlab-ci.yml

@@ -37,18 +37,6 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test

.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.1
+ignore: {}
+patch: {}

README.md

@@ -1,24 +1,20 @@
 # @pushrocks/smartfile
+smart ways to work with files in nodejs
 
-make files easily accessible for processing in javascript.
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartfile)
-## Availabililty
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartfile)
-
+* [github.com (source mirror)](https://github.com/pushrocks/smartfile)
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartfile)
+* [docs (typedoc)](https://pushrocks.gitlab.io/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)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartfile.svg)](https://www.npmjs.com/package/@pushrocks/smartfile)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfile/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartfile/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartfile)
-[![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->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![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->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.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-prettier-ff69b4.svg)](https://prettier.io/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
 
@@ -36,8 +32,9 @@ smartfile thinks in sections:
 | 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.
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![npm](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -3,11 +3,19 @@
     "mode": "default",
     "coverageTreshold": 70
   },
-  "npmdocker":{
+  "npmdocker": {},
-    
-  },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartfile",
+      "shortDescription": "smart ways to work with files in nodejs",
+      "npmPackagename": "@pushrocks/smartfile",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartfile",
   "private": false,
-  "version": "6.0.9",
+  "version": "7.0.2",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -29,23 +29,23 @@
   "homepage": "https://gitlab.com/pushrocks/smartfile",
   "dependencies": {
     "@pushrocks/smartpath": "^4.0.1",
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartpromise": "^3.0.2",
     "@pushrocks/smartrequest": "^1.1.14",
-    "@types/fs-extra": "^5.0.4",
+    "@types/fs-extra": "^5.0.5",
     "@types/vinyl": "^2.0.2",
     "fs-extra": "^7.0.1",
     "glob": "^7.1.3",
-    "js-yaml": "^3.10.0",
+    "js-yaml": "^3.13.1",
     "vinyl-file": "^3.0.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.8",
-    "@gitzone/tsrun": "^1.1.13",
+    "@gitzone/tsrun": "^1.2.1",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.18",
     "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.10",
+    "@types/node": "^11.13.0",
     "gulp-function": "^2.2.14",
-    "tslint": "^5.11.0",
+    "tslint": "^5.15.0",
-    "tslint-config-prettier": "^1.16.0"
+    "tslint-config-prettier": "^1.18.0"
   }
 }

ts/smartfile.classes.smartfile.ts

@@ -14,6 +14,27 @@ export interface ISmartfileConstructorOptions {
  * -> is vinyl file compatible
  */
 export class Smartfile {
+  // ======
+  // STATIC
+  // ======
+
+  /**
+   * creates a Smartfile from a filePath
+   * @param filePath
+   */
+  public static async fromFilePath(filePath: string) {
+    filePath = plugins.path.resolve(filePath);
+    const fileString = fs.toStringSync(filePath);
+    const smartfile = new Smartfile({
+      path: filePath,
+      contentString: fileString
+    });
+    return smartfile;
+  }
+
+  // ========
+  // INSTANCE
+  // ========
   /**
    * the full path of the file on disk
    */

ts/smartfile.fs.ts

@@ -29,10 +29,10 @@ export let fileExistsSync = function(filePath): boolean {
  * @param filePath
  * @returns {any}
  */
-export let fileExists = function(filePath) {
+export let fileExists = (filePath): Promise<boolean> => {
-  let done = plugins.smartpromise.defer();
+  const done = plugins.smartpromise.defer<boolean>();
-  plugins.fs.access(filePath, 4, function(err) {
+  plugins.fs.access(filePath, 4, err => {
-    err ? done.reject(err) : done.resolve();
+    err ? done.resolve(false) : done.resolve(true);
   });
   return done.promise;
 };
@@ -40,7 +40,7 @@ export let fileExists = function(filePath) {
 /**
  * Checks if given path points to an existing directory
  */
-export let isDirectory = function(pathArg): boolean {
+export let isDirectory = (pathArg): boolean => {
   try {
     return plugins.fsExtra.statSync(pathArg).isDirectory();
   } catch (err) {
@@ -194,7 +194,7 @@ export let removeManySync = function(filePathArrayArg: string[]): void {
  * @returns {any}
  */
 export let toObjectSync = function(filePathArg, fileTypeArg?) {
-  let fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
+  const fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
   let fileType;
   fileTypeArg ? (fileType = fileTypeArg) : (fileType = SmartfileInterpreter.filetype(filePathArg));
   return SmartfileInterpreter.objectFile(fileString, fileType);
@@ -206,7 +206,7 @@ export let toObjectSync = function(filePathArg, fileTypeArg?) {
  * @returns {string|Buffer|any}
  */
 export let toStringSync = function(filePath: string): string {
-  let fileString: any = plugins.fsExtra.readFileSync(filePath, 'utf8');
+  const fileString: string = plugins.fsExtra.readFileSync(filePath, 'utf8');
   return fileString;
 };
 
@@ -257,26 +257,16 @@ export let toVinylSync = function(filePathArg, options = {}) {
  * lists Folders in a directory on local disk
  * @returns Promise with an array that contains the folder names
  */
-export let listFolders = function(pathArg: string, regexFilter?: RegExp): Promise<string[]> {
+export let listFolders = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
-  let done = plugins.smartpromise.defer<string[]>();
+  return listFoldersSync(pathArg, regexFilter);
-  let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
-    return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory();
-  });
-  if (regexFilter) {
-    folderArray = folderArray.filter(fileItem => {
-      return regexFilter.test(fileItem);
-    });
-  }
-  done.resolve(folderArray);
-  return done.promise;
 };
 
 /**
  * lists Folders SYNCHRONOUSLY in a directory on local disk
  * @returns an array with the folder names as strings
  */
-export let listFoldersSync = function(pathArg: string, regexFilter?: RegExp): string[] {
+export let listFoldersSync = (pathArg: string, regexFilter?: RegExp): string[] => {
-  let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
+  let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(file => {
     return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory();
   });
   if (regexFilter) {
@@ -291,26 +281,16 @@ export let listFoldersSync = function(pathArg: string, regexFilter?: RegExp): st
  * lists Files in a directory on local disk
  * @returns Promise
  */
-export let listFiles = function(pathArg: string, regexFilter?: RegExp) {
+export let listFiles = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
-  let done = plugins.smartpromise.defer();
+  return listFilesSync(pathArg, regexFilter);
-  let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
-    return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
-  });
-  if (regexFilter) {
-    fileArray = fileArray.filter(fileItem => {
-      return regexFilter.test(fileItem);
-    });
-  }
-  done.resolve(fileArray);
-  return done.promise;
 };
 
 /**
  * lists Files SYNCHRONOUSLY in a directory on local disk
  * @returns an array with the folder names as strings
  */
-export let listFilesSync = function(pathArg: string, regexFilter?: RegExp): string[] {
+export let listFilesSync = (pathArg: string, regexFilter?: RegExp): string[] => {
-  let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
+  let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(file => {
     return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
   });
   if (regexFilter) {
@@ -325,16 +305,8 @@ export let listFilesSync = function(pathArg: string, regexFilter?: RegExp): stri
  * lists all items (folders AND files) in a directory on local disk
  * @returns Promise<string[]>
  */
-export let listAllItems = function(pathArg: string, regexFilter?: RegExp): Promise<string[]> {
+export let listAllItems = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
-  let done = plugins.smartpromise.defer<string[]>();
+  return listAllItemsSync(pathArg, regexFilter);
-  let allItmesArray = plugins.fsExtra.readdirSync(pathArg);
-  if (regexFilter) {
-    allItmesArray = allItmesArray.filter(fileItem => {
-      return regexFilter.test(fileItem);
-    });
-  }
-  done.resolve(allItmesArray);
-  return done.promise;
 };
 
 /**
@@ -342,7 +314,7 @@ export let listAllItems = function(pathArg: string, regexFilter?: RegExp): Promi
  * @returns an array with the folder names as strings
  * @executes SYNC
  */
-export let listAllItemsSync = function(pathArg: string, regexFilter?: RegExp): string[] {
+export let listAllItemsSync = (pathArg: string, regexFilter?: RegExp): string[] => {
   let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
     return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
   });
@@ -360,7 +332,7 @@ export let listAllItemsSync = function(pathArg: string, regexFilter?: RegExp): s
  * @returns Promise<string[]> string array with the absolute paths of all matching files
  */
 export let listFileTree = (dirPathArg: string, miniMatchFilter: string): Promise<string[]> => {
-  let done = plugins.smartpromise.defer<string[]>();
+  const done = plugins.smartpromise.defer<string[]>();
 
   // handle absolute miniMatchFilter
   let dirPath: string;
@@ -370,7 +342,7 @@ export let listFileTree = (dirPathArg: string, miniMatchFilter: string): Promise
     dirPath = dirPathArg;
   }
 
-  let options = {
+  const options = {
     cwd: dirPath,
     nodir: true,
     dot: true