Skip to content

fix(mdx-loader): suppress image reading warning in Yarn PnP; log warning instead of error #6779

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
Josh-Cena merged 1 commit into from
Feb 28, 2022
Merged

fix(mdx-loader): suppress image reading warning in Yarn PnP; log warning instead of error #6779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ describe('transformImage plugin', () => {
});

test('does not choke on invalid image', async () => {
const errorMock = jest.spyOn(console, 'error').mockImplementation();
const errorMock = jest.spyOn(console, 'warn').mockImplementation();
const result = await processFixture('invalid-img', {staticDirs});
expect(result).toMatchSnapshot();
expect(errorMock).toBeCalledTimes(1);
Expand Down
6 changes: 5 additions & 1 deletion packages/docusaurus-mdx-loader/src/remark/transformImage/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,12 @@ async function toImageRequireNode(
height = ` height="${size.height}"`;
}
} catch (err) {
logger.error`The image at path=${imagePath} can't be read correctly. Please ensure it's a valid image.
// Workaround for https://github.com/yarnpkg/berry/pull/3889#issuecomment-1034469784
// TODO remove this check once fixed in Yarn PnP
if (!process.versions.pnp) {
logger.warn`The image at path=${imagePath} can't be read correctly. Please ensure it's a valid image.
${(err as Error).message}`;
}
}

Object.keys(jsxNode).forEach(
Expand Down