docs: add filename placeholders documentation#12301
Merged
chenjiahan merged 6 commits intomainfrom Nov 26, 2025
Merged
Conversation
✅ Deploy Preview for rspack 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 adds comprehensive documentation for filename placeholders in Rspack by creating a new dedicated page that consolidates and expands upon the previous "Template string" section from the output configuration page. The documentation is provided in both English and Chinese, improving developer understanding of how to use placeholders for dynamic filename generation in builds.
- Introduces a new
/config/filename-placeholdersdocumentation page explaining all available placeholder types and their usage - Removes the "Template string" section from the output configuration page and replaces internal references with links to the new dedicated page
- Updates examples to use more practical patterns (e.g.,
[contenthash:8].wasminstead of[id].[hash].wasm)
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/config/filename-placeholders.mdx | New documentation page for filename placeholders in English |
| website/docs/zh/config/filename-placeholders.mdx | New documentation page for filename placeholders in Chinese |
| website/docs/en/config/output.mdx | Removes "Template string" section, adds links to new placeholders page, updates examples |
| website/docs/zh/config/output.mdx | Removes "Template string" section, adds links to new placeholders page, updates examples |
| website/docs/en/config/_meta.json | Adds filename-placeholders to navigation menu |
| website/docs/zh/config/_meta.json | Adds filename-placeholders to navigation menu |
| website/docs/en/api/javascript-api/compilation.mdx | Updates references from "Template String" to "Filename placeholders" |
| website/docs/zh/api/javascript-api/compilation.mdx | Updates references from "Template String" to "Filename placeholders" |
| website/project-words.txt | Adds "qwertyui" (used in documentation examples) to spell check dictionary |
| crates/rspack_core/src/options/filename.rs | Updates code comment from "template string" to "placeholders" for consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
LingyuCoder
previously approved these changes
Nov 26, 2025
Contributor
📦 Binary Size-limit
🙈 Size remains the same at 47.67MB |
CodSpeed Performance ReportMerging #12301 will not alter performanceComparing Summary
Footnotes |
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
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.
Summary
Add documentation to introduce all filename placeholders.
The document content has been rewritten based on the original "Template string" section and additional content has been added for explanation.
Related links
[name]placeholder in webassemblyModuleFilename is rendered incorrectly #11351Checklist