10.0.36

.gitea/workflows/default_nottags.yaml

@@ -7,14 +7,13 @@ on:
 
 env:
   IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
   NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
   NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
   NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
   NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
 
-
 jobs:
-
   security:
     runs-on: ubuntu-latest
     continue-on-error: true

.gitea/workflows/default_tags.yaml

@@ -7,14 +7,13 @@ on:
 
 env:
   IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
   NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
   NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
   NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
   NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
 
-
 jobs:
-
   security:
     runs-on: ubuntu-latest
     continue-on-error: true
@@ -24,13 +23,11 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-    - name: Install pnpm and npmci
+      - name: Prepare
         run: |
           pnpm install -g pnpm
           pnpm install -g @shipzone/npmci
-
+          npmci npm prepare
-    - name: Run npm prepare
-      run: npmci npm prepare
 
       - name: Audit production dependencies
         run: |
@@ -54,6 +51,12 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
       - name: Test stable
         run: |
           npmci node install stable
@@ -76,6 +79,12 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
       - name: Release
         run: |
           npmci node install stable
@@ -92,19 +101,24 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
       - name: Code quality
         run: |
           npmci command npm install -g typescript
-        npmci npm prepare
           npmci npm install
 
       - name: Trigger
         run: npmci trigger
 
-    - name: Build docs
+      - name: Build docs and upload artifacts
         run: |
           npmci node install stable
           npmci npm install
-        pnpm install -g @gitzone/tsdoc
+          pnpm install -g @git.zone/tsdoc
           npmci command tsdoc
         continue-on-error: true

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@push.rocks/smartfile",
   "private": false,
-  "version": "10.0.29",
+  "version": "10.0.36",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -13,7 +13,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://gitlab.com/pushrocks/smartfile.git"
+    "url": "git+https://gitlab.com/push.rocks/smartfile.git"
   },
   "keywords": [
     "filesystem",
@@ -22,33 +22,33 @@
   "author": "Lossless GmbH <hello@lossless.com> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/smartfile/issues"
+    "url": "https://gitlab.com/push.rocks/smartfile/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartfile",
+  "homepage": "https://gitlab.com/push.rocks/smartfile#readme",
   "dependencies": {
-    "@push.rocks/lik": "^6.0.2",
+    "@push.rocks/lik": "^6.0.5",
-    "@push.rocks/smartdelay": "^3.0.1",
+    "@push.rocks/smartdelay": "^3.0.5",
     "@push.rocks/smartfile-interfaces": "^1.0.7",
-    "@push.rocks/smarthash": "^3.0.2",
+    "@push.rocks/smarthash": "^3.0.4",
-    "@push.rocks/smartjson": "^5.0.6",
+    "@push.rocks/smartjson": "^5.0.10",
     "@push.rocks/smartmime": "^1.0.5",
-    "@push.rocks/smartpath": "^5.0.5",
+    "@push.rocks/smartpath": "^5.0.11",
     "@push.rocks/smartpromise": "^4.0.2",
-    "@push.rocks/smartrequest": "^2.0.15",
+    "@push.rocks/smartrequest": "^2.0.18",
-    "@push.rocks/smartstream": "^2.0.3",
+    "@push.rocks/smartstream": "^2.0.4",
-    "@types/fs-extra": "^11.0.1",
+    "@types/fs-extra": "^11.0.2",
     "@types/glob": "^8.1.0",
-    "@types/js-yaml": "^4.0.5",
+    "@types/js-yaml": "^4.0.6",
     "fs-extra": "^11.1.1",
-    "glob": "^10.3.3",
+    "glob": "^10.3.5",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
+    "@git.zone/tsbuild": "^2.1.70",
-    "@gitzone/tsrun": "^1.2.42",
+    "@git.zone/tsrun": "^1.2.46",
-    "@gitzone/tstest": "^1.0.74",
+    "@git.zone/tstest": "^1.0.81",
-    "@pushrocks/tapbundle": "^5.0.8",
+    "@push.rocks/tapbundle": "^5.0.15",
-    "@types/node": "^20.4.1"
+    "@types/node": "^20.6.3"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -1,26 +1,26 @@
-# @pushrocks/smartfile
+# @push.rocks/smartfile
 smart ways to work with files in nodejs
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartfile)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartfile)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartfile)
+* [gitlab.com (source)](https://gitlab.com/push.rocks/smartfile)
-* [github.com (source mirror)](https://github.com/pushrocks/smartfile)
+* [github.com (source mirror)](https://github.com/push.rocks/smartfile)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartfile/)
+* [docs (typedoc)](https://push.rocks.gitlab.io/smartfile/)
 
 ## Status for master
 
 Status Category | Status Badge
 -- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartfile/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartfile/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartfile/badges/master/coverage.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartfile/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartfile)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartfile)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartfile)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartfile)](https://lossless.cloud)
 TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
 node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
 Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartfile)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartfile)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartfile)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartfile)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartfile)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartfile)](https://lossless.cloud)
 
 ## Usage
 

test/test.ts

@@ -1,7 +1,7 @@
 import * as smartfile from '../ts/index.js';
 import * as path from 'path';
 
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 
 // ---------------------------
 // smartfile.fs

test/test.virtualdirectory.ts

@@ -1,4 +1,4 @@
-import { tap, expect } from '@pushrocks/tapbundle';
+import { tap, expect } from '@push.rocks/tapbundle';
 
 import * as smartfile from '../ts/index.js';
 

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartfile',
-  version: '10.0.29',
+  version: '10.0.36',
   description: 'offers smart ways to work with files in nodejs'
 }

ts/smartfile.classes.smartfile.ts

@@ -65,6 +65,33 @@ export class Smartfile extends plugins.smartjson.Smartjson {
     return new Smartfile(plugins.smartjson.parse(foldedJsonArg));
   }
 
+  /**
+   * creates a Smartfile from a ReadableStream
+   * @param stream a readable stream that provides file content
+   * @param filePath the file path to associate with the content
+   * @param baseArg the base path to use for the file
+   */
+  public static async fromStream(
+    stream: plugins.stream.Readable,
+    filePath: string,
+    baseArg: string = process.cwd()
+  ): Promise<Smartfile> {
+    return new Promise<Smartfile>((resolve, reject) => {
+      const chunks: Buffer[] = [];
+      stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
+      stream.on('error', (error) => reject(error));
+      stream.on('end', () => {
+        const contentBuffer = Buffer.concat(chunks);
+        const smartfile = new Smartfile({
+          contentBuffer: contentBuffer,
+          base: baseArg,
+          path: plugins.path.relative(baseArg, filePath),
+        });
+        resolve(smartfile);
+      });
+    });
+  }
+
   // ========
   // INSTANCE
   // ========
@@ -262,4 +289,14 @@ export class Smartfile extends plugins.smartjson.Smartjson {
     const newFileString = await editFuncArg(this.contentBuffer.toString());
     this.contentBuffer = Buffer.from(newFileString);
   }
+
+  /**
+   * Returns a ReadableStream from the file's content buffer
+   */
+  public getStream(): plugins.stream.Readable {
+    const stream = new plugins.stream.Readable();
+    stream.push(this.contentBuffer); // Push the content buffer to the stream
+    stream.push(null); // Push null to signify the end of the stream (EOF)
+    return stream;
+  }
 }

ts/smartfile.fs.ts

@@ -40,7 +40,18 @@ export const fileExists = async (filePath): Promise<boolean> => {
 /**
  * Checks if given path points to an existing directory
  */
-export const isDirectory = (pathArg): boolean => {
+export const isDirectory = (pathArg: string): boolean => {
+  try {
+    return plugins.fsExtra.statSync(pathArg).isDirectory();
+  } catch (err) {
+    return false;
+  }
+};
+
+/**
+ * Checks if given path points to an existing directory
+ */
+export const isDirectorySync = (pathArg: string): boolean => {
   try {
     return plugins.fsExtra.statSync(pathArg).isDirectory();
   } catch (err) {
@@ -210,6 +221,18 @@ export const toBufferSync = (filePath: string): Buffer => {
   return plugins.fsExtra.readFileSync(filePath);
 };
 
+/**
+ * Creates a Readable Stream from a file path.
+ * @param filePath The path to the file.
+ * @returns {fs.ReadStream}
+ */
+export const toReadStream = (filePath: string): plugins.fs.ReadStream => {
+  if (!fileExistsSync(filePath)) {
+    throw new Error(`File does not exist at path: ${filePath}`);
+  }
+  return plugins.fsExtra.createReadStream(filePath);
+};
+
 export const fileTreeToHash = async (dirPathArg: string, miniMatchFilter: string) => {
   const fileTreeObject = await fileTreeToObject(dirPathArg, miniMatchFilter);
   let combinedString = '';
@@ -244,12 +267,12 @@ export const fileTreeToObject = async (dirPathArg: string, miniMatchFilter: stri
         return filePath;
       }
     })();
-    const fileContentString = toStringSync(readPath);
+    const fileBuffer = plugins.fs.readFileSync(readPath);
 
     // push a read file as Smartfile
     smartfileArray.push(
       new Smartfile({
-        contentBuffer: Buffer.from(fileContentString),
+        contentBuffer: fileBuffer,
         base: dirPath,
         path: filePath,
       })