Skip to content

[pull] main from facebook:main #172

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.

Sign up for GitHub

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

Merged
pull merged 2 commits into from
Sep 4, 2026
Merged

[pull] main from facebook:main #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7dfc679
chore: migrate from chalk to `node.utils.styleText()` (#12405)
slorber Sep 4, 2026
09947f3
docs: remove old versions of remark-math/rehype-katex on markdown plu…
slorber Sep 4, 2026
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
1 change: 0 additions & 1 deletion packages/docusaurus-logger/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
"license": "MIT",
"dependencies": {
"@docusaurus/types": "3.10.1",
"chalk": "^4.1.2",
"tslib": "^2.6.0"
},
"engines": {
Expand Down
8 changes: 4 additions & 4 deletions packages/docusaurus-logger/src/__tests__/__snapshots__/index.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`error > prints objects 1`] = `
exports[`logger > error > prints objects 1`] = `
[
[
"[ERROR] {"a":1}",
Expand All @@ -17,7 +17,7 @@ exports[`error > prints objects 1`] = `
]
`;

exports[`info > prints objects 1`] = `
exports[`logger > info > prints objects 1`] = `
[
[
"[INFO] {"a":1}",
Expand All @@ -34,7 +34,7 @@ exports[`info > prints objects 1`] = `
]
`;

exports[`success > prints objects 1`] = `
exports[`logger > success > prints objects 1`] = `
[
[
"[SUCCESS] {"a":1}",
Expand All @@ -51,7 +51,7 @@ exports[`success > prints objects 1`] = `
]
`;

exports[`warn > prints objects 1`] = `
exports[`logger > warn > prints objects 1`] = `
[
[
"[WARNING] {"a":1}",
Expand Down
265 changes: 137 additions & 128 deletions packages/docusaurus-logger/src/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,159 +5,168 @@
* LICENSE file in the root directory of this source tree.
*/

import {describe, expect, it, vi} from 'vitest';
import {afterAll, beforeAll, describe, expect, it, vi} from 'vitest';
import logger from '../index';

// Force chalk to ANSI level 3 in tests, so output is colored even in CI
vi.mock('chalk', async () => {
const chalk = await vi.importActual<typeof import('chalk')>('chalk');
return {default: new chalk.default.Instance({level: 3})};
});

describe('formatters', () => {
it('path', () => {
expect(logger.path('keepAnsi')).toMatchInlineSnapshot(
`"<cyan><underline>"keepAnsi"</underline></color>"`,
);
});
it('url', () => {
expect(logger.url('https://docusaurus.io/keepAnsi')).toMatchInlineSnapshot(
`"<cyan><underline>https://docusaurus.io/keepAnsi</underline></color>"`,
);
});
it('id', () => {
expect(logger.name('keepAnsi')).toMatchInlineSnapshot(
`"<blue><bold>keepAnsi</intensity></color>"`,
);
describe('logger', () => {
// Force chalk to ANSI level 3 in tests, so output is colored in snapshots
beforeAll(() => {
vi.stubEnv('FORCE_COLOR', '3');
});
it('code', () => {
expect(logger.code('keepAnsi')).toMatchInlineSnapshot(
`"<cyan>\`keepAnsi\`</color>"`,
);

afterAll(() => {
vi.unstubAllEnvs();
});
it('subdue', () => {
expect(logger.subdue('keepAnsi')).toMatchInlineSnapshot(
`"<gray>keepAnsi</color>"`,
);

describe('formatters', () => {
it('path', () => {
expect(logger.path('keepAnsi')).toMatchInlineSnapshot(
`"<cyan><underline>"keepAnsi"</underline></color>"`,
);
});
it('url', () => {
expect(
logger.url('https://docusaurus.io/keepAnsi'),
).toMatchInlineSnapshot(
`"<cyan><underline>https://docusaurus.io/keepAnsi</underline></color>"`,
);
});
it('id', () => {
expect(logger.name('keepAnsi')).toMatchInlineSnapshot(
`"<blue><bold>keepAnsi</intensity></color>"`,
);
});
it('code', () => {
expect(logger.code('keepAnsi')).toMatchInlineSnapshot(
`"<cyan>\`keepAnsi\`</color>"`,
);
});
it('subdue', () => {
expect(logger.subdue('keepAnsi')).toMatchInlineSnapshot(
`"<gray>keepAnsi</color>"`,
);
});
});
});

describe('interpolate', () => {
it('formats text with variables & arrays', () => {
const name = 'Josh';
const items = [1, 'hi', 'Hmmm'];
expect(
logger.interpolate`(keepAnsi) Hello ${name}! Here are your goodies:${items}`,
).toMatchInlineSnapshot(`
describe('interpolate', () => {
it('formats text with variables & arrays', () => {
const name = 'Josh';
const items = [1, 'hi', 'Hmmm'];
expect(
logger.interpolate`(keepAnsi) Hello ${name}! Here are your goodies:${items}`,
).toMatchInlineSnapshot(`
"(keepAnsi) Hello Josh! Here are your goodies:
- 1
- hi
- Hmmm"
`);
});
it('recognizes valid flags', () => {
expect(
logger.interpolate`(keepAnsi) The package at path=${'packages/docusaurus'} has number=${10} files. name=${'Babel'} is exported here subdue=${'(as a preset)'} that you can with code=${"require.resolve('@docusaurus/core/lib/babel/preset')"}`,
).toMatchInlineSnapshot(
`"(keepAnsi) The package at <cyan><underline>"packages/docusaurus"</underline></color> has <yellow>10</color> files. <blue><bold>Babel</intensity></color> is exported here <gray>(as a preset)</color> that you can with <cyan>\`require.resolve('@docusaurus/core/lib/babel/preset')\`</color>"`,
);
});
it('interpolates arrays with flags', () => {
expect(
logger.interpolate`(keepAnsi) The following commands are available:code=${[
'docusaurus start',
'docusaurus build',
'docusaurus deploy',
]}`,
).toMatchInlineSnapshot(`
});
it('recognizes valid flags', () => {
expect(
logger.interpolate`(keepAnsi) The package at path=${'packages/docusaurus'} has number=${10} files. name=${'Babel'} is exported here subdue=${'(as a preset)'} that you can with code=${"require.resolve('@docusaurus/core/lib/babel/preset')"}`,
).toMatchInlineSnapshot(
`"(keepAnsi) The package at <cyan><underline>"packages/docusaurus"</underline></color> has <yellow>10</color> files. <blue><bold>Babel</intensity></color> is exported here <gray>(as a preset)</color> that you can with <cyan>\`require.resolve('@docusaurus/core/lib/babel/preset')\`</color>"`,
);
});
it('interpolates arrays with flags', () => {
expect(
logger.interpolate`(keepAnsi) The following commands are available:code=${[
'docusaurus start',
'docusaurus build',
'docusaurus deploy',
]}`,
).toMatchInlineSnapshot(`
"(keepAnsi) The following commands are available:
- <cyan>\`docusaurus start\`</color>
- <cyan>\`docusaurus build\`</color>
- <cyan>\`docusaurus deploy\`</color>"
`);
});
it('prints detached flags as-is', () => {
expect(
logger.interpolate`(keepAnsi) You can use placeholders like code= ${'and it will'} be replaced with the succeeding arguments`,
).toMatchInlineSnapshot(
`"(keepAnsi) You can use placeholders like code= and it will be replaced with the succeeding arguments"`,
);
});
it('throws with bad flags', () => {
expect(
() =>
logger.interpolate`(keepAnsi) I mistyped this: cde=${'this code'} and I will be damned`,
).toThrowErrorMatchingInlineSnapshot(
`[Error: Bad Docusaurus logging message. This is likely an internal bug, please report it.]`,
);
});
});
it('prints detached flags as-is', () => {
expect(
logger.interpolate`(keepAnsi) You can use placeholders like code= ${'and it will'} be replaced with the succeeding arguments`,
).toMatchInlineSnapshot(
`"(keepAnsi) You can use placeholders like code= and it will be replaced with the succeeding arguments"`,
);
});
it('throws with bad flags', () => {
expect(
() =>
logger.interpolate`(keepAnsi) I mistyped this: cde=${'this code'} and I will be damned`,
).toThrowErrorMatchingInlineSnapshot(
`[Error: Bad Docusaurus logging message. This is likely an internal bug, please report it.]`,
);
});
});

describe('info', () => {
it('prints objects', () => {
using info = vi.spyOn(console, 'info');
logger.info({a: 1});
logger.info(undefined);
logger.info([1, 2, 3]);
logger.info(new Date(2021, 10, 13));
expect(info.mock.calls).toMatchSnapshot();
describe('info', () => {
it('prints objects', () => {
using info = vi.spyOn(console, 'info');
logger.info({a: 1});
logger.info(undefined);
logger.info([1, 2, 3]);
logger.info(new Date(2021, 10, 13));
expect(info.mock.calls).toMatchSnapshot();
});
});
});

describe('warn', () => {
it('prints objects', () => {
using warn = vi.spyOn(console, 'warn');
logger.warn({a: 1});
logger.warn(undefined);
logger.warn([1, 2, 3]);
logger.warn(new Date(2021, 10, 13));
expect(warn.mock.calls).toMatchSnapshot();
describe('warn', () => {
it('prints objects', () => {
using warn = vi.spyOn(console, 'warn');
logger.warn({a: 1});
logger.warn(undefined);
logger.warn([1, 2, 3]);
logger.warn(new Date(2021, 10, 13));
expect(warn.mock.calls).toMatchSnapshot();
});
});
});

describe('error', () => {
it('prints objects', () => {
using error = vi.spyOn(console, 'error');
logger.error({a: 1});
logger.error(undefined);
logger.error([1, 2, 3]);
logger.error(new Date(2021, 10, 13));
expect(error.mock.calls).toMatchSnapshot();
describe('error', () => {
it('prints objects', () => {
using error = vi.spyOn(console, 'error');
logger.error({a: 1});
logger.error(undefined);
logger.error([1, 2, 3]);
logger.error(new Date(2021, 10, 13));
expect(error.mock.calls).toMatchSnapshot();
});
});
});

describe('success', () => {
it('prints objects', () => {
using log = vi.spyOn(console, 'log');
logger.success({a: 1});
logger.success(undefined);
logger.success([1, 2, 3]);
logger.success(new Date(2021, 10, 13));
expect(log.mock.calls).toMatchSnapshot();
describe('success', () => {
it('prints objects', () => {
using log = vi.spyOn(console, 'log');
logger.success({a: 1});
logger.success(undefined);
logger.success([1, 2, 3]);
logger.success(new Date(2021, 10, 13));
expect(log.mock.calls).toMatchSnapshot();
});
});
});

describe('report', () => {
it('works with all severities', () => {
using log = vi.spyOn(console, 'info');
using warn = vi.spyOn(console, 'warn');
logger.report('ignore')('hey');
logger.report('log')('hey');
logger.report('warn')('hey');
expect(() =>
logger.report('throw')('hey'),
).toThrowErrorMatchingInlineSnapshot(`[Error: hey]`);
expect(() =>
// @ts-expect-error: for test
logger.report('foo')('hey'),
).toThrowErrorMatchingInlineSnapshot(
`[Error: Unexpected "reportingSeverity" value: foo.]`,
);
expect(log).toHaveBeenCalledTimes(1);
expect(log).toHaveBeenCalledWith(expect.stringMatching(/.*\[INFO\].* hey/));
expect(warn).toHaveBeenCalledTimes(1);
expect(warn).toHaveBeenCalledWith(
expect.stringMatching(/.*\[WARNING\].* hey/),
);
describe('report', () => {
it('works with all severities', () => {
using log = vi.spyOn(console, 'info');
using warn = vi.spyOn(console, 'warn');
logger.report('ignore')('hey');
logger.report('log')('hey');
logger.report('warn')('hey');
expect(() =>
logger.report('throw')('hey'),
).toThrowErrorMatchingInlineSnapshot(`[Error: hey]`);
expect(() =>
// @ts-expect-error: for test
logger.report('foo')('hey'),
).toThrowErrorMatchingInlineSnapshot(
`[Error: Unexpected "reportingSeverity" value: foo.]`,
);
expect(log).toHaveBeenCalledTimes(1);
expect(log).toHaveBeenCalledWith(
expect.stringMatching(/.*\[INFO\].* hey/),
);
expect(warn).toHaveBeenCalledTimes(1);
expect(warn).toHaveBeenCalledWith(
expect.stringMatching(/.*\[WARNING\].* hey/),
);
});
});
});
Loading
Loading