update tsconfig
This commit is contained in:
parent
45295e0dd2
commit
a39dc80699
@ -11,10 +11,23 @@
|
||||
"gitrepo": "smartlog-destination-devtools",
|
||||
"shortDescription": "beautiful logging for the browser",
|
||||
"npmPackagename": "@push.rocks/smartlog-destination-devtools",
|
||||
"license": "MIT"
|
||||
"license": "MIT",
|
||||
"description": "A library enabling enhanced logging in browser development tools.",
|
||||
"keywords": [
|
||||
"logging",
|
||||
"browser",
|
||||
"development tools",
|
||||
"typescript",
|
||||
"npm package",
|
||||
"browser console",
|
||||
"log management",
|
||||
"visual logging",
|
||||
"smartlog",
|
||||
"devtools"
|
||||
]
|
||||
}
|
||||
},
|
||||
"tsdocs": {
|
||||
"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"
|
||||
}
|
||||
}
|
||||
14
package.json
14
package.json
@ -2,7 +2,7 @@
|
||||
"name": "@push.rocks/smartlog-destination-devtools",
|
||||
"version": "1.0.10",
|
||||
"private": false,
|
||||
"description": "beautiful logging for the browser",
|
||||
"description": "A library enabling enhanced logging in browser development tools.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
@ -39,5 +39,17 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"keywords": [
|
||||
"logging",
|
||||
"browser",
|
||||
"development tools",
|
||||
"typescript",
|
||||
"npm package",
|
||||
"browser console",
|
||||
"log management",
|
||||
"visual logging",
|
||||
"smartlog",
|
||||
"devtools"
|
||||
]
|
||||
}
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
121
readme.md
121
readme.md
@ -1,38 +1,107 @@
|
||||
# @pushrocks/smartlog-destination-devtools
|
||||
# @push.rocks/smartlog-destination-devtools
|
||||
beautiful logging for the browser
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartlog-destination-devtools)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartlog-destination-devtools)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartlog-destination-devtools)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartlog-destination-devtools/)
|
||||
## Install
|
||||
To install `@push.rocks/smartlog-destination-devtools`, use the following command in your project:
|
||||
|
||||
## Status for master
|
||||
```sh
|
||||
npm install @push.rocks/smartlog-destination-devtools --save
|
||||
```
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
This will add `smartlog-destination-devtools` as a dependency to your project and you can start using it to enhance your logging in the browser.
|
||||
|
||||
## 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.
|
||||
|
||||
## Contribution
|
||||
### Getting Started
|
||||
|
||||
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, ensure you have `@pushrocks/smartlog` installed in your project. If not, install it alongside `smartlog-destination-devtools`:
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
```sh
|
||||
npm install @pushrocks/smartlog @push.rocks/smartlog-destination-devtools --save
|
||||
```
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
Now, let's set up the basic usage of `smartlog-destination-devtools` within a TypeScript project.
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
### Initialization
|
||||
|
||||
Import the required modules and initialize `Smartlog` and `SmartlogDestinationDevtools`.
|
||||
|
||||
```typescript
|
||||
import { Smartlog, ISmartlogOptions, ILogContext } from '@pushrocks/smartlog';
|
||||
import { SmartlogDestinationDevtools } from '@push.rocks/smartlog-destination-devtools';
|
||||
|
||||
// Define your log context
|
||||
const logContext: ILogContext = {
|
||||
company: 'Your Company',
|
||||
companyunit: 'Your Company Unit',
|
||||
containerName: 'YourContainerName',
|
||||
environment: 'development',
|
||||
runtime: 'browser',
|
||||
zone: 'frontend',
|
||||
};
|
||||
|
||||
// Set up Smartlog options
|
||||
const smartlogOptions: ISmartlogOptions = {
|
||||
minimumLogLevel: 'info',
|
||||
logContext: logContext,
|
||||
};
|
||||
|
||||
// Initialize Smartlog with options
|
||||
const smartlogInstance = new Smartlog(smartlogOptions);
|
||||
|
||||
// Initialize the DevTools destination
|
||||
const devtoolsDestination = new SmartlogDestinationDevtools();
|
||||
|
||||
// Add the DevTools destination to Smartlog
|
||||
smartlogInstance.addDestination(devtoolsDestination);
|
||||
```
|
||||
|
||||
### Logging
|
||||
|
||||
Now that setup is complete, you can start logging messages. `@push.rocks/smartlog` uses a structured format for logs, which `@push.rocks/smartlog-destination-devtools` will beautifully display in the console.
|
||||
|
||||
```typescript
|
||||
// Log an information message
|
||||
smartlogInstance.info('This is an informational message', { optional: 'additional data' });
|
||||
|
||||
// Log a warning
|
||||
smartlogInstance.warn('This is a warning message', { check: 'some warning data' });
|
||||
|
||||
// Log an error
|
||||
smartlogInstance.error('This is an error message', new Error('Something went wrong'));
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
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`.
|
||||
|
||||
---
|
||||
|
||||
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`.
|
||||
|
||||
## 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.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user