diff --git a/package.json b/package.json index 9543536..3d52a66 100644 --- a/package.json +++ b/package.json @@ -9,21 +9,18 @@ "license": "MIT", "scripts": { "test": "(tstest test/ --web)", - "testBrowser": "(parcel ./test/index.html)", - "build": "(tsbuild --web)" + "build": "(tsbuild --web)", + "buildDocs": "tsdoc" }, "devDependencies": { - "@gitzone/tsbuild": "^2.1.24", - "@gitzone/tstest": "^1.0.40", - "@pushrocks/smartlog": "^2.0.35", - "@pushrocks/tapbundle": "^3.2.7", - "@types/node": "^14.0.20", - "parcel-bundler": "^1.12.4", - "tslint": "^6.1.2", - "tslint-config-prettier": "^1.18.0" + "@git.zone/tsbuild": "^2.1.66", + "@git.zone/tstest": "^1.0.77", + "@push.rocks/smartlog": "^3.0.2", + "@push.rocks/tapbundle": "^5.0.8", + "@types/node": "^20.12.12" }, "dependencies": { - "@pushrocks/smartlog-interfaces": "^2.0.20" + "@push.rocks/smartlog-interfaces": "^3.0.0" }, "browserslist": [ "last 1 chrome versions" @@ -51,5 +48,14 @@ "visual logging", "smartlog", "devtools" - ] + ], + "repository": { + "type": "git", + "url": "https://code.foss.global/push.rocks/smartlog-destination-devtools.git" + }, + "bugs": { + "url": "https://code.foss.global/push.rocks/smartlog-destination-devtools/issues" + }, + "homepage": "https://code.foss.global/push.rocks/smartlog-destination-devtools", + "type": "module" } \ No newline at end of file diff --git a/readme.md b/readme.md index 8068dfd..1afe19d 100644 --- a/readme.md +++ b/readme.md @@ -12,14 +12,14 @@ This will add `smartlog-destination-devtools` as a dependency to your project an ## Usage -`@push.rocks/smartlog-destination-devtools` provides a seamless way to output beautified log messages directly to your browser's console, making use of the `@pushrocks/smartlog` ecosystem for structured and meaningful logging. +`@push.rocks/smartlog-destination-devtools` provides a seamless way to output beautified log messages directly to your browser's console, making use of the `@push.rocks/smartlog` ecosystem for structured and meaningful logging. ### Getting Started -First, ensure you have `@pushrocks/smartlog` installed in your project. If not, install it alongside `smartlog-destination-devtools`: +First, ensure you have `@push.rocks/smartlog` installed in your project. If not, install it alongside `smartlog-destination-devtools`: ```sh -npm install @pushrocks/smartlog @push.rocks/smartlog-destination-devtools --save +npm install @push.rocks/smartlog @push.rocks/smartlog-destination-devtools --save ``` Now, let's set up the basic usage of `smartlog-destination-devtools` within a TypeScript project. @@ -29,7 +29,7 @@ Now, let's set up the basic usage of `smartlog-destination-devtools` within a Ty Import the required modules and initialize `Smartlog` and `SmartlogDestinationDevtools`. ```typescript -import { Smartlog, ISmartlogOptions, ILogContext } from '@pushrocks/smartlog'; +import { Smartlog, ISmartlogOptions, ILogContext } from '@push.rocks/smartlog'; import { SmartlogDestinationDevtools } from '@push.rocks/smartlog-destination-devtools'; // Define your log context @@ -75,17 +75,17 @@ smartlogInstance.error('This is an error message', new Error('Something went wro ### Customization -`SmartlogDestinationDevtools` class is designed to automatically handle log messages sent through `@pushrocks/smartlog` and print them to the browser's console in a visually structured and highlighted manner. Currently, it translates different log levels (`info`, `warn`, `error`, `note`, `success`) to different styles in the DevTools console. +`SmartlogDestinationDevtools` class is designed to automatically handle log messages sent through `@push.rocks/smartlog` and print them to the browser's console in a visually structured and highlighted manner. Currently, it translates different log levels (`info`, `warn`, `error`, `note`, `success`) to different styles in the DevTools console. Since the core feature of `smartlog-destination-devtools` is to enhance the visual feedback of logs in the development environment, further customization can be achieved by altering the source code of the `handleLog` method within the class to fit your styling needs or by extending the class with your own implementation. ### Advanced Usage -For more advanced scenarios like filtering logs or integrating with other logging systems, refer to the `@pushrocks/smartlog` documentation, as `smartlog-destination-devtools` acts as a destination for the logs managed by `@pushrocks/smartlog`. +For more advanced scenarios like filtering logs or integrating with other logging systems, refer to the `@push.rocks/smartlog` documentation, as `smartlog-destination-devtools` acts as a destination for the logs managed by `@push.rocks/smartlog`. --- -By integrating `@push.rocks/smartlog-destination-devtools`, you're equipped to make your browser-based debugging and logging more effective and visually appealing, leveraging the structured logging capabilities of `@pushrocks/smartlog`. +By integrating `@push.rocks/smartlog-destination-devtools`, you're equipped to make your browser-based debugging and logging more effective and visually appealing, leveraging the structured logging capabilities of `@push.rocks/smartlog`. ## License and Legal Information