https://github.com/loglayer/loglayer-transport-boilerplate
A template for creating transports for LogLayer
https://github.com/loglayer/loglayer-transport-boilerplate
boilerplate log logging template transport typescript
Last synced: 11 months ago
JSON representation
A template for creating transports for LogLayer
- Host: GitHub
- URL: https://github.com/loglayer/loglayer-transport-boilerplate
- Owner: loglayer
- License: mit
- Created: 2025-01-11T08:22:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-16T23:54:29.000Z (12 months ago)
- Last Synced: 2025-03-17T00:29:25.397Z (12 months ago)
- Topics: boilerplate, log, logging, template, transport, typescript
- Language: TypeScript
- Homepage: https://loglayer.dev
- Size: 66.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Transport Boilerplate for LogLayer
This is a template for creating transports for use with [LogLayer](https://loglayer.dev).
See the [Creating Transports](https://loglayer.dev/transports/creating-transports.html) documentation
for more information.
## Installation
```bash
npm install
```
## Run Tests
```bash
npm run test
```
## Run Live Tests
```bash
npm run livetest
```
## Lint + Fix
Uses [Biome](https://biomejs.dev/) for linting and formatting.
```bash
npm run lint
```
## Build
Uses [tsup](https://github.com/egoist/tsup) to build commonjs and esm versions.
```bash
npm run build
```
## Project Structure
```plaintext
.
├── src/
│ ├── __tests__/ # Test files
│ ├── index.ts # Entrypoint
│ ├── LogBasedTransport.ts # Transport implementation using a log library
│ └── NotLogBasedTransport.ts # Transport implementation not using a log library
```