5.0.24

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+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
+    container:
+      image: ${{ env.IMAGE }}
+
+    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:
+    if: ${{ always() }}
+    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

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+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
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          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:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    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
+          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: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - 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: 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 install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @gitzone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitlab-ci.yml

@@ -1,137 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  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 install --production --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
-  tags:
-    - docker
-
-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
-  tags:
-    - docker
-  allow_failure: true
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-testBuild:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  only:
-    - tags
-  script:
-    - npmci command npm install -g tslint typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  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:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "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"
+      "type": "node-terminal"
     }
   ]
 }

changelog.md

@@ -0,0 +1,155 @@
+# Changelog
+
+## 2024-08-17 - 5.0.24 - fix(dependencies)
+Update dependencies
+
+- Updated @push.rocks/smartexpect from ^1.0.21 to ^1.1.0
+- Updated @push.rocks/smartjson from ^5.0.16 to ^5.0.20
+- Updated @push.rocks/smartpromise from ^4.0.2 to ^4.0.4
+- Updated @push.rocks/smarttime from ^4.0.6 to ^4.0.8
+- Updated @types/node from ^20.11.30 to ^22.4.0
+
+## 2024-05-29 - 5.0.23 - General Update
+update description
+
+## 2024-04-14 to 2024-04-15 - 5.0.22 - Configuration Updates and Bug Fixes
+Multiple updates in tsconfig and npmextra.json
+
+- fix(core): update
+- update tsconfig
+- update npmextra.json: githost
+
+## 2024-03-19 - 5.0.21 to 5.0.17 - Bug Fix Release
+Multiple core fixes and updates without specific feature changes
+
+- fix(core): update
+
+## 2024-03-13 - 5.0.16 - Bug Fix Release
+- fix(core): update
+
+## 2023-08-12 - 5.0.15 to 5.0.13 - Bug Fix Release
+Multiple core fixes and updates without specific feature changes
+
+- fix(core): update
+
+## 2023-07-13 - 5.0.12 to 5.0.10 - Bug Fix Release
+Multiple core fixes and updates without specific feature changes
+
+- fix(core): update
+
+## 2023-06-22 - 5.0.9 to 5.0.7 - Bug Fix Release
+Multiple core fixes and updates without specific feature changes
+
+- fix(core): update
+
+## 2022-07-24 - 5.0.6 to 5.0.3 - Bug Fix Release
+Multiple core fixes and updates without specific feature changes
+
+- fix(core): update
+
+## 2022-03-14 - 5.0.2 to 5.0.0 - Initial Release of Version 5.x.x
+Multiple bug fixes and updates.
+- fix(core): update
+
+## 2022-03-14 - 4.0.9 to 4.0.8 - Bug Fix Release
+- fix(core): update
+
+## 2022-02-28 - 4.0.7 to 4.0.4 - Bug Fix Release
+Multiple core fixes and updates without specific feature changes
+
+- fix(core): update
+
+## 2022-02-02 - 4.0.3 to 4.0.1 - Bug Fix Release
+- fix(core): update
+
+## 2022-01-21 - 4.0.0 - Major Release
+Version 4.x.x Major improvements and core fixes
+
+## 2021-12-10 - 3.2.15 - Breaking Change
+BREAKING CHANGE(core): switch to @pushrocks/smartexpect
+
+## 2021-12-10 - 3.2.14 - Bug Fix Release
+- fix(core): update
+
+## 2021-02-13 - 3.2.13 - Bug Fix Release
+- fix(core): update
+
+## 2021-01-26 - 3.2.12 to 3.2.11 - Bug Fix Release
+- fix(core): update
+
+## 2020-07-11 - 3.2.10 to 3.2.8 - Bug Fix Release
+- fix(core): update
+
+## 2020-07-08 - 3.2.7 to 3.2.4 - Bug Fix Release
+Multiple core fixes and updates without specific feature changes
+
+- fix(core): update
+
+## 2020-07-08 - 3.2.5 - Documentation Update
+- update readme
+
+## 2019-11-16 - 3.1.0 - New Feature
+- feat(pretask): introduce new pretask functionality for setting up testing environment
+
+## 2019-11-16 - 3.0.14 - New Feature
+- feat(tools): can now ensure certain directories
+
+## 2019-08-23 - 3.0.13 - Bug Fix Release
+- fix(core): update
+
+## 2019-08-22 - 3.0.12 - Bug Fix Release
+- fix(core): update
+
+## 2019-06-19 - 3.0.11 - Bug Fix Release
+- fix(core): update
+
+## 2019-04-10 - 3.0.9 to 3.0.8 - Bug Fix Release
+- fix(core): update
+
+## 2018-09-03 - 3.0.7 - Bug Fix Release
+- fix(core): update
+
+## 2018-09-02 - 3.0.6 - Dependency Update
+- fix(dependencies): update to latest versions
+
+## 2018-08-08 - 3.0.5 - New Feature
+- fix(core): add tap.only option
+
+## 2018-08-08 - 3.0.4 - Dependency Update
+- fix(dependencies): update
+
+## 2018-08-08 - 3.0.3 - Dependency Update
+- fix(dependencies): use @gitzone/tsbuild instead of npmts
+
+## 2018-07-18 - 3.0.2 - Dependency Update
+- fix(dependencies): now typings-global free
+
+## 2018-07-13 - 3.0.1 - Dependency Update
+- fix(dependencies): update
+
+## 2018-07-13 - 3.0.0 - Package Update
+- fix(package): npm access level
+
+## 2018-06-28 - 2.0.2 - Breaking Change
+BREAKING CHANGE(package): change scope
+
+## 2018-06-28 - 2.0.1 - Security Update
+- fix(security): add snyk file
+
+## 2018-02-27 - 2.0.0 - Compatibility Update
+- fix(core): fix node 10.x.x compatibility
+
+## 2017-10-11 - 1.1.8 - Update
+- update to use latest smartchai
+
+## 2017-10-11 - 1.1.7 - Update
+- update ci
+
+## 2017-10-10 - 1.1.6 - Documentation Update
+- add new docs
+
+## 2017-10-09 - 1.1.5 - Feature Update
+- now has working leak detection
+
+## 2017-03-26 - 1.0.9 - Standards Update
+- update to latest standards

npmextra.json

@@ -11,12 +11,29 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
       "gitrepo": "tapbundle",
-      "shortDescription": "tap bundled for tapbuffer",
-      "npmPackagename": "@pushrocks/tapbundle",
-      "license": "MIT"
+      "description": "A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.",
+      "npmPackagename": "@push.rocks/tapbundle",
+      "license": "MIT",
+      "keywords": [
+        "testing",
+        "automation",
+        "TAP",
+        "test anything protocol",
+        "unit testing",
+        "integration testing",
+        "JavaScript",
+        "TypeScript",
+        "test runner",
+        "test framework",
+        "web helpers",
+        "test utilities"
+      ]
     }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,39 +1,41 @@
 {
-  "name": "@pushrocks/tapbundle",
+  "name": "@push.rocks/tapbundle",
   "private": false,
-  "version": "5.0.8",
-  "description": "tap bundled for tapbuffer",
+  "version": "5.0.24",
+  "description": "A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web --allowimplicitany --skiplibcheck)"
+    "build": "(tsbuild --web --allowimplicitany --skiplibcheck)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/tapbundle.git"
+    "url": "https://code.foss.global/push.rocks/tapbundle.git"
   },
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
     "url": "https://gitlab.com/pushrocks/tapbundle/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/tapbundle#README",
+  "homepage": "https://code.foss.global/push.rocks/tapbundle",
   "dependencies": {
-    "@open-wc/testing": "^3.2.0",
-    "@open-wc/testing-helpers": "^2.3.0",
-    "@pushrocks/smartdelay": "^3.0.1",
-    "@pushrocks/smartenv": "^5.0.2",
-    "@pushrocks/smartexpect": "^1.0.15",
-    "@pushrocks/smartpromise": "^4.0.2",
-    "@pushrocks/smarttime": "^4.0.1"
+    "@open-wc/testing": "^4.0.0",
+    "@push.rocks/consolecolor": "^2.0.2",
+    "@push.rocks/smartdelay": "^3.0.5",
+    "@push.rocks/smartenv": "^5.0.12",
+    "@push.rocks/smartexpect": "^1.1.0",
+    "@push.rocks/smartjson": "^5.0.20",
+    "@push.rocks/smartpromise": "^4.0.4",
+    "@push.rocks/smarttime": "^4.0.8"
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.42",
-    "@gitzone/tstest": "^1.0.72",
-    "@types/node": "^20.3.1",
+    "@gitzone/tsrun": "^1.2.43",
+    "@gitzone/tstest": "^1.0.77",
+    "@types/node": "^22.4.0",
     "randomstring": "^1.3.0"
   },
   "files": [
@@ -50,5 +52,19 @@
   ],
   "browserslist": [
     "last 1 chrome versions"
+  ],
+  "keywords": [
+    "testing",
+    "automation",
+    "TAP",
+    "test anything protocol",
+    "unit testing",
+    "integration testing",
+    "JavaScript",
+    "TypeScript",
+    "test runner",
+    "test framework",
+    "web helpers",
+    "test utilities"
   ]
 }

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,88 +1,138 @@
-# @pushrocks/tapbundle
-tap based testing framework for use with @gitzone/tstest
+# @push.rocks/tapbundle
+tap bundled for tapbuffer
 
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/tapbundle)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/tapbundle)
-* [github.com (source mirror)](https://github.com/pushrocks/tapbundle)
-* [docs (typedoc)](https://pushrocks.gitlab.io/tapbundle/)
+## Install
+Install the package by running the following command in your terminal:
 
-## Status for master
-
-Status Category | Status Badge
--- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/tapbundle/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/tapbundle/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/tapbundle)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/tapbundle)](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/tapbundle)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/tapbundle)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/tapbundle)](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
-
-Use TypeScript for best in class instellisense.
-
-A few words on TypeScript
-
-### Included in this package
-
-* tap compatible testing framework written in TypeScript
-* `expect` and `expectAsync` from the package `@pushrocks/smartexpect`
-
-### A few words on tap
-
-**"tap"** stands for **"test anything protocol"**. Its programming language agnostic as long as the test interpreter can read the tap console output. This package is optimized to work with @gitzone/tstest as interpreter, which offers different V8 based runtime environments like nodejs, chrome, and deno.
-
-### Write your first tests
-
-```typescript
-import { tap, expect, expectAsync } from 'tapbundle'; // has typings in place
-
-import * as myAwesomeModuleToTest from '../dist/index'; // '../dist/index' is the standard path for npmts modules
-
-tap.test('my awesome description', async (tools) => {
-  // tools are optional parameter
-  tools.timeout(2000); // test will fail if it takes longer than 2000 millisenconds
-});
-
-const myTest2 = tap.test('my awesome test 2', async (tools) => {
-  myAwsomeModuleToTest.doSomethingAsync(); // we don't wait here
-  await tools.delayFor(3000); // yay! :) promise based timeouts :)
-  console.log('This gets logged 3000 ms into the test');
-});
-
-tap.test('my awesome test 3', async (tools) => {
-  expect(true).toBeTrue(); // will not throw
-  await expectAsync(tools.delayFor(2000)).toBeUndefined(); // yay expect promises :)
-  expectAsync(myTest2.promise)  // access other tests metadata :)
-    .property('hrtMeasurement') // and drill down into properties
-    .property('milliSeconds').toBeGreaterThan(1000);
-});
-
-const myTest4 = tap.testParallel('my awesome test 4', async (tools) => {
-  await tools.delayFor(4000);
-  console.log('logs to console after 4 seconds into this test');
-});
-
-tap.test('my awesome test 5', async () => {
-  expect(myTest4.status).toEqual('pending'); // since this test will likely finish before myTest4.
-});
-
-tap.start(); // start the test, will automtically plan tests for you (so the tap parser knows when tests exit bofore they are finished)
+```bash
+npm install @push.rocks/tapbundle --save-dev
 ```
 
-## Contribution
+This will add `@push.rocks/tapbundle` to your project's `devDependencies`.
 
-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). :)
+## Usage
+The `@push.rocks/tapbundle` package is a tap-compatible testing framework written in TypeScript, intended for use with tapbuffer. It includes a range of useful features enabling easy setup and execution of tests, assertion handling through `expect` and `expectAsync`, as well as auxiliary tools for delay and colored console output.
 
-For further information read the linked docs at the top of this readme.
+### Getting Started
+First, ensure your project is set up with Typescript and supports ESM syntax. You can then import `tap`, `expect`, and `expectAsync` from `@push.rocks/tapbundle` to start defining your tests.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+```typescript
+import { tap, expect, expectAsync } from '@push.rocks/tapbundle';
+```
 
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
+Here is a simple test example:
+
+```typescript
+import { tap, expect } from '@push.rocks/tapbundle';
+
+tap.test('should succeed on true assertion', async () => {
+  return expect(true).toBeTrue();
+});
+
+tap.start();
+```
+
+### Defining Tests
+You can define tests with descriptions and async functions. The `tap` instance manages test execution, supports test skipping, and managing exclusive tests with the `.only` modifier.
+
+```typescript
+const myTest = tap.test('expect true to be true', async () => {
+  expect(true).toBeTrue();
+});
+
+const skippedTest = tap.skip.test('this test is skipped', async () => {
+  // This will not be executed
+});
+
+tap.only.test('only this test will run', async () => {
+  expect('TapBundle').toContainString('Tap');
+});
+
+tap.start();
+```
+
+### Using `expect` and `expectAsync`
+The package provides `expect` and `expectAsync` for assertions:
+
+```typescript
+await expectAsync(Promise.resolve(true)).toBeResolved();
+expect(5).toBeGreaterThan(2);
+```
+
+### Handling Asynchronous Operations
+`tapbundle` facilitates working with async operations in tests. You can introduce delays or set timeouts:
+
+```typescript
+tap.test('async operation with delay', async (tools) => {
+  await tools.delayFor(2000); // Wait for 2000 milliseconds
+  expect(true).toBeTrue();
+});
+
+tap.start();
+```
+
+### Advanced Usage
+#### Pre Tasks
+You can define tasks to run before test execution begins:
+
+```typescript
+tap.preTask('setup database', async () => {
+  // Perform setup here
+});
+
+tap.test('test database connection', async () => {
+  // Test the setup
+});
+
+tap.start();
+```
+
+#### Accessing Test Metadata
+Each test returns a `TapTest` instance, from which you can access metadata and manipulate test behavior:
+
+```typescript
+const test = tap.test('metadata example', async (tools) => {
+  tools.allowFailure();
+  expect(true).toBeTrue();
+});
+
+tap.start().then(() => {
+  console.log(`Test duration: ${test.hrtMeasurement.milliSeconds}ms`);
+});
+```
+
+### Running Tests
+Tests are executed by calling `tap.start()`. This method runs all defined tests in sequence and respects `.skip` and `.only` modifiers.
+
+### Debugging and Output
+`@push.rocks/tapbundle` supports colored console output via `consolecolor` to help with debugging and test result readability:
+
+```typescript
+tap.test('colored output', async (tools) => {
+  const coloredString = await tools.coloredString('Hello, world!', 'green');
+  console.log(coloredString);
+});
+
+tap.start();
+```
+
+This detailed guide covers the most important aspects of using `@push.rocks/tapbundle` for testing in your TypeScript projects. Explore the included functions and tools to fully leverage this comprehensive testing framework.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.browser.nonci.ts

@@ -21,7 +21,10 @@ const test2 = tap.test('my second test', async (tools) => {
 const test3 = tap.test(
   'my third test -> test2 should take longer than test1 and endure at least 1000ms',
   async () => {
-    expect((await test1.testPromise).hrtMeasurement.milliSeconds < (await test2).hrtMeasurement.milliSeconds).toBeTrue();
+    expect(
+      (await test1.testPromise).hrtMeasurement.milliSeconds <
+        (await test2).hrtMeasurement.milliSeconds
+    ).toBeTrue();
     expect((await test2.testPromise).hrtMeasurement.milliSeconds > 10).toBeTrue();
   }
 );

test/test.ts

@@ -41,4 +41,9 @@ const test6 = tap.skip.test('my 6th test -> should fail after 1000ms', async (to
   await tools.delayFor(2000);
 });
 
+const test7 = tap.test('my 7th test -> should print a colored string', async (tools) => {
+  const cs = await tools.coloredString('hello', 'red', 'cyan');
+  console.log(cs);
+});
+
 tap.start();

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
-  name: '@pushrocks/tapbundle',
-  version: '5.0.8',
-  description: 'tap bundled for tapbuffer'
+  name: '@push.rocks/tapbundle',
+  version: '5.0.24',
+  description: 'A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.'
 }

ts/index.ts

@@ -2,9 +2,6 @@ export { tap } from './tapbundle.classes.tap.js';
 export { TapWrap } from './tapbundle.classes.tapwrap.js';
 export { webhelpers } from './webhelpers.js';
 
-import { expect, expectAsync } from '@pushrocks/smartexpect';
+import { expect, expectAsync } from '@push.rocks/smartexpect';
 
-export {
-  expect,
-  expectAsync
-}
+export { expect, expectAsync };

ts/tapbundle.classes.tap.ts

@@ -143,6 +143,17 @@ export class Tap<T> {
     }
   }
 
+  public async stopForcefully(codeArg = 0, directArg = false) {
+    console.log(`tap stopping forcefully! Code: ${codeArg} / Direct: ${directArg}`);
+    if (directArg) {
+      process.exit(codeArg);
+    } else {
+      setTimeout(() => {
+        process.exit(codeArg);
+      }, 10)
+    }
+  }
+
   /**
    * handle errors
    */

ts/tapbundle.classes.taptest.ts

@@ -3,15 +3,17 @@ import { tapCreator } from './tapbundle.tapcreator.js';
 import { TapTools } from './tapbundle.classes.taptools.js';
 
 // imported interfaces
-import { Deferred } from '@pushrocks/smartpromise';
-import { HrtMeasurement } from '@pushrocks/smarttime';
+import { Deferred } from '@push.rocks/smartpromise';
+import { HrtMeasurement } from '@push.rocks/smarttime';
 
 // interfaces
 export type TTestStatus = 'success' | 'error' | 'pending' | 'errorAfterSuccess' | 'timeout';
 
-export interface ITestFunction <T> { (tapTools?: TapTools): Promise<T> };
+export interface ITestFunction<T> {
+  (tapTools?: TapTools): Promise<T>;
+}
 
-export class TapTest <T = unknown> {
+export class TapTest<T = unknown> {
   public description: string;
   public failureAllowed: boolean;
   public hrtMeasurement: HrtMeasurement;
@@ -27,7 +29,11 @@ export class TapTest <T = unknown> {
   /**
    * constructor
    */
-  constructor(optionsArg: { description: string; testFunction: ITestFunction<T>; parallel: boolean }) {
+  constructor(optionsArg: {
+    description: string;
+    testFunction: ITestFunction<T>;
+    parallel: boolean;
+  }) {
     this.description = optionsArg.description;
     this.hrtMeasurement = new HrtMeasurement();
     this.parallel = optionsArg.parallel;

ts/tapbundle.classes.taptools.ts

@@ -33,6 +33,10 @@ export class TapTools {
     await plugins.smartdelay.delayForRandom(timeMilliMinArg, timeMilliMaxArg);
   }
 
+  public async coloredString(...args: Parameters<typeof plugins.consolecolor.coloredString>) {
+    return plugins.consolecolor.coloredString(...args);
+  }
+
   public async timeout(timeMilliArg: number) {
     const timeout = new plugins.smartdelay.Timeout(timeMilliArg);
     timeout.makeUnrefed();
@@ -55,4 +59,6 @@ export class TapTools {
   public defer() {
     return plugins.smartpromise.defer();
   }
+
+  public smartjson = plugins.smartjson;
 }

ts/tapbundle.plugins.ts

@@ -1,7 +1,9 @@
 // pushrocks
-import * as smartdelay from '@pushrocks/smartdelay';
-import * as smartenv from '@pushrocks/smartenv';
-import * as smartexpect from '@pushrocks/smartexpect';
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as consolecolor from '@push.rocks/consolecolor';
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as smartenv from '@push.rocks/smartenv';
+import * as smartexpect from '@push.rocks/smartexpect';
+import * as smartjson from '@push.rocks/smartjson';
+import * as smartpromise from '@push.rocks/smartpromise';
 
-export { smartdelay, smartenv, smartexpect, smartpromise };
+export { consolecolor, smartdelay, smartenv, smartexpect, smartjson, smartpromise };

ts/webhelpers.ts

@@ -1,5 +1,5 @@
 import * as plugins from './tapbundle.plugins.js';
-import type { fixture, html } from '@open-wc/testing-helpers';
+import type { fixture, html } from '@open-wc/testing';
 import { tap } from './tapbundle.classes.tap.js';
 
 class WebHelpers {
@@ -8,7 +8,7 @@ class WebHelpers {
 
   constructor() {
     const smartenv = new plugins.smartenv.Smartenv();
-    if(smartenv.isBrowser) {
+    if (smartenv.isBrowser) {
       this.enable();
     }
   }
@@ -18,7 +18,7 @@ class WebHelpers {
       const webhelpers = await import('@open-wc/testing');
       this.html = webhelpers.html;
       this.fixture = webhelpers.fixture;
-    })
+    });
   }
 }
 

tsconfig.json

@@ -3,9 +3,12 @@
     "experimentalDecorators": true,
     "useDefineForClassFields": false,
     "target": "ES2022",
-    "module": "ES2022",
-    "moduleResolution": "nodenext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "esModuleInterop": true,
-    "verbatimModuleSyntax": true,
-  }
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
 }