-
-
Notifications
You must be signed in to change notification settings - Fork 746
docs: enhance ignoreWarnings option with detailed examples
#12436
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for rspack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR enhances the ignoreWarnings configuration option documentation by replacing the simple PropertyType component with comprehensive documentation that includes detailed type definitions, explanations, and usage examples. The changes update both English and Chinese documentation files to provide developers with clearer guidance on how to use the three different forms of warning suppression: RegExp, object, and function.
Key Changes
- Replaced inline
PropertyTypecomponent with explicit TypeScript type definition including the previously undocumented object type - Added three progressive examples demonstrating RegExp, object-based, and function-based warning filtering patterns
- Enhanced descriptions explaining when and how to use each pattern
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| website/docs/en/config/other-options.mdx | Enhanced ignoreWarnings documentation with type definitions and usage examples in English |
| website/docs/zh/config/other-options.mdx | Enhanced ignoreWarnings documentation with type definitions and usage examples in Chinese |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CodSpeed Performance ReportMerging #12436 will not alter performanceComparing Summary
Footnotes |
📦 Binary Size-limit
🙈 Size remains the same at 48.20MB |
Rsdoctor Bundle Diff AnalysisFound 5 project(s) in monorepo. 📁 react-10kPath:
📦 Download Diff Report: react-10k Bundle Diff 📁 react-1kPath:
📦 Download Diff Report: react-1k Bundle Diff 📁 romePath:
📦 Download Diff Report: rome Bundle Diff 📁 react-5kPath:
📦 Download Diff Report: react-5k Bundle Diff 📁 ui-componentsPath:
📦 Download Diff Report: ui-components Bundle Diff Generated by Rsdoctor GitHub Action |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
ignoreWarningsoption with detailed and usage examples.Checklist