You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
fix(svgrloader): isolate SVG transforms from discovered SVGR configuration - #12926
If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.
Motivation
A scaffolded site prints that it is running, then the client bundle fails to compile. Inline SVGs are emitted with a TypeScript interface, and the bundler stops on SyntaxError: Unexpected reserved word 'interface'. The failure shows up when custom SVGR settings live in a directory above the site and turn on TypeScript output.
SVGR walks upward from each SVG and applies the first configuration file it finds, including one outside the site. createDefaultSVGRConfig left that search enabled, so a parent file with typescript: true was honored and the transform emitted TypeScript into the JavaScript client compile.
The default SVGR options now set runtimeConfig to false, which skips svgr.config.js in the site directory and in ancestor directories. Sites that still want file discovery pass svgrConfig with runtimeConfig true. The plugin docs record the new default and point configuration at the svgrConfig option. Loader tests cover a parent TypeScript config, that opt-in, a config inside the site, and a parent file that does not parse.
Test Plan
npx --no-install vitest run src/tests/svgrLoader.test.ts passed all 8 tests in @docusaurus/plugin-svgr.
The tests in packages/docusaurus-plugin-svgr/src/__tests__/svgrLoader.test.ts fail without the fix in the docusaurus createDefaultSVGRConfig change (checked by reverting the source changes).
…ation
The default SVGR options now set runtimeConfig to false, which skips
svgr.config.js in the site directory and in ancestor directories. Sites
that still want file discovery pass svgrConfig with runtimeConfig true.
The plugin docs record the new default and point configuration at the
svgrConfig option. Loader tests cover a parent TypeScript config, that
opt-in, a config inside the site, and a parent file that does not parse.
Fixesmeta#8646
No actionable comments were generated in the recent review.
Walkthrough
The SVGR plugin now disables runtime configuration-file discovery by default. Tests cover parent and site config files, malformed parent configs, and explicit opt-in. The plugin documentation describes the default and directs users to svgrConfig.
Changes: SVGR runtime config
Layer / File(s)
Summary
Default config and coverage packages/docusaurus-plugin-svgr/src/svgrLoader.ts, packages/docusaurus-plugin-svgr/src/__tests__/svgrLoader.test.ts, website/docs/api/plugins/plugin-svgr.mdx
The default sets runtimeConfig to false. Tests cover parent and site configs, malformed parent config, and enabling runtimeConfig. The documentation describes the default and directs users to svgrConfig.
The change disables automatic SVGR configuration discovery while retaining explicit opt-in. No merge-blocking issue is identified in the supplied evidence; merge after normal checks pass.
Pre-merge checks: 5
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title clearly describes the main change: preventing discovered SVGR configuration from affecting SVG transforms by default.
Linked Issues check
[#8646] The default SVGR configuration disables runtime file discovery, preventing the reported parent TypeScript configuration from breaking client compilation. Loader tests cover the parent configur…
Out of Scope Changes check
[#8646] The loader change addresses the reported failure. The tests verify the change and its opt-in. The documentation explains the new default and configuration option.
Docstring Coverage
Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Full details: Linked Issues check
Explanation
[#8646] The default SVGR configuration disables runtime file discovery, preventing the reported parent TypeScript configuration from breaking client compilation. Loader tests cover the parent configuration, explicit opt-in, site-local configuration, and a malformed parent configuration. The issue suggests logging as a possible solution; the default prevents the unintended configuration from being used.
Full details: Docstring Coverage
Explanation
Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 1 functions across 2 files. (1 skipped: 1 unsupported.)
Finishing Touches
Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.
This branch has not been deployed
No deployments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pre-flight checklist
Motivation
A scaffolded site prints that it is running, then the client bundle fails to compile. Inline SVGs are emitted with a TypeScript interface, and the bundler stops on SyntaxError: Unexpected reserved word 'interface'. The failure shows up when custom SVGR settings live in a directory above the site and turn on TypeScript output.
SVGR walks upward from each SVG and applies the first configuration file it finds, including one outside the site. createDefaultSVGRConfig left that search enabled, so a parent file with typescript: true was honored and the transform emitted TypeScript into the JavaScript client compile.
The default SVGR options now set runtimeConfig to false, which skips svgr.config.js in the site directory and in ancestor directories. Sites that still want file discovery pass svgrConfig with runtimeConfig true. The plugin docs record the new default and point configuration at the svgrConfig option. Loader tests cover a parent TypeScript config, that opt-in, a config inside the site, and a parent file that does not parse.
Test Plan
npx --no-install vitest run src/tests/svgrLoader.test.ts passed all 8 tests in @docusaurus/plugin-svgr.
The tests in
packages/docusaurus-plugin-svgr/src/__tests__/svgrLoader.test.tsfail without the fix in the docusaurus createDefaultSVGRConfig change (checked by reverting the source changes).Test links
Covered in the summary above.
Related issues/PRs
Closes #8646
AI was used for assistance.
Summary by CodeRabbit