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.
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.
npm run init
# Or if you use yarn
yarn run initSearch across the repository files and solve the TODO comments.
- README.md (here)
End of AUTHORS SECTION. Delete everything above
TODO: Modify the description of this driver
is a custom log driver for ngworker/lumberjack. It is used to send logs over SOME protocol.
TODO: Update the features of this driver
- ✅ Logs to custom log store
- ✅ Unit test coverage
- ✅ Custom Logger
- ✅ Follows Lumberjack Best Practices guide
is published as the @<organization-hyphen>/<name-hyphen> package.
| Toolchain | Command |
|---|---|
| Angular CLI | ng add @<organization-hyphen>/<name-hyphen> |
| NPM CLI | npm install @<organization-hyphen>/<name-hyphen> |
| Yarn CLI | yarn add @<organization-hyphen>/<name-hyphen> |
<name-capitalize-united> 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.
TODO: Verify that these configurations match your driver configurations.
To start using , import it in your root or core Angular module along with Lumberjack.
import { NgModule } from '@angular/core';
import { LumberjackLevel, LumberjackModule } from '@ngworker/lumberjack';
import { <name-capitalize-united> } from '@<organization-hyphen>/<name-hyphen>';
@NgModule({
imports: [
LumberjackModule.forRoot({
levels: [LumberjackLevel.Verbose],
}),
<name-capitalize-united>.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 <name-capitalize-united>.
TODO: Here it is explained how this custom driver can be configured.
Contributors to this repository are welcome to use the Wallaby.js OSS License to get test results immediately as you type, and see the results in your editor right next to your code.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!