Skip to content

Comments

docs: align dev config JSDoc with documentation#6586

Merged
chenjiahan merged 1 commit intomainfrom
codex/update-jsdoc-for-rsbuild-config-options
Nov 16, 2025
Merged

docs: align dev config JSDoc with documentation#6586
chenjiahan merged 1 commit intomainfrom
codex/update-jsdoc-for-rsbuild-config-options

Conversation

@chenjiahan
Copy link
Member

Summary

  • update dev configuration JSDoc to match current documentation defaults
  • clarify lazy compilation, asset prefix, CLI shortcuts, and watch files comments

Testing

  • not run

Codex Task

Copilot AI review requested due to automatic review settings November 15, 2025 11:29
@netlify
Copy link

netlify bot commented Nov 15, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 046ed25
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/69186418dbaa1a0008f2bcf1
😎 Deploy Preview https://deploy-preview-6586--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 66 (🔴 down 5 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

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

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 updates JSDoc comments in the development configuration types to align with the current documentation, improving clarity and consistency for developers using these APIs.

  • Added comprehensive JSDoc documentation for WatchFiles type properties
  • Clarified browserLogs description to mention both window errors and Promise rejections
  • Added default value annotations for several properties to match documentation
  • Updated lazyCompilation description and default value to reflect current behavior

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chenjiahan chenjiahan merged commit dce4be0 into main Nov 16, 2025
18 checks passed
@chenjiahan chenjiahan deleted the codex/update-jsdoc-for-rsbuild-config-options branch November 16, 2025 02:58
@chenjiahan chenjiahan mentioned this pull request Nov 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant