chore(deps): update dependency @rspress/plugin-preview to v2.0.0-rc.2 #1218

Open
renovate wants to merge 1 commit from renovate/rspress-plugin-preview-2.x-lockfile into main
Collaborator

This PR contains the following updates:

Package Change Age Confidence
@rspress/plugin-preview (source) 2.0.0-rc.1 -> 2.0.0-rc.2 age confidence

Release Notes

web-infra-dev/rspress (@​rspress/plugin-preview)

v2.0.0-rc.2

Compare Source

Breaking Changes🚨
theme folder should use @rspress/core/theme-original

related PR: #​2860

In Rspress V1 document, @theme is the alias for rspress/theme, but @theme is an alias which points to theme/index.tsx and falls back to rspress/theme.

rspress/theme or @rspress/core/theme points to Rspress's theme-default, they are actually different things.

We standardize this behavior, which is the same as docusaurus.

  1. In docs directory, @theme or @rspress/core/theme should be used, which points to theme/index.tsx and falls back to theme-default

  2. In theme directory , @theme-original or @rspress/core/theme-original should be used, which always points to Rspress's theme-default, used for users to customize themes, which is very useful for users who publish npm theme packages.

 // theme/index.tsx
- import { Layout as BasicLayout } from 'rspress/theme'; // or @​rspress/core/theme
+ import { Layout } from '@​rspress/core/theme-original';

 const Layout = () => {
    return <BasicLayout {...} />
 }
 
 export { Layout }
- export * from 'rspress/theme' // or @&#8203;rspress/core/theme
+ export * from '@&#8203;rspress/core/theme-original';
Merge @theme-assets to @theme

Before

We have a separate entry for exporting @​theme-assets

import { SvgWrapper } from '@&#8203;theme'
import SearchSvg from '@&#8203;theme-assets/Search';

<SvgWrapper icon={SearchSvg} />

After

@theme-assets has been removed. Icons are exported from @theme and prefixed with Icon, for example: IconSearch

import { SvgWrapper, IconSearch } from '@&#8203;theme';

<SvgWrapper icon={IconSearch} />
                   ^? type Icon = React.FC<React.SVGProps<SVGSVGElement>> | string;
Refactor @rspress/plugin-preview and simplify usage

related PR: #​2806

Before: Required declarations in both config file and MDX file.

pluginPreview({
  previewMode: 'iframe',
  iframeOptions: { position: 'fixed' },
});
```tsx preview

```

After: Only declare in the MDX file.

```tsx preview="iframe-fixed"

```
What's Changed
New Features 🎉
Performance 🚀
  • perf(theme/useWindowSize): optimize useWindowSize with debounce to reduce resize handler calls by @​Copilot in #​2849
Bug Fixes 🐞
Document 📖
Other Changes
New Contributors

Full Changelog: https://github.com/web-infra-dev/rspress/compare/v2.0.0-rc.1...v2.0.0-rc.2


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [@rspress/plugin-preview](https://github.com/web-infra-dev/rspress) ([source](https://github.com/web-infra-dev/rspress/tree/HEAD/packages/plugin-preview)) | [`2.0.0-rc.1` -> `2.0.0-rc.2`](https://renovatebot.com/diffs/npm/@rspress%2fplugin-preview/2.0.0-rc.1/2.0.0-rc.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@rspress%2fplugin-preview/2.0.0-rc.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@rspress%2fplugin-preview/2.0.0-rc.1/2.0.0-rc.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>web-infra-dev/rspress (@&#8203;rspress/plugin-preview)</summary> ### [`v2.0.0-rc.2`](https://github.com/web-infra-dev/rspress/releases/tag/v2.0.0-rc.2) [Compare Source](https://github.com/web-infra-dev/rspress/compare/v2.0.0-rc.1...v2.0.0-rc.2) <!-- Release notes generated using configuration in .github/release.yml at main --> ##### Breaking Changes🚨 ##### `theme` folder should use `@rspress/core/theme-original` > related PR: [#&#8203;2860](https://github.com/web-infra-dev/rspress/pull/2860) In Rspress V1 document, `@theme` is the alias for `rspress/theme`, but `@theme` is an alias which points to `theme/index.tsx` and falls back to `rspress/theme`. `rspress/theme` or `@rspress/core/theme` points to Rspress's `theme-default`, they are actually different things. We standardize this behavior, which is the same as docusaurus. 1. In `docs` directory, `@theme` or `@rspress/core/theme` should be used, which points to `theme/index.tsx` and falls back to `theme-default` 2. In `theme` directory , `@theme-original` or `@rspress/core/theme-original` should be used, which always points to Rspress's `theme-default`, used for users to customize themes, which is very useful for users who publish npm theme packages. ```diff // theme/index.tsx - import { Layout as BasicLayout } from 'rspress/theme'; // or @&#8203;rspress/core/theme + import { Layout } from '@&#8203;rspress/core/theme-original'; const Layout = () => { return <BasicLayout {...} /> } export { Layout } - export * from 'rspress/theme' // or @&#8203;rspress/core/theme + export * from '@&#8203;rspress/core/theme-original'; ``` ##### Merge `@theme-assets` to `@theme` **Before** We have a separate entry for exporting [@&#8203;theme-assets](https://github.com/theme-assets) ```tsx import { SvgWrapper } from '@&#8203;theme' import SearchSvg from '@&#8203;theme-assets/Search'; <SvgWrapper icon={SearchSvg} /> ``` **After** `@theme-assets` has been removed. Icons are exported from `@theme` and prefixed with `Icon`, for example: `IconSearch` ```tsx import { SvgWrapper, IconSearch } from '@&#8203;theme'; <SvgWrapper icon={IconSearch} /> ^? type Icon = React.FC<React.SVGProps<SVGSVGElement>> | string; ``` ##### Refactor `@rspress/plugin-preview` and simplify usage > related PR: [#&#8203;2806](https://github.com/web-infra-dev/rspress/pull/2806) **Before: Required declarations in both config file and MDX file.** ```ts pluginPreview({ previewMode: 'iframe', iframeOptions: { position: 'fixed' }, }); ``` ````mdx ```tsx preview ``` ```` **After: Only declare in the MDX file.** ````mdx ```tsx preview="iframe-fixed" ``` ```` ##### What's Changed ##### New Features 🎉 - feat(plugin-preview)!: simplify the usage via `tsx preview="iframe-fixed"` and support hmr by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2806](https://github.com/web-infra-dev/rspress/pull/2806) - feat(plugin-preview): should support dark mode by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2816](https://github.com/web-infra-dev/rspress/pull/2816) - feat(i18n): add Russian translation for built-in i18n text by [@&#8203;dragomano](https://github.com/dragomano) in [#&#8203;2827](https://github.com/web-infra-dev/rspress/pull/2827) - feat(rspack)!: revert Rspack native watcher by default by [@&#8203;Timeless0911](https://github.com/Timeless0911) in [#&#8203;2830](https://github.com/web-infra-dev/rspress/pull/2830) - feat(plugin-typedoc): Upgrade to TypeDoc v0.28 with new API by [@&#8203;Karibash](https://github.com/Karibash) in [#&#8203;2790](https://github.com/web-infra-dev/rspress/pull/2790) - feat(mdx): support absolute paths with `<root>/` prefix in remarkFileCodeBlock by [@&#8203;Copilot](https://github.com/Copilot) in [#&#8203;2665](https://github.com/web-infra-dev/rspress/pull/2665) - feat(theme)!: custom theme should use `@rspress/core/theme-original` by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2860](https://github.com/web-infra-dev/rspress/pull/2860) - feat(theme/Root): add ejectable <Root /> component to theme by [@&#8203;Copilot](https://github.com/Copilot) in [#&#8203;2858](https://github.com/web-infra-dev/rspress/pull/2858) - feat(theme/Toc): Add data-depth attribute to TOC items by [@&#8203;Copilot](https://github.com/Copilot) in [#&#8203;2859](https://github.com/web-infra-dev/rspress/pull/2859) - feat(plugin-typedoc): Add setup callback for TypeDoc customization by [@&#8203;Karibash](https://github.com/Karibash) in [#&#8203;2841](https://github.com/web-infra-dev/rspress/pull/2841) ##### Performance 🚀 - perf(theme/useWindowSize): optimize useWindowSize with debounce to reduce resize handler calls by [@&#8203;Copilot](https://github.com/Copilot) in [#&#8203;2849](https://github.com/web-infra-dev/rspress/pull/2849) ##### Bug Fixes 🐞 - fix(theme): css vars color by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2791](https://github.com/web-infra-dev/rspress/pull/2791) - fix(theme): table should be scrollable and startTransition should not be a html attribute by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2792](https://github.com/web-infra-dev/rspress/pull/2792) - fix(theme): th width should be same with td by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2804](https://github.com/web-infra-dev/rspress/pull/2804) - fix(theme): plugin-preview should hide the toc by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2803](https://github.com/web-infra-dev/rspress/pull/2803) - fix(theme/Sidebar): pass down `onClick` prop by [@&#8203;JounQin](https://github.com/JounQin) in [#&#8203;2811](https://github.com/web-infra-dev/rspress/pull/2811) - fix(plugin-twoslash): Make twoslashOptions optional by [@&#8203;Karibash](https://github.com/Karibash) in [#&#8203;2819](https://github.com/web-infra-dev/rspress/pull/2819) - fix(ssg): wrong html selector for crawlers regression due to react\@&#8203;19.2.0 `progressiveChunkSize` change by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2831](https://github.com/web-infra-dev/rspress/pull/2831) - fix(theme/callout): link in callout should use currentColor by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2838](https://github.com/web-infra-dev/rspress/pull/2838) - fix(plugin-typedoc): allow typedoc plugin interface as usual by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2836](https://github.com/web-infra-dev/rspress/pull/2836) - fix(theme/outline): line-height of toc item by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2840](https://github.com/web-infra-dev/rspress/pull/2840) - fix(cli): should not restart when public folder change files by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2847](https://github.com/web-infra-dev/rspress/pull/2847) - fix(core): Fix an issue where the PackageManagerTabs component outputs broken Markdown by [@&#8203;Karibash](https://github.com/Karibash) in [#&#8203;2861](https://github.com/web-infra-dev/rspress/pull/2861) ##### Document 📖 - docs: update package manager command from beta to rc by [@&#8203;chenjiahan](https://github.com/chenjiahan) in [#&#8203;2800](https://github.com/web-infra-dev/rspress/pull/2800) - docs: Add "new" tag to plugin documentation for new v1 plugins by [@&#8203;Copilot](https://github.com/Copilot) in [#&#8203;2851](https://github.com/web-infra-dev/rspress/pull/2851) ##### Other Changes - chore(theme/doc): add border to inline text code by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2796](https://github.com/web-infra-dev/rspress/pull/2796) - chore(deps)!: update dependency react-router-dom to v7 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;1802](https://github.com/web-infra-dev/rspress/pull/1802) - chore(deps): update actions/checkout digest to [`34e1148`](https://github.com/web-infra-dev/rspress/commit/34e1148) by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2798](https://github.com/web-infra-dev/rspress/pull/2798) - chore(deps): update all patch dependencies by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2799](https://github.com/web-infra-dev/rspress/pull/2799) - chore(deps): update dependency [@&#8203;rstack-dev/doc-ui](https://github.com/rstack-dev/doc-ui) to ^1.12.0 - autoclosed by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2802](https://github.com/web-infra-dev/rspress/pull/2802) - chore(deps): update dependency [@&#8203;rslib/core](https://github.com/rslib/core) to v0.18.0 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2801](https://github.com/web-infra-dev/rspress/pull/2801) - chore(infra): use [@&#8203;rslib/core](https://github.com/rslib/core) preserveModules by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2805](https://github.com/web-infra-dev/rspress/pull/2805) - chore(build): enable `redirect.dts.extension` to fix type issue by [@&#8203;Timeless0911](https://github.com/Timeless0911) in [#&#8203;2814](https://github.com/web-infra-dev/rspress/pull/2814) - chore(deps): update dependency prettier to v3.7.3 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2825](https://github.com/web-infra-dev/rspress/pull/2825) - chore(deps): update all patch dependencies by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2824](https://github.com/web-infra-dev/rspress/pull/2824) - chore: fix the diff.yml event by [@&#8203;yifancong](https://github.com/yifancong) in [#&#8203;2828](https://github.com/web-infra-dev/rspress/pull/2828) - chore(theme): export `FallbackHeading` for reusing by [@&#8203;JounQin](https://github.com/JounQin) in [#&#8203;2813](https://github.com/web-infra-dev/rspress/pull/2813) - chore: bump pnpm 10.24.0 and remove trust policy config by [@&#8203;Timeless0911](https://github.com/Timeless0911) in [#&#8203;2829](https://github.com/web-infra-dev/rspress/pull/2829) - chore(deps): update actions/checkout action to v6 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2833](https://github.com/web-infra-dev/rspress/pull/2833) - chore(deps): update actions/setup-node action to v6 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2834](https://github.com/web-infra-dev/rspress/pull/2834) - chore(theme/Tabs): upgrade hover style by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2837](https://github.com/web-infra-dev/rspress/pull/2837) - chore(deps): update all patch dependencies by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2842](https://github.com/web-infra-dev/rspress/pull/2842) - chore(deps): update dependency lint-staged to v16 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2844](https://github.com/web-infra-dev/rspress/pull/2844) - chore(deps): update playwright monorepo to v1.57.0 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2843](https://github.com/web-infra-dev/rspress/pull/2843) - chore(theme/Table): narrow table padding by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2845](https://github.com/web-infra-dev/rspress/pull/2845) - chore(Theme/outline): add shadow by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2846](https://github.com/web-infra-dev/rspress/pull/2846) - chore(plugin-algolia): Add Russian translation for plugin-algolia by [@&#8203;dragomano](https://github.com/dragomano) in [#&#8203;2832](https://github.com/web-infra-dev/rspress/pull/2832) - chore(core): truncate some error stack traces to 5 lines by [@&#8203;Copilot](https://github.com/Copilot) in [#&#8203;2821](https://github.com/web-infra-dev/rspress/pull/2821) - chore(build): use advanced ESM by [@&#8203;Timeless0911](https://github.com/Timeless0911) in [#&#8203;2848](https://github.com/web-infra-dev/rspress/pull/2848) - chore(deps): update dependency cspell to ^9.4.0 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2854](https://github.com/web-infra-dev/rspress/pull/2854) - chore(deps): update all patch dependencies by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2853](https://github.com/web-infra-dev/rspress/pull/2853) - chore(deps): update dependency react-router-dom to ^7.10.1 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2855](https://github.com/web-infra-dev/rspress/pull/2855) - chore(deps): update dependency rimraf to ^6.1.2 by [@&#8203;renovate](https://github.com/renovate)\[bot] in [#&#8203;2856](https://github.com/web-infra-dev/rspress/pull/2856) - Release v2.0.0-rc.2 by [@&#8203;SoonIter](https://github.com/SoonIter) in [#&#8203;2862](https://github.com/web-infra-dev/rspress/pull/2862) ##### New Contributors - [@&#8203;dragomano](https://github.com/dragomano) made their first contribution in [#&#8203;2827](https://github.com/web-infra-dev/rspress/pull/2827) **Full Changelog**: <https://github.com/web-infra-dev/rspress/compare/v2.0.0-rc.1...v2.0.0-rc.2> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi4xMS4wIiwidXBkYXRlZEluVmVyIjoiNDIuMTEuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiRGVwZW5kZW5jaWVzIiwiRGVwZW5kZW5jaWVzL1Jlbm92YXRlIl19-->
chore(deps): update dependency @rspress/plugin-preview to v2.0.0-rc.2
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Failing after 1m8s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m42s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 18m47s
d9e875024d
chore(deps): update dependency @rspress/plugin-preview to v2.0.0-rc.2
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Failing after 1m12s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m31s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m52s
cd3970bb07
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Failing after 1m12s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m31s
Required
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m52s
Required
Details
This pull request is broken due to missing fork information.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin renovate/rspress-plugin-preview-2.x-lockfile:renovate/rspress-plugin-preview-2.x-lockfile
git switch renovate/rspress-plugin-preview-2.x-lockfile
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1218
No description provided.