https://github.com/zwave-js/log-transports
Userland winston log transports to customize zwave-js logging
https://github.com/zwave-js/log-transports
Last synced: 8 months ago
JSON representation
Userland winston log transports to customize zwave-js logging
- Host: GitHub
- URL: https://github.com/zwave-js/log-transports
- Owner: zwave-js
- License: mit
- Created: 2021-03-03T09:45:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-17T04:00:51.000Z (over 2 years ago)
- Last Synced: 2024-11-07T07:02:23.278Z (over 1 year ago)
- Language: JavaScript
- Size: 2.66 MB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Z-Wave JS: Log transports
[`node-zwave-js`](https://github.com/zwave-js/node-zwave-js) offers its users the ability to replace the default [winston log transports](https://github.com/winstonjs/winston) with custom implementations. This repository is the home for userland log transports.
## Available transports:
- [logfmt](packages/logfmt/README.md)
- [json](packages/json)
## Implementing new transports
1. Copy the contents of `package-template` into a new folder under `packages`. That folder should have the same name as the transport, e.g. `mysupercoolservice`.
2. Edit `package.json` of your new transport:
```diff
- "name": "@zwave-js/log-transport-template",
+ "name": "@zwave-js/log-transport-mysupercoolservice",
- "private": true,
"version": "1.0.0-alpha.0",
- "description": "Template log transport for Z-Wave JS",
+ "description": "My super cool log transport for Z-Wave JS",
```
3. Register the new transport in `jest.config.js`:
```diff
moduleNameMapper: {
"^@zwave-js/log-transport-logfmt(.*)": "/packages/logfmt/src$1",
+ "^@zwave-js/log-transport-mysupercoolservice(.*)": "/packages/mysupercoolservice/src$1",
},
```
4. (optional) Add dependencies for your new transport module **locally**:
```bash
lerna add your-dependency --scope=@zwave-js/log-transport-mysupercoolservice
```
5. (optional) Add type declarations for your new transport module **in the root**:
```bash
yarn add --dev -W @types/your-dependency
```
## Quick Links
- [License](LICENSE)
- [Changelog](CHANGELOG.md)