fix: validate environment names for safety #5328
Merged
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
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces environment name validation to ensure that only safe characters (letters, numbers, _, -, and $) are used when naming environments. It also updates related documentation and adjusts output file naming and configuration IDs accordingly.
- Added documentation in both English and Chinese to describe safe environment naming.
- Implemented a validation check in the core provider to warn on invalid environment names.
- Updated output file naming in the inspectConfig module and standardized configuration IDs in rslib.config.ts.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/zh/config/environments.mdx | Added Chinese documentation on environment naming guidelines. |
| website/docs/en/config/environments.mdx | Added English documentation on environment naming guidelines. |
| packages/core/src/provider/initConfigs.ts | Added a regex check with corresponding warning when an environment name is unsafe. |
| packages/core/src/inspectConfig.ts | Removed sanitization of environment and bundler config names for output files, now using the provided names directly. |
| packages/core/rslib.config.ts | Changed configuration IDs from colon-delimited to underscore-delimited values. |
Comments suppressed due to low confidence (1)
packages/core/rslib.config.ts:75
- The configuration ID was changed from 'esm:index' to 'esm_index'. Please confirm that this change will not inadvertently affect any consumers that may depend on the original ID format.
id: 'esm_index',
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Added validation to ensure environment names are safe for filesystem and property access. Only letters, numbers,
_,-and$are now allowed in environment names. Invalid names trigger a warning.Related Links
Checklist