Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions apps/test-bot/src/app/events/clientReady/logger.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { EventHandler, Logger } from 'commandkit';

const handler: EventHandler<'clientReady'> = (client) => {
Logger.log(`Successfully logged in as ${client.user?.tag}`);
};

export default handler;
6 changes: 0 additions & 6 deletions apps/test-bot/src/app/events/ready/logger.ts

This file was deleted.

9 changes: 9 additions & 0 deletions apps/test-bot/src/events/clientReady/test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { type EventHandler, Logger } from 'commandkit';

export const once = true;

const handler: EventHandler<'clientReady'> = (client, c, commandkit) => {
Logger.info`Ready from legacy event handler: ${client.user}`;
};

export default handler;
9 changes: 0 additions & 9 deletions apps/test-bot/src/events/ready/test.ts

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,29 @@ import MemberDescription from '@site/src/components/MemberDescription';

## DefaultLogger

<GenerationInfo sourceFile="packages/commandkit/src/logger/DefaultLogger.ts" sourceLine="52" packageName="commandkit" />
<GenerationInfo sourceFile="packages/commandkit/src/logger/DefaultLogger.ts" sourceLine="54" packageName="commandkit" />

Default logger implementation that logs messages to the console.
It formats the log messages with timestamps, log levels, and context information.

```ts title="Signature"
class DefaultLogger implements ILogger {
constructor(stdout: = process.stdout, stderr: = process.stderr)
debug(args: any[]) => void;
error(args: any[]) => void;
log(args: any[]) => void;
info(args: any[]) => void;
warn(args: any[]) => void;
debug(message: any) => void;
debug(strings: TemplateStringsArray, values: any[]) => void;
debug(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
error(message: any) => void;
error(strings: TemplateStringsArray, values: any[]) => void;
error(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
log(message: any) => void;
log(strings: TemplateStringsArray, values: any[]) => void;
log(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
info(message: any) => void;
info(strings: TemplateStringsArray, values: any[]) => void;
info(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
warn(message: any) => void;
warn(strings: TemplateStringsArray, values: any[]) => void;
warn(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
}
```
* Implements: <code><a href='/docs/next/api-reference/commandkit/interfaces/ilogger#ilogger'>ILogger</a></code>
Expand All @@ -41,29 +51,79 @@ class DefaultLogger implements ILogger {
Creates a new instance of DefaultLogger.
### debug

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a debug message.
### debug

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />


### debug

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />


### error

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs an error message.
### error

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />


### error

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />


### log

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a default message.
### log

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />


### log

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />


### info

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs an info message.
### info

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />


### info

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />


### warn

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a warning message.
### warn

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />


### warn

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />




</div>
80 changes: 70 additions & 10 deletions apps/website/docs/api-reference/commandkit/classes/noop-logger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,21 @@ Noop logger implementation that does nothing.

```ts title="Signature"
class NoopLogger implements ILogger {
debug(args: any[]) => void;
error(args: any[]) => void;
log(args: any[]) => void;
info(args: any[]) => void;
warn(args: any[]) => void;
debug(message: any) => void;
debug(strings: TemplateStringsArray, values: any[]) => void;
debug(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
error(message: any) => void;
error(strings: TemplateStringsArray, values: any[]) => void;
error(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
log(message: any) => void;
log(strings: TemplateStringsArray, values: any[]) => void;
log(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
info(message: any) => void;
info(strings: TemplateStringsArray, values: any[]) => void;
info(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
warn(message: any) => void;
warn(strings: TemplateStringsArray, values: any[]) => void;
warn(messageOrStrings: any | TemplateStringsArray, values: any[]) => void;
}
```
* Implements: <code><a href='/docs/next/api-reference/commandkit/interfaces/ilogger#ilogger'>ILogger</a></code>
Expand All @@ -34,29 +44,79 @@ class NoopLogger implements ILogger {

### debug

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a debug message.
### debug

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs a debug message using template literals.
### debug

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />


### error

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs an error message.
### error

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs an error message using template literals.
### error

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />


### log

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a default message.
### log

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs a default message using template literals.
### log

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />


### info

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs an info message.
### info

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs an info message using template literals.
### info

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />


### warn

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a warning message.
### warn

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs a warning message using template literals.
### warn

<MemberInfo kind="method" type={`(messageOrStrings: any | TemplateStringsArray, values: any[]) => void`} />




</div>
50 changes: 40 additions & 10 deletions apps/website/docs/api-reference/commandkit/interfaces/ilogger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,41 +19,71 @@ ILogger interface for logging functionality.

```ts title="Signature"
interface ILogger {
log(...args: any[]): void;
error(...args: any[]): void;
warn(...args: any[]): void;
info(...args: any[]): void;
debug(...args: any[]): void;
log(message: any): void;
log(strings: TemplateStringsArray, ...values: any[]): void;
error(message: any): void;
error(strings: TemplateStringsArray, ...values: any[]): void;
warn(message: any): void;
warn(strings: TemplateStringsArray, ...values: any[]): void;
info(message: any): void;
info(strings: TemplateStringsArray, ...values: any[]): void;
debug(message: any): void;
debug(strings: TemplateStringsArray, ...values: any[]): void;
}
```

<div className="members-wrapper">

### log

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a message with the default log level.
### log

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs a message with the default log level using template literals.
### error

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs an error message.
### error

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs an error message using template literals.
### warn

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a warning message.
### warn

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs a warning message using template literals.
### info

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs an informational message.
### info

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs an informational message using template literals.
### debug

<MemberInfo kind="method" type={`(args: any[]) => void`} />
<MemberInfo kind="method" type={`(message: any) => void`} />

Logs a debug message.
### debug

<MemberInfo kind="method" type={`(strings: TemplateStringsArray, values: any[]) => void`} />

Logs a debug message using template literals.


</div>
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';

## Logger

<GenerationInfo sourceFile="packages/commandkit/src/logger/Logger.ts" sourceLine="58" packageName="commandkit" />
<GenerationInfo sourceFile="packages/commandkit/src/logger/Logger.ts" sourceLine="59" packageName="commandkit" />

Default logger instance for CommandKit. This logger uses the DefaultLogger as its provider.
The provider can be replaced with a custom logger implementation using the `configure` method.
Expand Down
Loading
Loading