Provide injectable logger instance #178
Labels
type: feature request
‘Nice-to-have’ improvement, new feature or different behavior or design.
Comments
chingor13
added
the
type: feature request
This was referenced Apr 21, 2021
gcf-merge-on-green bot
pushed a commit
that referenced
this issue
Apr 23, 2021
This changes the logger option provided to `reviewPullRequest()` and `createPullRequest()` to be a custom `Logger` interface that `code-suggester` declares:
```ts
interface LogFn {
/* eslint-disable @typescript-eslint/no-explicit-any */
<T extends object>(obj: T, msg?: string, ...args: any[]): void;
(msg: string, ...args: any[]): void;
/* eslint-enable @typescript-eslint/no-explicit-any */
}
export interface Logger {
error: LogFn;
warn: LogFn;
info: LogFn;
debug: LogFn;
trace: LogFn;
}
```
* This logger interface can be fulfilled by a default `Pino` logger as well as plain old `console`.
* We now default the logger to a null implementation to keep output to a minimum while allowing for a custom logger if you want output.
* We can drop the `pino` dependency as we now provide a null default logger implementation.
Fixes #178
Fixes #183
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We currently default to a pino logger that outputs JSON compatible with GCP logging.
For integrations like CLI's that use code-suggester, we might want to log with something more CLI friendly.
The text was updated successfully, but these errors were encountered: