update description

.gitlab-ci.yml

@@ -12,30 +12,38 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-audit:
+# ====================
+# security stage
+# ====================
+auditProductionDependencies:
   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
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
     - lossless
     - docker
-    - notpriv
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command pnpm audit --audit-level=high --dev
+  tags:
+    - lossless
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -44,28 +52,22 @@ audit:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 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:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,11 +87,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  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
@@ -109,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
+    - npmci node install stable
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.snyk

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

.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"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

docs/index.md

@@ -57,7 +57,7 @@ Beautylog makes it easy to have all your node applications log to a remote locat
 ```javascript
 import { Loggly } from 'beautyremote';
 let myLogglyRemote = new Loggly({
-  token: 'my_super_long_token_here'
+  token: 'my_super_long_token_here',
 });
 beautylog.registerRemote(myLogglyRemote);
 ```

npmextra.json

@@ -6,12 +6,23 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
       "gitrepo": "smartlog-destination-local",
-      "shortDescription": "a smartlog destination targeting the local console",
-      "npmPackagename": "@pushrocks/smartlog-destination-local",
-      "license": "MIT"
+      "description": "a smartlog destination targeting the local console",
+      "npmPackagename": "@push.rocks/smartlog-destination-local",
+      "license": "MIT",
+      "keywords": [
+        "logging",
+        "console log",
+        "log management",
+        "developer tools",
+        "local logging",
+        "console output"
+      ]
     }
+  },
+  "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,43 +1,44 @@
 {
-  "name": "@pushrocks/smartlog-destination-local",
+  "name": "@push.rocks/smartlog-destination-local",
   "private": false,
-  "version": "8.0.8",
+  "version": "9.0.2",
   "description": "a smartlog destination targeting the local console",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "https://gitlab.com/pushrocks/beautylog.git"
+    "url": "https://code.foss.global/push.rocks/smartlog-destination-local.git"
   },
   "keywords": [
-    "log",
-    "color",
-    "console",
-    "beautiful"
+    "logging",
+    "console log",
+    "log management",
+    "developer tools",
+    "local logging",
+    "console output"
   ],
   "author": "Lossless GmbH <hello@lossless.com> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
     "url": "https://gitlab.com/pushrocks/beautylog/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/beautylog",
+  "homepage": "https://code.foss.global/push.rocks/smartlog-destination-local",
   "dependencies": {
-    "@pushrocks/consolecolor": "^2.0.1",
-    "@pushrocks/smartlog-interfaces": "^2.0.20",
-    "@pushrocks/smartpromise": "^3.0.6"
+    "@push.rocks/consolecolor": "^2.0.1",
+    "@push.rocks/smartlog-interfaces": "^3.0.0",
+    "@push.rocks/smartpromise": "^4.0.2"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.33",
-    "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^14.0.13",
-    "tslint": "^6.1.2",
-    "tslint-config-prettier": "^1.18.0"
+    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsrun": "^1.2.42",
+    "@git.zone/tstest": "^1.0.74",
+    "@push.rocks/tapbundle": "^5.0.8",
+    "@types/node": "^20.4.1"
   },
   "files": [
     "ts/**/*",
@@ -50,5 +51,9 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "type": "module",
+  "browserslist": [
+    "last 1 chrome versions"
   ]
-}
+}

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,38 +1,111 @@
-# @pushrocks/smartlog-destination-local
+# @push.rocks/smartlog-destination-local
 a smartlog destination targeting the local console
 
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartlog-destination-local)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartlog-destination-local)
-* [github.com (source mirror)](https://github.com/pushrocks/smartlog-destination-local)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartlog-destination-local/)
+## Install
+To use `@push.rocks/smartlog-destination-local` in your project, you need to install it via npm. You can do this by running:
 
-## Status for master
+```bash
+npm install @push.rocks/smartlog-destination-local --save
+```
 
-Status Category | Status Badge
--- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartlog-destination-local/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartlog-destination-local/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartlog-destination-local)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartlog-destination-local)](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/smartlog-destination-local)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartlog-destination-local)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartlog-destination-local)](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)
+This command adds `@push.rocks/smartlog-destination-local` to your project's dependencies and enables you to start implementing its features in your application.
 
 ## Usage
 
+The `@push.rocks/smartlog-destination-local` package provides a way to easily log messages to the local console with support for color coding and structured message formats. It is especially useful when combined with the `@push.rocks/smartlog` package to create a powerful logging solution that is both visually informative and structured for better logging practices.
 
-## Contribution
+### Importing and Setting Up
 
-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). :)
+First, make sure to import the package where you intend to use it:
 
-For further information read the linked docs at the top of this readme.
+```typescript
+import { DestinationLocal } from '@push.rocks/smartlog-destination-local';
+```
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+Next, create an instance of `DestinationLocal`:
 
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
+```typescript
+const localLogDestination = new DestinationLocal();
+```
+
+### Logging Messages
+
+The primary feature of `@push.rocks/smartlog-destination-local` is to log messages to the console. This can be done by preparing a log package and using the `handleLog` method.
+
+#### Example Log Message
+
+```typescript
+import type { ILogPackage } from '@push.rocks/smartlog-interfaces';
+
+const logPackage: ILogPackage = {
+  timestamp: Date.now(),
+  type: 'log', // or 'error', 'warn', etc. depending on the nature of the message
+  level: 'info', // determines the visibility and importance of the log
+  context: {
+    company: 'Your Company',
+    companyunit: 'Your Unit',
+    containerName: 'Your Container',
+    environment: 'development',
+    runtime: 'node',
+    zone: 'Your Zone'
+  },
+  message: 'This is a test log message.', // the actual message
+  correlation: {
+    id: 'uniqueId', // useful for tracing logs
+    type: 'requestId'
+  },
+};
+
+// Using the instance to log the message
+localLogDestination.handleLog(logPackage);
+```
+
+This will output a structured, color-coded log message to your console, making it easier to differentiate between various log levels and to understand the context of the log messages at a glance.
+
+### Log Reduction
+
+For scenarios where repeated log messages may clutter your log output, `@push.rocks/smartlog-destination-local` offers a `logReduced` method. This method will throttle the output of identical consecutive messages according to the settings you provide.
+
+#### Reducing Log Output
+
+```typescript
+// Log a message repeatedly, e.g., in a loop
+for (let i = 0; i < 100; i++) {
+  localLogDestination.logReduced('Repeated message', 5); // only logs every 5th identical message
+}
+```
+
+### Adding New Lines
+
+You may want to improve the readability of your logs by inserting blank lines. This can be easily achieved:
+
+```typescript
+localLogDestination.newLine(2); // Inserts two empty lines in the log output
+```
+
+### Advanced Use Cases
+
+The `@push.rocks/smartlog-destination-local` package is flexible and integrates seamlessly with other logging and monitoring solutions. It can be extended or customized to fit more complex logging requirements, such as filtering logs based on environment, enhancing log messages with additional metadata, or integrating with remote logging services for centralized log management.
+
+### Conclusion
+
+`@push.rocks/smartlog-destination-local` serves as a robust, easy-to-use solution for enhancing your application's logging capabilities. By following the examples and using the provided methods, you can quickly implement effective logging practices that improve debugging, monitoring, and analysis of your application's behavior in development and production environments.
+
+## 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.ts

@@ -1,7 +1,7 @@
-import { tap, expect } from '@pushrocks/tapbundle';
+import { tap, expect } from '@push.rocks/tapbundle';
 
-import smartlogDesinationLocal = require('../ts/index');
-import { ILogContext } from '@pushrocks/smartlog-interfaces';
+import * as smartlogDesinationLocal from '../ts/index.js';
+import type { ILogContext } from '@push.rocks/smartlog-interfaces';
 
 const testLogContext: ILogContext = {
   company: 'Lossless GmbH',
@@ -9,14 +9,14 @@ const testLogContext: ILogContext = {
   containerName: 'gitlabci',
   environment: 'staging',
   runtime: 'node',
-  zone: 'shipzone'
+  zone: 'shipzone',
 };
 
 let testLocalInstance: smartlogDesinationLocal.DestinationLocal;
 
 tap.test('should create a valid instance of DestinationLocal', async () => {
   testLocalInstance = new smartlogDesinationLocal.DestinationLocal();
-  expect(testLocalInstance).to.be.instanceof(smartlogDesinationLocal.DestinationLocal);
+  expect(testLocalInstance).toBeInstanceOf(smartlogDesinationLocal.DestinationLocal);
 });
 
 tap.test('.log(message) should print a blue Dir message', async () => {
@@ -28,8 +28,8 @@ tap.test('.log(message) should print a blue Dir message', async () => {
     message: 'this is a info log message',
     correlation: {
       id: '123',
-      type: 'none'
-    }
+      type: 'none',
+    },
   });
 });
 

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartlog-destination-local',
+  version: '9.0.2',
+  description: 'a smartlog destination targeting the local console'
+}

ts/classes.destinationlocal.ts

@@ -1,8 +1,8 @@
-import * as plugins from './sl.destlocal.plugins';
-import { ILogDestination, ILogPackage, TLogLevel } from '@pushrocks/smartlog-interfaces';
+import * as plugins from './plugins.js';
+import type { ILogDestination, ILogPackage, TLogLevel } from '@push.rocks/smartlog-interfaces';
 
 // other beautylog classes
-import { TColorName } from '@pushrocks/consolecolor';
+import { type TColorName } from '@push.rocks/consolecolor';
 
 export class DestinationLocal implements ILogDestination {
   /**
@@ -46,13 +46,13 @@ export class DestinationLocal implements ILogDestination {
           containerName: 'undefined',
           environment: 'test',
           runtime: 'node',
-          zone: 'undefined'
+          zone: 'undefined',
         },
         message: logTextArg,
         correlation: {
           id: 'none',
-          type: 'none'
-        }
+          type: 'none',
+        },
       });
     }
   }
@@ -87,49 +87,49 @@ export class DestinationLocal implements ILogDestination {
   } = {
     silly: {
       prefix: plugins.consolecolor.coloredString(' silly ', 'white', 'blue') + ' ',
-      textColor: 'blue'
+      textColor: 'blue',
     },
     error: {
       prefix:
         plugins.consolecolor.coloredString(' ', 'red', 'red') +
         plugins.consolecolor.coloredString(' ERROR!  ', 'red', 'black') +
         ' ',
-      textColor: 'red'
+      textColor: 'red',
     },
     info: {
       prefix:
         plugins.consolecolor.coloredString(' ', 'blue', 'blue') +
         plugins.consolecolor.coloredString(' info: ', 'blue', 'black') +
         ' ',
-      textColor: 'white'
+      textColor: 'white',
     },
     note: {
       prefix:
         plugins.consolecolor.coloredString(' ', 'pink', 'pink') +
         plugins.consolecolor.coloredString(' note -> ', 'pink', 'black') +
         ' ',
-      textColor: 'pink'
+      textColor: 'pink',
     },
     ok: {
       prefix:
         plugins.consolecolor.coloredString(' ', 'green', 'green') +
         plugins.consolecolor.coloredString(' ok ', 'green', 'black') +
         ' ',
-      textColor: 'green'
+      textColor: 'green',
     },
     success: {
       prefix:
         plugins.consolecolor.coloredString(' ', 'green', 'green') +
         plugins.consolecolor.coloredString(' SUCCESS! ', 'green', 'black') +
         ' ',
-      textColor: 'green'
+      textColor: 'green',
     },
     warn: {
       prefix:
         plugins.consolecolor.coloredString(' ', 'orange', 'orange') +
         plugins.consolecolor.coloredString(' WARN -> ', 'orange', 'black') +
         ' ',
-      textColor: 'orange'
-    }
+      textColor: 'orange',
+    },
   };
 }

ts/index.ts

@@ -1,2 +1,2 @@
 // export classes
-export { DestinationLocal } from './sl.destlocal.classes.destinationlocal';
+export { DestinationLocal } from './classes.destinationlocal.js';

ts/plugins.ts

@@ -0,0 +1,5 @@
+import * as consolecolor from '@push.rocks/consolecolor';
+import * as smartlogInterfaces from '@push.rocks/smartlog-interfaces';
+import * as smartpromise from '@push.rocks/smartpromise';
+
+export { consolecolor, smartlogInterfaces, smartpromise };

ts/sl.destlocal.plugins.ts

@@ -1,5 +0,0 @@
-import * as consolecolor from '@pushrocks/consolecolor';
-import * as smartlogInterfaces from '@pushrocks/smartlog-interfaces';
-import * as smartpromise from '@pushrocks/smartpromise';
-
-export { consolecolor, smartlogInterfaces, smartpromise };

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "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"
-}