Skip to content

Conversation

@chenjiahan
Copy link
Member

Summary

  • Enhance ignoreWarnings option with detailed and usage examples.
  • Fix the type definitions, include the object type.

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings December 12, 2025 14:28
@netlify
Copy link

netlify bot commented Dec 12, 2025

Deploy Preview for rspack ready!

Name Link
🔨 Latest commit e6ab3e5
🔍 Latest deploy log https://app.netlify.com/projects/rspack/deploys/693cd854982ff90008124df6
😎 Deploy Preview https://deploy-preview-12436--rspack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added release: document release: document related release(mr only) team The issue/pr is created by the member of Rspack. labels Dec 12, 2025
@chenjiahan chenjiahan requested a review from hardfist as a code owner December 12, 2025 14:28
Copy link
Contributor

Copilot AI left a 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 PropertyType component 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-hq
Copy link

codspeed-hq bot commented Dec 12, 2025

CodSpeed Performance Report

Merging #12436 will not alter performance

Comparing ignore_warnings_doc_1212 (e6ab3e5) with main (6f3f4de)1

Summary

✅ 17 untouched

Footnotes

  1. No successful run was found on main (19c6cd7) during the generation of this report, so 6f3f4de was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

📦 Binary Size-limit

Comparing e6ab3e5 to chore: bump swc_experimental to fix parsing utf8 in template (#12431) by CPunisher

🙈 Size remains the same at 48.20MB

@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

Rsdoctor Bundle Diff Analysis

Found 5 project(s) in monorepo.

📁 react-10k

Path: ../build-tools-performance/cases/react-10k/dist/rsdoctor-data.json

📌 Baseline Commit: 19c6cd719b | PR: #12432

Metric Current Baseline Change
📊 Total Size 5.7 MB 5.7 MB 0 B (0.0%)
📄 JavaScript 5.7 MB 5.7 MB 0 B (0.0%)
🎨 CSS 21.0 B 21.0 B 0 B (0.0%)
🌐 HTML 0 B 0 B N/A
📁 Other Assets 0 B 0 B N/A

📦 Download Diff Report: react-10k Bundle Diff

📁 react-1k

Path: ../build-tools-performance/cases/react-1k/dist/rsdoctor-data.json

📌 Baseline Commit: 19c6cd719b | PR: #12432

Metric Current Baseline Change
📊 Total Size 823.6 KB 823.6 KB 0 B (0.0%)
📄 JavaScript 823.6 KB 823.6 KB 0 B (0.0%)
🎨 CSS 0 B 0 B N/A
🌐 HTML 0 B 0 B N/A
📁 Other Assets 0 B 0 B N/A

📦 Download Diff Report: react-1k Bundle Diff

📁 rome

Path: ../build-tools-performance/cases/rome/dist/rsdoctor-data.json

📌 Baseline Commit: 19c6cd719b | PR: #12432

Metric Current Baseline Change
📊 Total Size 984.3 KB 984.3 KB 0 B (0.0%)
📄 JavaScript 984.3 KB 984.3 KB 0 B (0.0%)
🎨 CSS 0 B 0 B N/A
🌐 HTML 0 B 0 B N/A
📁 Other Assets 0 B 0 B N/A

📦 Download Diff Report: rome Bundle Diff

📁 react-5k

Path: ../build-tools-performance/cases/react-5k/dist/rsdoctor-data.json

📌 Baseline Commit: 19c6cd719b | PR: #12432

Metric Current Baseline Change
📊 Total Size 2.7 MB 2.7 MB 0 B (0.0%)
📄 JavaScript 2.7 MB 2.7 MB 0 B (0.0%)
🎨 CSS 21.0 B 21.0 B 0 B (0.0%)
🌐 HTML 0 B 0 B N/A
📁 Other Assets 0 B 0 B N/A

📦 Download Diff Report: react-5k Bundle Diff

📁 ui-components

Path: ../build-tools-performance/cases/ui-components/dist/rsdoctor-data.json

📌 Baseline Commit: 19c6cd719b | PR: #12432

Metric Current Baseline Change
📊 Total Size 2.1 MB 2.1 MB 0 B (0.0%)
📄 JavaScript 2.0 MB 2.0 MB 0 B (0.0%)
🎨 CSS 83.0 KB 83.0 KB 0 B (0.0%)
🌐 HTML 0 B 0 B N/A
📁 Other Assets 0 B 0 B N/A

📦 Download Diff Report: ui-components Bundle Diff

Generated by Rsdoctor GitHub Action

chenjiahan and others added 3 commits December 13, 2025 11:06
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>
@chenjiahan chenjiahan requested review from SyMind and removed request for hardfist December 13, 2025 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release: document release: document related release(mr only) team The issue/pr is created by the member of Rspack.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants