Skip to content

feat(create-rslib): add Rspress documentation tool templates#1459

Merged
SoonIter merged 2 commits intomainfrom
feat/add-rspress-templates
Jan 29, 2026
Merged

feat(create-rslib): add Rspress documentation tool templates#1459
SoonIter merged 2 commits intomainfrom
feat/add-rspress-templates

Conversation

@SoonIter
Copy link
Copy Markdown
Member

Summary

  • Add Rspress as a documentation tool option for React templates in create-rslib
  • Support all template combinations: rspress-only, rspress+rstest, rspress+storybook, rspress+vitest, rspress+rstest+storybook, rspress+storybook+vitest
  • Include both JS and TS variants for each combination
  • Add rspress fragments and update helpers/index to support the new tool option

Test plan

  • Verify create-rslib CLI offers Rspress as a documentation tool option
  • Test generating projects with each Rspress template combination
  • Verify generated projects build and run correctly
  • Run existing tests with pnpm test

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings January 29, 2026 05:59
Copy link
Copy Markdown
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 adds Rspress as a documentation tool option for React templates in create-rslib, expanding the available tooling options for library developers.

Changes:

  • Added Rspress as a selectable documentation tool option in the CLI for React templates
  • Created 12 new template combinations supporting Rspress with various testing and documentation tools (rstest, vitest, storybook)
  • Added comprehensive test coverage for all new Rspress template combinations

Reviewed changes

Copilot reviewed 230 out of 232 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/create-rslib/src/index.ts Added Rspress option to the CLI tool selection menu for React templates
packages/create-rslib/src/helpers.ts Registered 12 new template combinations with Rspress support for both JS and TS variants
packages/create-rslib/test/index.test.ts Added test cases for all 12 new Rspress template combinations
packages/create-rslib/fragments/tools/rspress-react-ts/* Created Rspress fragment files for TypeScript React projects including config, docs, and AGENTS.md
packages/create-rslib/fragments/tools/rspress-react-js/* Created Rspress fragment files for JavaScript React projects
packages/create-rslib/template-[react]-[rspress]-/ Created standalone Rspress templates for both JS and TS variants
packages/create-rslib/template-[react]-[rspress,]-/* Created combined templates supporting Rspress with rstest, vitest, and/or storybook

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

Copy link
Copy Markdown
Member

@fi3ework fi3ework left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

too much files updated, i think it's time for us to make template- ignored by git and only ship them to npm 🤔

@Timeless0911
Copy link
Copy Markdown
Contributor

too much files updated, i think it's time for us to make template- ignored by git and only ship them to npm 🤔

Already WIP

@SoonIter SoonIter force-pushed the feat/add-rspress-templates branch from 43c25fb to 64bc1f8 Compare January 29, 2026 06:54
@SoonIter SoonIter requested a review from fi3ework January 29, 2026 06:56
@SoonIter SoonIter force-pushed the feat/add-rspress-templates branch from 64bc1f8 to 6d6f1e5 Compare January 29, 2026 06:57
@SoonIter SoonIter requested a review from Timeless0911 January 29, 2026 07:22
@SoonIter SoonIter enabled auto-merge (squash) January 29, 2026 07:44
@SoonIter SoonIter force-pushed the feat/add-rspress-templates branch from 6d6f1e5 to 4192143 Compare January 29, 2026 08:15
@SoonIter SoonIter force-pushed the feat/add-rspress-templates branch from 4192143 to b670764 Compare January 29, 2026 08:40
@SoonIter SoonIter merged commit 9d614e4 into main Jan 29, 2026
11 checks passed
@SoonIter SoonIter deleted the feat/add-rspress-templates branch January 29, 2026 08:57
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.

4 participants