10.0.14

.gitea/workflows/gitzone_ci_default.yaml

@@ -0,0 +1,108 @@
+name: CI Pipeline
+
+on: push
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+jobs:
+
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+    outputs:
+      dummy: ${{ true }}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install pnpm and npmci
+      run: |
+        pnpm install -g pnpm
+        pnpm install -g @shipzone/npmci
+
+    - name: Run npm prepare
+      run: npmci npm prepare
+
+    - name: Audit production dependencies
+      run: |
+        npmci command npm config set registry https://registry.npmjs.org
+        npmci command pnpm audit --audit-level=high --prod
+      continue-on-error: true
+
+    - name: Audit development dependencies
+      run: |
+        npmci command npm config set registry https://registry.npmjs.org
+        npmci command pnpm audit --audit-level=high --dev
+      continue-on-error: true
+
+  test:
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Test stable
+      run: |
+        npmci node install stable
+        npmci npm install
+        npmci npm test
+
+    - name: Test build
+      run: |
+        npmci node install stable
+        npmci npm install
+        npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Release
+      run: |
+        npmci node install stable
+        npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Code quality
+      run: |
+        npmci command npm install -g typescript
+        npmci npm prepare
+        npmci npm install
+
+    - name: Trigger
+      run: npmci trigger
+
+    - name: Build docs and upload artifacts
+      run: |
+        npmci node install stable
+        npmci npm install
+        npmci command npm run buildDocs
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: public
+        path: public
+        retention-days: 7

.gitlab-ci.yml

@@ -13,31 +13,24 @@ stages:
   - metadata
 
 before_script:
-  - npm install -g @shipzone/npmci
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
 
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
-  stage: security
+# security stage
-  script:
+# ====================
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
+     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm install --production --ignore-scripts
+     - npmci command pnpm audit --audit-level=high --prod
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -45,11 +38,10 @@ auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -60,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -71,10 +62,9 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
-    - npmci command npm run build
+    - npmci npm build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -100,10 +90,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -123,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
+    - npmci node install stable
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

package.json

@@ -1,14 +1,15 @@
 {
   "name": "@pushrocks/smartfile",
   "private": false,
-  "version": "10.0.2",
+  "version": "10.0.14",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web --allowimplicitany)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -25,31 +26,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartfile",
   "dependencies": {
-    "@pushrocks/lik": "^6.0.0",
+    "@pushrocks/lik": "^6.0.2",
-    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartdelay": "^3.0.1",
     "@pushrocks/smartfile-interfaces": "^1.0.7",
-    "@pushrocks/smarthash": "^2.1.10",
+    "@pushrocks/smarthash": "^3.0.2",
-    "@pushrocks/smartjson": "^4.0.6",
+    "@pushrocks/smartjson": "^5.0.6",
     "@pushrocks/smartmime": "^1.0.5",
     "@pushrocks/smartpath": "^5.0.5",
-    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartpromise": "^4.0.2",
-    "@pushrocks/smartrequest": "^1.1.56",
+    "@pushrocks/smartrequest": "^2.0.15",
     "@pushrocks/smartstream": "^2.0.3",
     "@pushrocks/streamfunction": "^4.0.4",
-    "@types/fs-extra": "^9.0.13",
+    "@types/fs-extra": "^11.0.1",
-    "@types/glob": "^7.2.0",
+    "@types/glob": "^8.1.0",
     "@types/js-yaml": "^4.0.5",
-    "fs-extra": "^10.1.0",
+    "fs-extra": "^11.1.1",
-    "glob": "^8.0.3",
+    "glob": "^10.3.0",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.35",
+    "@gitzone/tsrun": "^1.2.42",
-    "@gitzone/tstest": "^1.0.71",
+    "@gitzone/tstest": "^1.0.74",
-    "@pushrocks/tapbundle": "^5.0.3",
+    "@pushrocks/tapbundle": "^5.0.8",
-    "@types/node": "^17.0.41",
+    "@types/node": "^20.3.1"
-    "gulp-function": "^2.2.14"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -21,7 +21,6 @@ Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](htt
 PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartfile)](https://lossless.cloud)
 PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartfile)](https://lossless.cloud)
 BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartfile)](https://lossless.cloud)
-Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
@@ -45,7 +44,6 @@ We are always happy for code contributions. If you are not the code contributing
 
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -38,9 +38,7 @@ tap.test('.fs.listFolders() -> should get the file type from a string', async ()
 tap.test('.fs.listFilesSync() -> should get the file type from a string', async () => {
   expect(smartfile.fs.listFilesSync('./test/testassets/')).toContain('mytest.json');
   expect(smartfile.fs.listFilesSync('./test/testassets/')).not.toContain('notExistentFile');
-  expect(smartfile.fs.listFilesSync('./test/testassets/', /mytest\.json/)).toContain(
+  expect(smartfile.fs.listFilesSync('./test/testassets/', /mytest\.json/)).toContain('mytest.json');
-    'mytest.json'
-  );
   expect(smartfile.fs.listFilesSync('./test/testassets/', /mytests.json/)).not.toContain(
     'mytest.json'
   );
@@ -133,9 +131,7 @@ tap.test('.fs.toObjectSync() -> should read an .json file to an object', async (
 });
 
 tap.test('.fs.toStringSync() -> should read a file to a string', async () => {
-  expect(smartfile.fs.toStringSync('./test/testassets/mytest.txt')).toEqual(
+  expect(smartfile.fs.toStringSync('./test/testassets/mytest.txt')).toEqual('Some TestString &&%$');
-    'Some TestString &&%$'
-  );
 });
 
 // ---------------------------
@@ -213,6 +209,14 @@ tap.test('should create, store and retrieve valid smartfiles', async () => {
   expect(retrievedString).toEqual(fileString);
 });
 
+tap.test('should get a hash', async () => {
+  const fileString = 'hi there';
+  const filePath = './test/testassets/utf8.txt';
+  const smartfileInstance = await smartfile.Smartfile.fromString(filePath, fileString, 'utf8');
+  const hash = await smartfileInstance.getHash();
+  console.log(hash);
+});
+
 tap.test('should wait for file to be ready', async () => {
   await smartfile.fs.waitForFileToBeReady('./test/testassets/mytest.json');
 });

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@pushrocks/smartfile',
-  version: '10.0.2',
+  version: '10.0.14',
   description: 'offers smart ways to work with files in nodejs'
 }

ts/smartfile.classes.smartfile.ts

@@ -237,9 +237,29 @@ export class Smartfile extends plugins.smartjson.Smartjson {
     return false;
   }
 
+  public async getHash(typeArg: 'path' | 'content' | 'all' = 'all') {
+    const pathHash = await plugins.smarthash.sha256FromString(this.path);
+    const contentHash = await plugins.smarthash.sha256FromBuffer(this.contentBuffer);
+    const combinedHash = await plugins.smarthash.sha256FromString(pathHash + contentHash);
+    switch (typeArg) {
+      case 'path':
+        return pathHash;
+      case 'content':
+        return contentHash;
+      case 'all':
+      default:
+        return combinedHash;
+    }
+  }
+
   // update things
   public updateFileName(fileNameArg: string) {
     const oldFileName = this.parsedPath.base;
     this.path = this.path.replace(new RegExp(oldFileName + '$'), fileNameArg);
   }
+
+  public async editContentAsString(editFuncArg: (fileStringArg: string) => Promise<string>) {
+    const newFileString = await editFuncArg(this.contentBuffer.toString());
+    this.contentBuffer = Buffer.from(newFileString);
+  }
 }

ts/smartfile.fs.ts

@@ -214,7 +214,7 @@ export const fileTreeToHash = async (dirPathArg: string, miniMatchFilter: string
   const fileTreeObject = await fileTreeToObject(dirPathArg, miniMatchFilter);
   let combinedString = '';
   for (const smartfile of fileTreeObject) {
-    combinedString += smartfile.contentBuffer.toString();
+    combinedString += await smartfile.getHash();
   }
   const hash = await plugins.smarthash.sha256FromString(combinedString);
   return hash;
@@ -341,8 +341,6 @@ export const listFileTree = async (
   miniMatchFilter: string,
   absolutePathsBool: boolean = false
 ): Promise<string[]> => {
-  const done = plugins.smartpromise.defer<string[]>();
-
   // handle absolute miniMatchFilter
   let dirPath: string;
   if (plugins.path.isAbsolute(miniMatchFilter)) {
@@ -356,15 +354,8 @@ export const listFileTree = async (
     nodir: true,
     dot: true,
   };
-  plugins.glob(miniMatchFilter, options, (err, files: string[]) => {
-    if (err) {
-      console.log(err);
-      done.reject(err);
-    }
-    done.resolve(files);
-  });
 
-  let fileList = await done.promise;
+  let fileList = await plugins.glob.glob(miniMatchFilter, options);
   if (absolutePathsBool) {
     fileList = fileList.map((filePath) => {
       return plugins.path.resolve(plugins.path.join(dirPath, filePath));

ts/smartfile.fsstream.ts

@@ -11,7 +11,4 @@ export const createWriteStream = (pathArg: string) => {
   return plugins.fs.createWriteStream(pathArg);
 };
 
-
+export const streamDirectory = async (dirPathArg: string) => {};
-export const streamDirectory = async (dirPathArg: string) => {
-  
-}

ts/smartfile.plugins.ts

@@ -26,12 +26,12 @@ export {
   smartpath,
   smartpromise,
   smartrequest,
-  smartstream
+  smartstream,
 };
 
 // third party scope
 import fsExtra from 'fs-extra';
-import glob from 'glob';
+import * as glob from 'glob';
 import yaml from 'js-yaml';
 
 export { fsExtra, glob, yaml };

tsconfig.json

@@ -1,8 +1,11 @@
 {
   "compilerOptions": {
     "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
     "esModuleInterop": true,
-    "target": "ES2017",
+    "verbatimModuleSyntax": true,
-    "moduleResolution": "node"
   }
-}
+}