Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: bump rslog to support customize logger #1146

Merged
merged 7 commits into from
Jan 2, 2024
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
17 changes: 17 additions & 0 deletions e2e/cases/javascript-api/custom-logger/index.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import { build } from '@scripts/shared';
import { rspackOnlyTest, proxyConsole } from '@scripts/helper';

rspackOnlyTest('should allow to customize logger', async () => {
const { logs, restore } = proxyConsole('log');

await build({
cwd: __dirname,
});

expect(
logs.find((item) => item.includes('[READY] Client compiled in')),
).toBeTruthy();

restore();
});
22 changes: 22 additions & 0 deletions e2e/cases/javascript-api/custom-logger/rsbuild.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { logger, defineConfig } from '@rsbuild/core';

const defaultReady = logger.ready;

logger.override({
ready: (message) => {
console.log(`[READY] ${message}`);
},
});

export default defineConfig({
plugins: [
{
name: 'restore-logger',
setup(api) {
api.onAfterBuild(() => {
logger.ready = defaultReady;
});
},
},
],
});
1 change: 1 addition & 0 deletions e2e/cases/javascript-api/custom-logger/src/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
console.log('1');
2 changes: 1 addition & 1 deletion packages/create-rsbuild/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
},
"dependencies": {
"@clack/prompts": "^0.7.0",
"rslog": "^1.1.3"
"rslog": "^1.2.0"
},
"devDependencies": {
"@types/node": "16.x",
Expand Down
39 changes: 39 additions & 0 deletions packages/document/docs/en/api/javascript-api/core.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,42 @@ logger.debug('This is a debug message');
// Same as console.log
logger.log('This is a log message');
```

### Custom Logger

You can use the `logger.override` method to override partial or all methods of the default logger:

```ts
import { logger } from '@rsbuild/core';

logger.override({
log: (message) => {
console.log(`[log] ${message}`);
},
info: (message) => {
console.log(`[info] ${message}`);
},
warn: (message) => {
console.warn(`[warn] ${message}`);
},
start: (message) => {
console.log(`[start] ${message}`);
},
ready: (message) => {
console.log(`[ready] ${message}`);
},
error: (message) => {
console.error(`[error] ${message}`);
},
success: (message) => {
console.error(`[success] ${message}`);
},
debug: (message) => {
if (process.env.DEBUG) {
console.log(`[debug] ${message}`);
}
},
});

logger.info('hello'); // [info] hello
```
39 changes: 39 additions & 0 deletions packages/document/docs/zh/api/javascript-api/core.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,42 @@ logger.debug('This is a debug message');
// Same as console.log
logger.log('This is a log message');
```

### 自定义 Logger

你可以使用 `logger.override` 方法来覆盖默认 logger 的部分或全部方法:

```ts
import { logger } from '@rsbuild/core';

logger.override({
log: (message) => {
console.log(`[log] ${message}`);
},
info: (message) => {
console.log(`[info] ${message}`);
},
warn: (message) => {
console.warn(`[warn] ${message}`);
},
start: (message) => {
console.log(`[start] ${message}`);
},
ready: (message) => {
console.log(`[ready] ${message}`);
},
error: (message) => {
console.error(`[error] ${message}`);
},
success: (message) => {
console.error(`[success] ${message}`);
},
debug: (message) => {
if (process.env.DEBUG) {
console.log(`[debug] ${message}`);
}
},
});

logger.info('hello'); // [info] hello
```
3 changes: 2 additions & 1 deletion packages/shared/compiled/rslog/dist/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ declare let LOG_TYPES: {
};

type LogLevel = 'error' | 'warn' | 'info' | 'log' | 'verbose';
type LogMessage = number | string | unknown | Error | null;
type LogMessage = unknown;
interface LogType {
label?: string;
level: LogLevel;
Expand All @@ -56,6 +56,7 @@ type LogMethods = keyof typeof LOG_TYPES;
type Logger = Record<LogMethods, LogFunction> & {
greet: (message: string) => void;
level: LogLevel;
override: (customLogger: Partial<Record<LogMethods, LogFunction>>) => void;
};

declare let createLogger: (options?: Options) => Logger;
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/compiled/rslog/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/shared/compiled/rslog/package.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"name":"rslog","version":"1.1.3","types":"./dist/index.d.ts","type":"commonjs"}
{"name":"rslog","version":"1.2.0","types":"./dist/index.d.ts","type":"commonjs"}
16 changes: 8 additions & 8 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion scripts/prebundle/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"semver": "^7.5.4",
"style-loader": "3.3.3",
"toml-loader": "1.0.0",
"rslog": "^1.1.3",
"rslog": "^1.2.0",
"sirv": "^2.0.3",
"webpack-bundle-analyzer": "4.9.0",
"webpack-chain": "npm:webpack-5-chain@8.0.1",
Expand Down