7.0.0

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -39,6 +40,7 @@ snyk:
 testLEGACY:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install legacy
   - npmci npm install
   - npmci npm test
@@ -51,6 +53,7 @@ testLEGACY:
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +65,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -117,8 +121,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
-    - npmci command npmpage
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
     - notpriv
@@ -129,13 +135,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

.snyk

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

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartfile",
   "private": false,
-  "version": "6.0.6",
+  "version": "7.0.0",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -30,20 +30,22 @@
   "dependencies": {
     "@pushrocks/smartpath": "^4.0.1",
     "@pushrocks/smartpromise": "^2.0.5",
-    "@pushrocks/smartrequest": "^1.1.12",
-    "@types/fs-extra": "^5.0.4",
+    "@pushrocks/smartrequest": "^1.1.14",
+    "@types/fs-extra": "^5.0.5",
     "@types/vinyl": "^2.0.2",
-    "fs-extra": "^7.0.0",
-    "glob": "^7.1.2",
-    "js-yaml": "^3.10.0",
+    "fs-extra": "^7.0.1",
+    "glob": "^7.1.3",
+    "js-yaml": "^3.12.1",
     "vinyl-file": "^3.0.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.21",
-    "@gitzone/tsrun": "^1.1.9",
-    "@gitzone/tstest": "^1.0.12",
-    "@types/node": "^10.5.7",
+    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tstest": "^1.0.18",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^11.9.4",
     "gulp-function": "^2.2.14",
-    "tapbundle": "^2.0.2"
+    "tslint": "^5.12.1",
+    "tslint-config-prettier": "^1.18.0"
   }
 }

test/test.ts

@@ -1,7 +1,7 @@
 import * as smartfile from '../ts/index';
 import path = require('path');
 
-import { expect, tap } from 'tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 
 // ---------------------------
 // smartfile.fs

ts/smartfile.classes.smartfile.ts

@@ -14,6 +14,28 @@ 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) {
-  let done = plugins.smartpromise.defer();
-  plugins.fs.access(filePath, 4, function(err) {
-    err ? done.reject(err) : done.resolve();
+export let fileExists = (filePath): Promise<boolean> => {
+  const done = plugins.smartpromise.defer<boolean>();
+  plugins.fs.access(filePath, 4, err => {
+    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;
 };
 
@@ -255,28 +255,18 @@ export let toVinylSync = function(filePathArg, options = {}) {
 
 /**
  * lists Folders in a directory on local disk
- * @returns Promise
+ * @returns Promise with an array that contains the folder names
  */
-export let listFolders = function(pathArg: string, regexFilter?: RegExp) {
-  let done = plugins.smartpromise.defer();
-  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;
+export let listFolders = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
+  return listFoldersSync(pathArg, regexFilter);
 };
 
 /**
  * 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[] {
-  let folderArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
+export let listFoldersSync = (pathArg: string, regexFilter?: RegExp): string[] => {
+  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) {
-  let done = plugins.smartpromise.defer();
-  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;
+export let listFiles = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
+  return listFilesSync(pathArg, regexFilter);
 };
 
 /**
  * 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[] {
-  let fileArray = plugins.fsExtra.readdirSync(pathArg).filter(function(file) {
+export let listFilesSync = (pathArg: string, regexFilter?: RegExp): string[] => {
+  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[]> {
-  let done = plugins.smartpromise.defer<string[]>();
-  let allItmesArray = plugins.fsExtra.readdirSync(pathArg);
-  if (regexFilter) {
-    allItmesArray = allItmesArray.filter(fileItem => {
-      return regexFilter.test(fileItem);
-    });
-  }
-  done.resolve(allItmesArray);
-  return done.promise;
+export let listAllItems = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
+  return listAllItemsSync(pathArg, regexFilter);
 };
 
 /**
@@ -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

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }