Error messages set to vfile
by Remark plugins are not reported.
#9953
Labels
bug
An error in the Docusaurus core causing instability or issues with its execution
domain: markdown
Related to Markdown parsing or syntax
Have you read the Contributing Guidelines on issues?
Prerequisites
npm run clear
oryarn clear
command.rm -rf node_modules yarn.lock package-lock.json
and re-installing packages.Description
Remark plugins need to issue warnings and create errors when processing mdx files. They can do so using the vfile.message mechanism already.
The messages can be reported with the vfile-reporter utility. The
reporter
presents the messages in a convenient way, grouping messages by file and linking each error to the reported line and column number in the mdx document.However, when Docusaurus applies a Remark plugin to a mdx document, it doesn't report the warnings and errors.
I can kind of get around it by writing a new Remark plugin, and putting it at the end of the pipeline:
but this is not very neat as the plugins are executed multiple times during
docusaurus start
and it relentlessly spams the terminal. To experience this, uncomment the[require("./plugins/plugin-reporting.js"), {}],
line (line 51, docusaurus.config.js) in the bug repro.Reproducible demo
https://codesandbox.io/p/devbox/priceless-meadow-dq4n4h?file=%2Fplugins%2Fplugin-erroring.js%3A3%2C59
Steps to reproduce
In any remark plugin, add a
vfile.message("message")
line. It should show up but doesn't.Check the codesandbox repro for demo.
Expected behavior
I expect the messages that the Remark plugins set on vfiles are reported by Docusaurus either by default or as a simple config toggle.
Actual behavior
The messages are never shown.
Your environment
Self-service
The text was updated successfully, but these errors were encountered: