7.0.12

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,24 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +44,40 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -85,30 +91,31 @@ codequality:
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -116,5 +123,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -9,6 +9,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pushrocks/smartfile",
   "private": false,
-  "version": "7.0.6",
+  "version": "7.0.12",
   "description": "offers smart ways to work with files in nodejs",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
     "reinstall": "(rm -r node_modules && npm install)",
@@ -28,32 +28,34 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartfile",
   "dependencies": {
-    "@pushrocks/smarthash": "^2.0.6",
+    "@pushrocks/smarthash": "^2.1.6",
+    "@pushrocks/smartmime": "^1.0.3",
     "@pushrocks/smartpath": "^4.0.1",
-    "@pushrocks/smartpromise": "^3.0.5",
-    "@pushrocks/smartrequest": "^1.1.27",
-    "@types/fs-extra": "^8.0.0",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrequest": "^1.1.47",
+    "@types/fs-extra": "^8.1.0",
     "fs-extra": "^8.1.0",
-    "glob": "^7.1.4",
+    "glob": "^7.1.6",
     "js-yaml": "^3.13.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.22",
     "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^13.9.1",
     "gulp-function": "^2.2.14",
-    "tslint": "^5.20.0",
+    "tslint": "^6.1.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -8,7 +8,7 @@ smart ways to work with files in nodejs
 * [docs (typedoc)](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)
+[![pipeline status](https://gitlab.com/pushrocks/smartfile/badges/master/pipeline.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)
 [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartfile.svg)](https://www.npmjs.com/package/@pushrocks/smartfile)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartfile/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartfile)
@@ -32,6 +32,10 @@ smartfile thinks in sections:
 | interpreter | (object) handles yaml and json                                               |
 | smartfile   | (class) a virtual representation of a file, alternative to vinyl file format |
 
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

ts/smartfile.fs.ts

@@ -192,14 +192,17 @@ export const toObjectSync = (filePathArg, fileTypeArg?) => {
 
 /**
  * reads a file content to a String
- * @param filePath
- * @returns {string|Buffer|any}
  */
 export const toStringSync = (filePath: string): string => {
-  const fileString: string = plugins.fsExtra.readFileSync(filePath, 'utf8');
+  const encoding = plugins.smartmime.getEncoding(filePath);
+  const fileString: string = plugins.fsExtra.readFileSync(filePath, encoding);
   return fileString;
 };
 
+export const toBufferSync = (filePath: string): Buffer => {
+  return plugins.fsExtra.readFileSync(filePath);
+};
+
 export const fileTreeToHash = async (dirPathArg: string, miniMatchFilter: string) => {
   const fileTreeObject = await fileTreeToObject(dirPathArg, miniMatchFilter);
   let combinedString = '';

ts/smartfile.memory.ts

@@ -25,11 +25,11 @@ export interface IToFsOptions {
  * @param fileBaseArg
  */
 export let toFs = async (
-  fileContentArg: string | Smartfile,
-  filePathArg,
+  fileContentArg: string | Buffer | Smartfile,
+  filePathArg: string,
   optionsArg: IToFsOptions = {}
 ) => {
-  let done = plugins.smartpromise.defer();
+  const done = plugins.smartpromise.defer();
 
   // check args
   if (!fileContentArg || !filePathArg) {
@@ -38,23 +38,26 @@ export let toFs = async (
 
   // prepare actual write action
   let fileString: string;
+  let fileEncoding: string = 'utf8';
   let filePath: string = filePathArg;
 
   // handle Smartfile
   if (fileContentArg instanceof Smartfile) {
-    let fileContentArg2: any = fileContentArg;
     fileString = fileContentArg.contentBuffer.toString();
     // handle options
     if (optionsArg.respectRelative) {
       filePath = plugins.path.join(filePath, fileContentArg.path);
     }
+  } else if (Buffer.isBuffer(fileContentArg)) {
+    fileString = fileContentArg.toString('binary');
+    fileEncoding = 'binary';
   } else if (typeof fileContentArg === 'string') {
     fileString = fileContentArg;
   } else {
     throw new Error('fileContent is neither string nor Smartfile');
   }
   await smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
-  plugins.fsExtra.writeFile(filePath, fileString, { encoding: 'utf8' }, done.resolve);
+  plugins.fsExtra.writeFile(filePath, fileString, { encoding: fileEncoding }, done.resolve);
   return await done.promise;
 };
 

ts/smartfile.plugins.ts

@@ -6,11 +6,12 @@ export { fs, path };
 
 // @pushrocks scope
 import * as smarthash from '@pushrocks/smarthash';
+import * as smartmime from '@pushrocks/smartmime';
 import * as smartpath from '@pushrocks/smartpath';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 
-export { smarthash, smartpath, smartpromise, smartrequest };
+export { smarthash, smartmime, smartpath, smartpromise, smartrequest };
 
 // third party scope
 import * as fsExtra from 'fs-extra';

ts/smartfile.remote.ts

@@ -15,8 +15,8 @@ import SmartfileInterpreter = require('./smartfile.interpreter');
  * @param fromArg
  * @returns {any}
  */
-export let toObject = function(fromArg: string) {
-  let done = plugins.smartpromise.defer();
+export let toObject = (fromArg: string) => {
+  const done = plugins.smartpromise.defer();
   plugins.smartrequest
     .request(fromArg, {
       method: 'get'
@@ -37,11 +37,12 @@ export let toObject = function(fromArg: string) {
  * @param fromArg
  * @returns {any}
  */
-export let toString = (fromArg: string) => {
-  let done = plugins.smartpromise.defer();
+export let toString = (fromArg: string): Promise<string> => {
+  const done = plugins.smartpromise.defer<string>();
   plugins.smartrequest.getBinary(fromArg).then((res: any) => {
     if (res.statusCode === 200) {
-      done.resolve(res.body);
+      const encoding = plugins.smartmime.getEncoding(fromArg);
+      done.resolve(res.body.toString(encoding));
     } else {
       done.reject(new Error('could not get remote file from ' + fromArg));
     }