https://github.com/ngworker/lumberjack-custom-driver
Template repository for the creation of custom `lumberjack` drivers
https://github.com/ngworker/lumberjack-custom-driver
Last synced: 6 months ago
JSON representation
Template repository for the creation of custom `lumberjack` drivers
- Host: GitHub
- URL: https://github.com/ngworker/lumberjack-custom-driver
- Owner: ngworker
- License: mit
- Created: 2020-10-22T01:02:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-27T15:23:01.000Z (over 4 years ago)
- Last Synced: 2023-03-04T03:40:09.774Z (over 2 years ago)
- Language: TypeScript
- Size: 181 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AUTHORS SECTION
This section is meant to help log driver authors get started with this template.
> TODO: Remove this section when the repository is completely set up.
## Terraform the repository
To customize the repo and enable some pre-configure tools run the `init` script in the terminal at your root directory.
The `init` script will ask for the required information.
### Running the init script.
```bash
npm run init
# Or if you use yarn
yarn run init
```
## Replace TODOS
Search across the repository files and solve the TODO comments.
### Files with TODOS
- README.md (here)
> End of AUTHORS SECTION. Delete everything above
# @/
[Logo by Felipe Zambrano](http://instagram.com/octopez)
[]()
[]()
[]()
[](https://github.com/prettier/prettier)
[](#contributors-)
[](https://github.com//)
[](https://wallabyjs.com/oss/)
TODO: Modify the description of this driver
is a custom log driver for [ngworker/lumberjack](https://github.com/ngworker/lumberjack). It is used to send logs over SOME protocol.
## Features
TODO: Update the features of this driver
- ✅ Logs to custom log store
- ✅ Unit test coverage
- ✅ Custom Logger
- ✅ Follows Lumberjack Best Practices guide
## Table of Contents
- [Installation](#installation)
- [Compatibility](#compatibility)
- [Usage](#usage)
- [Wallaby.js](#wallaby.js)
- [Contributors](#contributors)
## Installation
is published as the `@/` package.
| Toolchain | Command |
| ----------- | -------------------------------------------------- |
| Angular CLI | `ng add @/` |
| NPM CLI | `npm install @/` |
| Yarn CLI | `yarn add @/` |
## Compatibility
`` has verified compatibility with the following packages versions.
| | Lumberjack | Another Package |
| ------------------------ | -------------- | --------------- |
| 2.0.x | ^2.0.0 | ^8.0.0 |
| 1.2.x | >=2.0.0-rc.0 | ^7.4.1 |
| 1.1.x | >=2.0.0-beta.3 | ^7.0.0 |
If the version you are using is not listed, please [raise an issue in our GitHub repository](https://github.com///issues/new).
## Usage
TODO: Verify that these configurations match your driver configurations.
To start using , import it in your root or core Angular module along with Lumberjack.
```ts
import { NgModule } from '@angular/core';
import { LumberjackLevel, LumberjackModule } from '@ngworker/lumberjack';
import { } from '@/';
@NgModule({
imports: [
LumberjackModule.forRoot({
levels: [LumberjackLevel.Verbose],
}),
.forRoot({
levels: [LumberjackLevel.Critical, LumberjackLevel.Error],
// Options
}),
// (...)
],
// (...)
})
export class AppModule {}
```
Now you can start using the `LumberjackService` or extend `LumberjackLogger` and they will automatically use the ``.
## Configuration
TODO: Here it is explained how this custom driver can be configured.
## Wallaby.js
[](https://wallabyjs.com/oss/)
Contributors to this repository are welcome to use the
[Wallaby.js OSS License](https://wallabyjs.com/oss/) to get
test results immediately as you type, and see the results in
your editor right next to your code.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!