fix(create-rslib): remove rspress-js template#1464
Merged
Timeless0911 merged 1 commit intomainfrom Jan 30, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes the Rspress template for JavaScript (react-js) projects, keeping only the TypeScript variant. The change is motivated by the fact that Rspress's API documentation generation relies on react-docgen-typescript, which requires TypeScript type information to function properly.
Changes:
- Deleted all files in the
template-rspress/react-jsdirectory (rspress.config.js, package.json, and documentation files) - Updated
src/index.tsto restrict Rspress tool selection toreact-tstemplates only - Updated
template-rspress/AGENTS.mdto clarify that running the doc command also starts Rslib in watch mode
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/create-rslib/template-rspress/react-js/rspress.config.js | Deleted rspress configuration file for JavaScript template |
| packages/create-rslib/template-rspress/react-js/package.json | Deleted package.json for JavaScript rspress template |
| packages/create-rslib/template-rspress/react-js/docs/index.mdx | Deleted documentation index file |
| packages/create-rslib/template-rspress/react-js/docs/_meta.json | Deleted documentation metadata file |
| packages/create-rslib/template-rspress/react-js/docs/Button.mdx | Deleted Button component documentation |
| packages/create-rslib/template-rspress/AGENTS.md | Added clarification about Rslib watch mode starting with doc command |
| packages/create-rslib/src/index.ts | Updated condition to only allow rspress for react-ts templates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Rspress template only work on TypeScript since it based on types.
Related Links
Checklist