Add documentation #4
Open
Conversation
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
gingerbenw
force-pushed
the
PLAT-14031/vite-documentation
branch
from
0a06934 to
5b5251d
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR primarily adds documentation links for the build reporter and sourcemap uploader plugins while also performing some refactoring and cleanup in configuration handling and tests.
- Updated tests to use the package.json version and improved test descriptions.
- Refactored plugin configuration interfaces by replacing custom options with shared types from src/config.ts.
- Updated README to include new documentation links for both plugins.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test/source-map-uploader-plugin.test.ts | Updated import and configuration usage to reference the package.json version and improved test texts. |
| test/build-reporter-plugin.test.ts | Wrapped build call in a try/catch block to ignore unrelated errors and updated logging expectation. |
| src/source-map-uploader-plugin.ts | Refactored plugin configuration, removed production mode check, and updated upload options signature. |
| src/config.ts | Introduced shared configuration interfaces for consistency across plugins. |
| src/build-reporter-plugin.ts | Updated configuration type and target resolution for build reporting. |
| README.md | Added documentation sections with links for both plugins. |
Comments suppressed due to low confidence (1)
src/source-map-uploader-plugin.ts:15
- The removal of the production mode check means sourcemaps will now be uploaded in all builds, including non-production ones. If this change is intentional, please ensure the documentation is updated to reflect the new behavior.
// Removed production mode check, previously: if (enableSourcemapUploads) {
gingerbenw
commented
May 16, 2025
| @@ -0,0 +1,9 @@ | |||
| // re-map the log level option to match the bugsnag-cli log level | |||
| const getLogLevel = (logLevel: string | undefined) => { | |||
There was a problem hiding this comment.
@joshedney I've added a helper to ensure the provided log level matches the level in the cli
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Goal
Add links to Vite documentation on docs pages.
Config options re-validated with upload js docs