@modern-js/main-doc 2.69.5 → 3.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/en/{_meta.json → _nav.json} +5 -1
- package/docs/en/apis/app/commands.mdx +2 -3
- package/docs/en/apis/app/hooks/src/entry.mdx +1 -5
- package/docs/en/apis/app/hooks/src/entry.server.mdx +4 -5
- package/docs/en/apis/app/hooks/src/routes.mdx +2 -2
- package/docs/en/apis/app/runtime/_meta.json +0 -18
- package/docs/en/apis/app/runtime/bff/use-hono-context.mdx +2 -2
- package/docs/en/apis/app/runtime/router/router.mdx +1 -1
- package/docs/en/apis/app/runtime/utility/css-in-js.mdx +3 -2
- package/docs/en/community/blog/v2-release-note.mdx +0 -2
- package/docs/en/community/contributing-guide.mdx +10 -12
- package/docs/en/components/bff-upload.mdx +16 -12
- package/docs/en/components/build-output.mdx +45 -0
- package/docs/en/components/debug-app.mdx +1 -1
- package/docs/en/components/enable-bff-caution.mdx +2 -2
- package/docs/en/components/enable-bff.mdx +38 -8
- package/docs/en/components/enable-ssg.mdx +48 -0
- package/docs/en/components/entry-scan-logic.mdx +7 -0
- package/docs/en/components/init-app.mdx +40 -17
- package/docs/en/components/international/install-command.mdx +9 -0
- package/docs/en/components/international/introduce.mdx +2 -0
- package/docs/en/components/module-federation.mdx +4 -4
- package/docs/en/components/new-entry-tooltip.mdx +0 -0
- package/docs/en/components/nodeVersion.mdx +2 -6
- package/docs/en/components/prerequisites.mdx +1 -1
- package/docs/en/components/ua-polyfill.mdx +16 -12
- package/docs/en/components/upgrade-browserslist.mdx +0 -0
- package/docs/en/configure/_meta.json +7 -8
- package/docs/en/configure/app/bff/cross-project.mdx +24 -0
- package/docs/en/configure/app/dev/lazy-compilation.mdx +45 -0
- package/docs/en/configure/app/dev/server.mdx +103 -0
- package/docs/en/configure/app/dev/setup-middlewares.mdx +4 -22
- package/docs/en/configure/app/html/app-icon.mdx +1 -23
- package/docs/en/configure/app/output/inline-scripts.mdx +1 -1
- package/docs/en/configure/app/output/override-browserslist.mdx +6 -4
- package/docs/en/configure/app/output/source-map.mdx +6 -3
- package/docs/en/configure/app/output/ssg.mdx +12 -43
- package/docs/en/configure/app/output/ssgByEntries.mdx +93 -0
- package/docs/en/configure/app/performance/build-cache.mdx +0 -4
- package/docs/en/configure/app/resolve/alias-strategy.mdx +14 -0
- package/docs/en/configure/app/resolve/alias.mdx +13 -0
- package/docs/en/configure/app/resolve/condition-names.mdx +18 -0
- package/docs/en/configure/app/resolve/dedupe.mdx +13 -0
- package/docs/en/configure/app/resolve/extensions.mdx +18 -0
- package/docs/en/configure/app/runtime/0-intro.mdx +2 -51
- package/docs/en/configure/app/security/check-syntax.mdx +1 -1
- package/docs/en/configure/app/server/port.mdx +1 -21
- package/docs/en/configure/app/server/rsc.mdx +30 -0
- package/docs/en/configure/app/server/ssr.mdx +20 -9
- package/docs/en/configure/app/source/decorators.mdx +4 -2
- package/docs/en/configure/app/source/entries.mdx +0 -2
- package/docs/en/configure/app/source/main-entry-name.mdx +4 -4
- package/docs/en/configure/app/source/transform-import.mdx +1 -59
- package/docs/en/configure/app/tools/bundler-chain.mdx +5 -5
- package/docs/en/configure/app/tools/css-extract.mdx +1 -1
- package/docs/en/configure/app/tools/dev-server.mdx +14 -248
- package/docs/en/configure/app/tools/html-plugin.mdx +3 -3
- package/docs/en/configure/app/tools/lightningcss-loader.mdx +0 -1
- package/docs/en/configure/app/tools/swc.mdx +1 -43
- package/docs/en/configure/app/usage.mdx +7 -17
- package/docs/en/guides/_meta.json +1 -2
- package/docs/en/guides/advanced-features/_meta.json +6 -0
- package/docs/en/guides/advanced-features/bff/cross-project.mdx +1 -7
- package/docs/en/guides/advanced-features/bff/extend-server.mdx +18 -3
- package/docs/en/guides/advanced-features/bff/frameworks.mdx +1 -1
- package/docs/en/guides/advanced-features/bff/function.mdx +2 -6
- package/docs/en/guides/advanced-features/bff/sdk.mdx +3 -3
- package/docs/en/guides/advanced-features/build-performance.mdx +23 -26
- package/docs/en/guides/advanced-features/compatibility.mdx +53 -9
- package/docs/en/guides/advanced-features/international/_meta.json +11 -0
- package/docs/en/guides/advanced-features/international/advanced.mdx +193 -0
- package/docs/en/guides/advanced-features/international/api.mdx +400 -0
- package/docs/en/guides/advanced-features/international/basic.mdx +417 -0
- package/docs/en/guides/advanced-features/international/best-practices.mdx +135 -0
- package/docs/en/guides/advanced-features/international/configuration.mdx +437 -0
- package/docs/en/guides/advanced-features/international/locale-detection.mdx +276 -0
- package/docs/en/guides/advanced-features/international/quick-start.mdx +154 -0
- package/docs/en/guides/advanced-features/international/resource-loading.mdx +417 -0
- package/docs/en/guides/advanced-features/international/routing.mdx +212 -0
- package/docs/en/guides/advanced-features/international.mdx +37 -0
- package/docs/en/guides/advanced-features/low-level.mdx +21 -16
- package/docs/en/guides/advanced-features/page-performance/code-split.mdx +4 -4
- package/docs/en/guides/advanced-features/page-performance/inline-assets.mdx +4 -4
- package/docs/en/guides/advanced-features/page-performance/optimize-bundle.mdx +7 -21
- package/docs/en/guides/advanced-features/page-performance/react-compiler.mdx +1 -8
- package/docs/en/guides/advanced-features/rspack-start.mdx +2 -22
- package/docs/en/guides/advanced-features/server-monitor/logger.mdx +0 -4
- package/docs/en/guides/advanced-features/server-monitor/monitors.mdx +62 -34
- package/docs/en/guides/advanced-features/web-server.mdx +82 -299
- package/docs/en/guides/basic-features/_meta.json +6 -1
- package/docs/en/guides/basic-features/css/css-in-js.mdx +46 -11
- package/docs/en/guides/basic-features/css/css-modules.mdx +5 -17
- package/docs/en/guides/basic-features/css/css.mdx +3 -3
- package/docs/en/guides/basic-features/css/tailwindcss.mdx +5 -89
- package/docs/en/guides/basic-features/data/data-cache.mdx +5 -1
- package/docs/en/guides/basic-features/data/data-fetch.mdx +4 -4
- package/docs/en/guides/basic-features/data/data-write.mdx +2 -2
- package/docs/en/guides/basic-features/debug/mock.mdx +4 -1
- package/docs/en/guides/basic-features/debug/proxy.mdx +0 -8
- package/docs/en/guides/basic-features/debug/rsdoctor.mdx +5 -5
- package/docs/en/guides/basic-features/deploy.mdx +25 -18
- package/docs/en/guides/basic-features/env-vars.mdx +1 -1
- package/docs/en/guides/basic-features/html.mdx +1 -1
- package/docs/en/guides/basic-features/output-files.mdx +3 -3
- package/docs/en/guides/basic-features/render/_meta.json +1 -1
- package/docs/en/guides/basic-features/render/before-render.mdx +16 -23
- package/docs/en/guides/basic-features/render/overview.mdx +51 -0
- package/docs/en/guides/basic-features/render/rsc.mdx +394 -0
- package/docs/en/guides/basic-features/render/ssg.mdx +26 -62
- package/docs/en/guides/basic-features/render/ssr-cache.mdx +6 -6
- package/docs/en/guides/basic-features/render/ssr.mdx +31 -31
- package/docs/en/guides/basic-features/render/streaming-ssr.mdx +29 -9
- package/docs/en/guides/basic-features/routes/_meta.json +1 -0
- package/docs/en/guides/basic-features/routes/config-routes.mdx +427 -0
- package/docs/en/guides/basic-features/{routes.mdx → routes/routes.mdx} +7 -110
- package/docs/en/guides/basic-features/static-assets/json-files.mdx +21 -3
- package/docs/en/guides/basic-features/static-assets.mdx +2 -2
- package/docs/en/guides/concept/builder.mdx +24 -9
- package/docs/en/guides/concept/entries.mdx +139 -147
- package/docs/en/guides/get-started/glossary.mdx +0 -18
- package/docs/en/guides/get-started/introduction.mdx +1 -4
- package/docs/en/guides/get-started/quick-start.mdx +8 -73
- package/docs/en/guides/get-started/tech-stack.mdx +7 -25
- package/docs/en/guides/get-started/upgrade.mdx +30 -23
- package/docs/en/guides/topic-detail/_meta.json +0 -12
- package/docs/en/guides/topic-detail/module-federation/_meta.json +1 -1
- package/docs/en/guides/topic-detail/module-federation/application.mdx +16 -15
- package/docs/en/guides/topic-detail/module-federation/i18n.mdx +670 -0
- package/docs/en/guides/topic-detail/module-federation/introduce.mdx +5 -4
- package/docs/en/guides/topic-detail/module-federation/ssr.mdx +50 -2
- package/docs/en/guides/topic-detail/module-federation/usage.mdx +10 -30
- package/docs/en/guides/troubleshooting/builder.mdx +3 -82
- package/docs/en/guides/troubleshooting/cli.mdx +6 -30
- package/docs/en/guides/troubleshooting/dependencies.mdx +22 -22
- package/docs/en/plugin/cli-plugins/api.mdx +4 -5
- package/docs/en/plugin/cli-plugins/migration.mdx +33 -48
- package/docs/en/plugin/introduction.mdx +39 -27
- package/docs/en/plugin/official/_meta.json +0 -5
- package/docs/en/plugin/official/cli-plugins/_meta.json +1 -1
- package/docs/en/plugin/official/cli-plugins/plugin-styled-components.mdx +5 -0
- package/docs/en/plugin/official/cli-plugins.mdx +0 -2
- package/docs/en/plugin/plugin-system.mdx +68 -61
- package/docs/en/plugin/runtime-plugins/api.mdx +62 -59
- package/docs/en/plugin/runtime-plugins/migration.mdx +29 -20
- package/docs/en/tutorials/_meta.json +0 -10
- package/docs/en/tutorials/examples/csr-auth.mdx +1 -1
- package/docs/en/tutorials/foundations/introduction.mdx +9 -25
- package/docs/zh/{_meta.json → _nav.json} +10 -6
- package/docs/zh/apis/app/commands.mdx +2 -3
- package/docs/zh/apis/app/hooks/src/entry.mdx +1 -5
- package/docs/zh/apis/app/hooks/src/entry.server.mdx +4 -5
- package/docs/zh/apis/app/hooks/src/routes.mdx +2 -2
- package/docs/zh/apis/app/runtime/_meta.json +0 -18
- package/docs/zh/apis/app/runtime/bff/use-hono-context.mdx +2 -2
- package/docs/zh/apis/app/runtime/utility/css-in-js.mdx +3 -2
- package/docs/zh/community/blog/v2-release-note.mdx +0 -2
- package/docs/zh/community/contributing-guide.mdx +10 -12
- package/docs/zh/components/auto-upgrade.mdx +0 -0
- package/docs/zh/components/bff-upload.mdx +8 -5
- package/docs/zh/components/build-output.mdx +45 -0
- package/docs/zh/components/debug-app.mdx +1 -1
- package/docs/zh/components/enable-bff-caution.mdx +1 -1
- package/docs/zh/components/enable-bff.mdx +37 -8
- package/docs/zh/components/enable-ssg.mdx +47 -0
- package/docs/zh/components/entry-scan-logic.mdx +7 -0
- package/docs/zh/components/init-app.mdx +40 -18
- package/docs/zh/components/international/install-command.mdx +8 -0
- package/docs/zh/components/international/introduce.mdx +2 -0
- package/docs/zh/components/international/platform-support.mdx +0 -0
- package/docs/zh/components/module-federation.mdx +4 -4
- package/docs/zh/components/new-entry-tooltip.mdx +0 -0
- package/docs/zh/components/nodeVersion.mdx +3 -7
- package/docs/zh/components/prerequisites.mdx +1 -1
- package/docs/zh/components/self-route-example.mdx +3 -3
- package/docs/zh/components/ua-polyfill.mdx +11 -6
- package/docs/zh/components/upgrade-browserslist.mdx +0 -0
- package/docs/zh/configure/_meta.json +7 -8
- package/docs/zh/configure/app/bff/cross-project.mdx +24 -0
- package/docs/zh/configure/app/dev/lazy-compilation.mdx +44 -0
- package/docs/zh/configure/app/dev/server.mdx +104 -0
- package/docs/zh/configure/app/dev/setup-middlewares.mdx +4 -23
- package/docs/zh/configure/app/html/app-icon.mdx +1 -23
- package/docs/zh/configure/app/output/inline-scripts.mdx +1 -1
- package/docs/zh/configure/app/output/override-browserslist.mdx +3 -3
- package/docs/zh/configure/app/output/source-map.mdx +10 -3
- package/docs/zh/configure/app/output/ssg.mdx +13 -45
- package/docs/zh/configure/app/output/ssgByEntries.mdx +94 -0
- package/docs/zh/configure/app/performance/build-cache.mdx +0 -4
- package/docs/zh/configure/app/resolve/alias-strategy.mdx +14 -0
- package/docs/zh/configure/app/resolve/alias.mdx +13 -0
- package/docs/zh/configure/app/resolve/condition-names.mdx +18 -0
- package/docs/zh/configure/app/resolve/dedupe.mdx +14 -0
- package/docs/zh/configure/app/resolve/extensions.mdx +18 -0
- package/docs/zh/configure/app/runtime/0-intro.mdx +2 -53
- package/docs/zh/configure/app/security/check-syntax.mdx +1 -1
- package/docs/zh/configure/app/server/port.mdx +2 -21
- package/docs/zh/configure/app/server/rsc.mdx +30 -0
- package/docs/zh/configure/app/server/ssr.mdx +21 -11
- package/docs/zh/configure/app/source/decorators.mdx +4 -4
- package/docs/zh/configure/app/source/entries.mdx +0 -2
- package/docs/zh/configure/app/source/main-entry-name.mdx +4 -4
- package/docs/zh/configure/app/source/transform-import.mdx +1 -59
- package/docs/zh/configure/app/tools/bundler-chain.mdx +6 -6
- package/docs/zh/configure/app/tools/css-extract.mdx +1 -1
- package/docs/zh/configure/app/tools/dev-server.mdx +14 -248
- package/docs/zh/configure/app/tools/html-plugin.mdx +3 -2
- package/docs/zh/configure/app/tools/lightningcss-loader.mdx +0 -1
- package/docs/zh/configure/app/tools/swc.mdx +1 -43
- package/docs/zh/configure/app/usage.mdx +8 -18
- package/docs/zh/guides/_meta.json +5 -1
- package/docs/zh/guides/advanced-features/_meta.json +6 -1
- package/docs/zh/guides/advanced-features/bff/cross-project.mdx +8 -16
- package/docs/zh/guides/advanced-features/bff/extend-server.mdx +25 -8
- package/docs/zh/guides/advanced-features/bff/frameworks.mdx +1 -1
- package/docs/zh/guides/advanced-features/bff/function.mdx +7 -12
- package/docs/zh/guides/advanced-features/bff/sdk.mdx +4 -4
- package/docs/zh/guides/advanced-features/build-performance.mdx +23 -30
- package/docs/zh/guides/advanced-features/compatibility.mdx +44 -0
- package/docs/zh/guides/advanced-features/international/_meta.json +11 -0
- package/docs/zh/guides/advanced-features/international/advanced.mdx +193 -0
- package/docs/zh/guides/advanced-features/international/api.mdx +400 -0
- package/docs/zh/guides/advanced-features/international/basic.mdx +416 -0
- package/docs/zh/guides/advanced-features/international/best-practices.mdx +135 -0
- package/docs/zh/guides/advanced-features/international/configuration.mdx +441 -0
- package/docs/zh/guides/advanced-features/international/locale-detection.mdx +304 -0
- package/docs/zh/guides/advanced-features/international/quick-start.mdx +149 -0
- package/docs/zh/guides/advanced-features/international/resource-loading.mdx +417 -0
- package/docs/zh/guides/advanced-features/international/routing.mdx +212 -0
- package/docs/zh/guides/advanced-features/international.mdx +36 -0
- package/docs/zh/guides/advanced-features/low-level.mdx +21 -16
- package/docs/zh/guides/advanced-features/page-performance/code-split.mdx +3 -3
- package/docs/zh/guides/advanced-features/page-performance/inline-assets.mdx +4 -4
- package/docs/zh/guides/advanced-features/page-performance/optimize-bundle.mdx +7 -21
- package/docs/zh/guides/advanced-features/page-performance/react-compiler.mdx +1 -8
- package/docs/zh/guides/advanced-features/server-monitor/logger.mdx +0 -4
- package/docs/zh/guides/advanced-features/server-monitor/monitors.mdx +63 -35
- package/docs/zh/guides/advanced-features/web-server.mdx +79 -300
- package/docs/zh/guides/basic-features/_meta.json +6 -1
- package/docs/zh/guides/basic-features/css/css-in-js.mdx +40 -5
- package/docs/zh/guides/basic-features/css/css-modules.mdx +6 -17
- package/docs/zh/guides/basic-features/css/css.mdx +2 -2
- package/docs/zh/guides/basic-features/css/tailwindcss.mdx +6 -90
- package/docs/zh/guides/basic-features/data/data-cache.mdx +8 -5
- package/docs/zh/guides/basic-features/data/data-fetch.mdx +6 -5
- package/docs/zh/guides/basic-features/data/data-write.mdx +4 -4
- package/docs/zh/guides/basic-features/debug/mock.mdx +4 -1
- package/docs/zh/guides/basic-features/debug/proxy.mdx +0 -8
- package/docs/zh/guides/basic-features/debug/rsdoctor.mdx +6 -6
- package/docs/zh/guides/basic-features/deploy.mdx +24 -20
- package/docs/zh/guides/basic-features/env-vars.mdx +1 -1
- package/docs/zh/guides/basic-features/html.mdx +2 -2
- package/docs/zh/guides/basic-features/output-files.mdx +3 -3
- package/docs/zh/guides/basic-features/render/_meta.json +1 -1
- package/docs/zh/guides/basic-features/render/before-render.mdx +17 -24
- package/docs/zh/guides/basic-features/render/overview.mdx +52 -0
- package/docs/zh/guides/basic-features/render/rsc.mdx +413 -0
- package/docs/zh/guides/basic-features/render/ssg.mdx +27 -69
- package/docs/zh/guides/basic-features/render/ssr-cache.mdx +5 -5
- package/docs/zh/guides/basic-features/render/ssr.mdx +34 -31
- package/docs/zh/guides/basic-features/render/streaming-ssr.mdx +34 -14
- package/docs/zh/guides/basic-features/routes/_meta.json +1 -0
- package/docs/zh/guides/basic-features/routes/config-routes.mdx +426 -0
- package/docs/zh/guides/basic-features/{routes.mdx → routes/routes.mdx} +8 -114
- package/docs/zh/guides/basic-features/static-assets/json-files.mdx +21 -3
- package/docs/zh/guides/basic-features/static-assets.mdx +2 -2
- package/docs/zh/guides/basic-features/testing/cypress.mdx +5 -5
- package/docs/zh/guides/basic-features/testing/jest.mdx +12 -12
- package/docs/zh/guides/concept/builder.mdx +24 -9
- package/docs/zh/guides/concept/entries.mdx +95 -92
- package/docs/zh/guides/get-started/glossary.mdx +0 -18
- package/docs/zh/guides/get-started/introduction.mdx +1 -5
- package/docs/zh/guides/get-started/quick-start.mdx +5 -72
- package/docs/zh/guides/get-started/tech-stack.mdx +8 -26
- package/docs/zh/guides/get-started/upgrade.mdx +30 -23
- package/docs/zh/guides/topic-detail/_meta.json +0 -12
- package/docs/zh/guides/topic-detail/module-federation/_meta.json +1 -1
- package/docs/zh/guides/topic-detail/module-federation/application.mdx +18 -16
- package/docs/zh/guides/topic-detail/module-federation/i18n.mdx +623 -0
- package/docs/zh/guides/topic-detail/module-federation/introduce.mdx +4 -4
- package/docs/zh/guides/topic-detail/module-federation/ssr.mdx +51 -5
- package/docs/zh/guides/topic-detail/module-federation/usage.mdx +11 -32
- package/docs/zh/guides/troubleshooting/builder.mdx +3 -84
- package/docs/zh/guides/troubleshooting/cli.mdx +6 -30
- package/docs/zh/guides/troubleshooting/dependencies.mdx +23 -23
- package/docs/zh/guides/upgrade/_meta.json +1 -0
- package/docs/zh/guides/upgrade/config.mdx +809 -0
- package/docs/zh/guides/upgrade/entry.mdx +463 -0
- package/docs/zh/guides/upgrade/other.md +90 -0
- package/docs/zh/guides/upgrade/overview.mdx +36 -0
- package/docs/zh/guides/upgrade/tailwindcss.mdx +130 -0
- package/docs/zh/guides/upgrade/web-server.md +93 -0
- package/docs/zh/plugin/cli-plugins/api.mdx +4 -5
- package/docs/zh/plugin/cli-plugins/migration.mdx +30 -45
- package/docs/zh/plugin/introduction.mdx +36 -24
- package/docs/zh/plugin/official/_meta.json +0 -5
- package/docs/zh/plugin/official/cli-plugins/_meta.json +1 -1
- package/docs/zh/plugin/official/cli-plugins/plugin-styled-components.mdx +5 -0
- package/docs/zh/plugin/official/cli-plugins.mdx +0 -2
- package/docs/zh/plugin/plugin-system.mdx +45 -42
- package/docs/zh/plugin/runtime-plugins/api.mdx +58 -56
- package/docs/zh/plugin/runtime-plugins/migration.mdx +26 -17
- package/docs/zh/tutorials/_meta.json +0 -10
- package/docs/zh/tutorials/examples/csr-auth.mdx +1 -1
- package/docs/zh/tutorials/foundations/introduction.mdx +8 -25
- package/i18n.json +0 -16
- package/package.json +12 -12
- package/rspress.config.ts +5 -8
- package/src/components/ContentCard/index.module.scss +11 -7
- package/src/components/ContentCard/index.tsx +1 -1
- package/src/components/FeatureLayout/index.module.css +1 -1
- package/src/components/Footer/index.tsx +2 -14
- package/src/components/Footer/styles.module.scss +5 -5
- package/src/components/ListCard/index.tsx +1 -1
- package/src/components/RandomMemberList/index.tsx +1 -1
- package/src/components/RsbuildLink/index.tsx +1 -1
- package/src/components/Sandpack/index.tsx +1 -1
- package/src/custom.scss +15 -0
- package/src/i18n/enUS.ts +2 -4
- package/src/i18n/index.ts +1 -1
- package/src/i18n/zhCN.ts +2 -4
- package/src/index.ts +2 -1
- package/src/pages/index.module.scss +59 -41
- package/src/pages/index.tsx +9 -24
- package/docs/en/apis/app/hooks/server/index_.mdx +0 -10
- package/docs/en/apis/app/hooks/src/index_.mdx +0 -38
- package/docs/en/apis/app/hooks/src/stories.mdx +0 -16
- package/docs/en/apis/app/runtime/app/define-config.mdx +0 -67
- package/docs/en/apis/app/runtime/core/bootstrap.mdx +0 -74
- package/docs/en/apis/app/runtime/core/create-app.mdx +0 -49
- package/docs/en/apis/app/runtime/core/use-loader.mdx +0 -89
- package/docs/en/apis/app/runtime/core/use-module-apps.mdx +0 -140
- package/docs/en/apis/app/runtime/core/use-runtime-context.mdx +0 -116
- package/docs/en/apis/app/runtime/model/Provider.mdx +0 -36
- package/docs/en/apis/app/runtime/model/auto-actions.mdx +0 -122
- package/docs/en/apis/app/runtime/model/connect.mdx +0 -146
- package/docs/en/apis/app/runtime/model/create-app.mdx +0 -75
- package/docs/en/apis/app/runtime/model/create-store.mdx +0 -61
- package/docs/en/apis/app/runtime/model/handle-effect.mdx +0 -107
- package/docs/en/apis/app/runtime/model/model_.mdx +0 -198
- package/docs/en/apis/app/runtime/model/use-local-model.mdx +0 -29
- package/docs/en/apis/app/runtime/model/use-model.mdx +0 -89
- package/docs/en/apis/app/runtime/model/use-static-model.mdx +0 -51
- package/docs/en/apis/app/runtime/model/use-store.mdx +0 -26
- package/docs/en/apis/app/runtime/ssr/pre-render.mdx +0 -96
- package/docs/en/apis/app/runtime/web-server/hook.mdx +0 -134
- package/docs/en/apis/app/runtime/web-server/middleware.mdx +0 -113
- package/docs/en/apis/app/runtime/web-server/unstable_middleware.mdx +0 -167
- package/docs/en/components/bff-proxy-path-rewrite.mdx +0 -16
- package/docs/en/components/bff-proxy-principle.mdx +0 -1
- package/docs/en/components/builder.mdx +0 -3
- package/docs/en/components/create-bff-api-app.mdx +0 -25
- package/docs/en/components/custom-router-micro-frontend.mdx +0 -40
- package/docs/en/components/enable-micro-frontend.mdx +0 -30
- package/docs/en/components/enableSwc.mdx +0 -17
- package/docs/en/components/global-proxy-config.mdx +0 -85
- package/docs/en/components/global-proxy.mdx +0 -29
- package/docs/en/components/package-manager.mdx +0 -11
- package/docs/en/components/reduck-notify.mdx +0 -27
- package/docs/en/components/reduck-tip.mdx +0 -8
- package/docs/en/configure/app/auto-load-plugin.mdx +0 -66
- package/docs/en/configure/app/deploy/microFrontend.mdx +0 -53
- package/docs/en/configure/app/dev/port.mdx +0 -25
- package/docs/en/configure/app/dev/proxy.mdx +0 -9
- package/docs/en/configure/app/experiments/lazy-compilation.mdx +0 -106
- package/docs/en/configure/app/html/disable-html-folder.mdx +0 -46
- package/docs/en/configure/app/html/favicon-by-entries.mdx +0 -36
- package/docs/en/configure/app/html/inject-by-entries.mdx +0 -36
- package/docs/en/configure/app/html/meta-by-entries.mdx +0 -48
- package/docs/en/configure/app/html/tags-by-entries.mdx +0 -44
- package/docs/en/configure/app/html/template-by-entries.mdx +0 -33
- package/docs/en/configure/app/html/template-parameters-by-entries.mdx +0 -35
- package/docs/en/configure/app/html/title-by-entries.mdx +0 -37
- package/docs/en/configure/app/output/css-module-local-ident-name.mdx +0 -21
- package/docs/en/configure/app/output/disable-css-extract.mdx +0 -16
- package/docs/en/configure/app/output/disable-filename-hash.mdx +0 -16
- package/docs/en/configure/app/output/disable-minimize.mdx +0 -14
- package/docs/en/configure/app/output/disable-node-polyfill.mdx +0 -22
- package/docs/en/configure/app/output/disable-source-map.mdx +0 -31
- package/docs/en/configure/app/output/enable-asset-fallback.mdx +0 -36
- package/docs/en/configure/app/output/enable-inline-scripts.mdx +0 -22
- package/docs/en/configure/app/output/enable-inline-styles.mdx +0 -22
- package/docs/en/configure/app/output/enable-latest-decorators.mdx +0 -14
- package/docs/en/configure/app/performance/transform-lodash.mdx +0 -52
- package/docs/en/configure/app/runtime/master-app.mdx +0 -36
- package/docs/en/configure/app/runtime/state.mdx +0 -52
- package/docs/en/configure/app/source/disable-entry-dirs.mdx +0 -38
- package/docs/en/configure/app/source/enable-custom-entry.mdx +0 -68
- package/docs/en/configure/app/source/module-scopes.mdx +0 -72
- package/docs/en/configure/app/source/resolve-extension-prefix.mdx +0 -55
- package/docs/en/configure/app/source/resolve-main-fields.mdx +0 -46
- package/docs/en/configure/app/tools/esbuild.mdx +0 -44
- package/docs/en/configure/app/tools/pug.mdx +0 -54
- package/docs/en/configure/app/tools/styled-components.mdx +0 -55
- package/docs/en/configure/app/tools/tailwindcss.mdx +0 -98
- package/docs/en/configure/app/tools/terser.mdx +0 -58
- package/docs/en/configure/app/tools/ts-loader.mdx +0 -76
- package/docs/en/configure/app/tools/webpack-chain.mdx +0 -249
- package/docs/en/configure/app/tools/webpack.mdx +0 -305
- package/docs/en/guides/deprecated.md +0 -17
- package/docs/en/guides/topic-detail/micro-frontend/c01-introduction.mdx +0 -27
- package/docs/en/guides/topic-detail/micro-frontend/c02-development.mdx +0 -290
- package/docs/en/guides/topic-detail/micro-frontend/c03-main-app.mdx +0 -298
- package/docs/en/guides/topic-detail/micro-frontend/c04-communicate.mdx +0 -58
- package/docs/en/guides/topic-detail/micro-frontend/c05-mixed-stack.mdx +0 -26
- package/docs/en/guides/topic-detail/model/_meta.json +0 -14
- package/docs/en/guides/topic-detail/model/auto-actions.mdx +0 -85
- package/docs/en/guides/topic-detail/model/computed-state.mdx +0 -148
- package/docs/en/guides/topic-detail/model/define-model.mdx +0 -62
- package/docs/en/guides/topic-detail/model/faq.mdx +0 -35
- package/docs/en/guides/topic-detail/model/manage-effects.mdx +0 -247
- package/docs/en/guides/topic-detail/model/model-communicate.mdx +0 -217
- package/docs/en/guides/topic-detail/model/performance.mdx +0 -167
- package/docs/en/guides/topic-detail/model/quick-start.mdx +0 -117
- package/docs/en/guides/topic-detail/model/redux-integration.mdx +0 -20
- package/docs/en/guides/topic-detail/model/typescript-best-practice.mdx +0 -68
- package/docs/en/guides/topic-detail/model/use-model.mdx +0 -243
- package/docs/en/guides/topic-detail/model/use-out-of-modernjs.mdx +0 -46
- package/docs/en/plugin/official/cli-plugins/plugin-swc.mdx +0 -363
- package/docs/en/plugin/official/cli-plugins/plugin-tailwind.mdx +0 -5
- package/docs/en/plugin/official/rsbuild-plugins/_meta.json +0 -1
- package/docs/en/plugin/official/rsbuild-plugins/plugin-esbuild.mdx +0 -205
- package/docs/en/plugin/official/rsbuild-plugins.mdx +0 -3
- package/docs/en/tutorials/first-app/c01-start.mdx +0 -99
- package/docs/en/tutorials/first-app/c02-component.mdx +0 -60
- package/docs/en/tutorials/first-app/c03-css.mdx +0 -324
- package/docs/en/tutorials/first-app/c04-routes.mdx +0 -172
- package/docs/en/tutorials/first-app/c05-loader.mdx +0 -87
- package/docs/en/tutorials/first-app/c06-model.mdx +0 -278
- package/docs/en/tutorials/first-app/c07-container.mdx +0 -281
- package/docs/en/tutorials/first-app/c08-entries.mdx +0 -135
- package/docs/zh/apis/app/hooks/server/index_.mdx +0 -10
- package/docs/zh/apis/app/hooks/src/index_.mdx +0 -39
- package/docs/zh/apis/app/hooks/src/stories.mdx +0 -16
- package/docs/zh/apis/app/runtime/app/define-config.mdx +0 -67
- package/docs/zh/apis/app/runtime/core/bootstrap.mdx +0 -74
- package/docs/zh/apis/app/runtime/core/create-app.mdx +0 -35
- package/docs/zh/apis/app/runtime/core/use-loader.mdx +0 -89
- package/docs/zh/apis/app/runtime/core/use-module-apps.mdx +0 -179
- package/docs/zh/apis/app/runtime/core/use-runtime-context.mdx +0 -116
- package/docs/zh/apis/app/runtime/model/Provider.mdx +0 -36
- package/docs/zh/apis/app/runtime/model/auto-actions.mdx +0 -122
- package/docs/zh/apis/app/runtime/model/connect.mdx +0 -143
- package/docs/zh/apis/app/runtime/model/create-app.mdx +0 -75
- package/docs/zh/apis/app/runtime/model/create-store.mdx +0 -61
- package/docs/zh/apis/app/runtime/model/handle-effect.mdx +0 -108
- package/docs/zh/apis/app/runtime/model/model_.mdx +0 -201
- package/docs/zh/apis/app/runtime/model/use-local-model.mdx +0 -29
- package/docs/zh/apis/app/runtime/model/use-model.mdx +0 -89
- package/docs/zh/apis/app/runtime/model/use-static-model.mdx +0 -49
- package/docs/zh/apis/app/runtime/model/use-store.mdx +0 -26
- package/docs/zh/apis/app/runtime/ssr/pre-render.mdx +0 -96
- package/docs/zh/apis/app/runtime/web-server/hook.mdx +0 -136
- package/docs/zh/apis/app/runtime/web-server/middleware.mdx +0 -114
- package/docs/zh/apis/app/runtime/web-server/unstable_middleware.mdx +0 -165
- package/docs/zh/components/bff-proxy-path-rewrite.mdx +0 -16
- package/docs/zh/components/bff-proxy-principle.mdx +0 -1
- package/docs/zh/components/builder.mdx +0 -3
- package/docs/zh/components/create-bff-api-app.mdx +0 -25
- package/docs/zh/components/custom-router-micro-frontend.mdx +0 -40
- package/docs/zh/components/enable-micro-frontend.mdx +0 -30
- package/docs/zh/components/enableSwc.mdx +0 -17
- package/docs/zh/components/global-proxy-config.mdx +0 -85
- package/docs/zh/components/global-proxy.mdx +0 -29
- package/docs/zh/components/package-manager.mdx +0 -11
- package/docs/zh/components/reduck-notify.mdx +0 -27
- package/docs/zh/components/reduck-tip.mdx +0 -8
- package/docs/zh/configure/app/auto-load-plugin.mdx +0 -66
- package/docs/zh/configure/app/deploy/microFrontend.mdx +0 -55
- package/docs/zh/configure/app/dev/port.mdx +0 -25
- package/docs/zh/configure/app/dev/proxy.mdx +0 -9
- package/docs/zh/configure/app/experiments/lazy-compilation.mdx +0 -105
- package/docs/zh/configure/app/html/disable-html-folder.mdx +0 -45
- package/docs/zh/configure/app/html/favicon-by-entries.mdx +0 -37
- package/docs/zh/configure/app/html/inject-by-entries.mdx +0 -37
- package/docs/zh/configure/app/html/meta-by-entries.mdx +0 -48
- package/docs/zh/configure/app/html/tags-by-entries.mdx +0 -44
- package/docs/zh/configure/app/html/template-by-entries.mdx +0 -33
- package/docs/zh/configure/app/html/template-parameters-by-entries.mdx +0 -36
- package/docs/zh/configure/app/html/title-by-entries.mdx +0 -37
- package/docs/zh/configure/app/output/css-module-local-ident-name.mdx +0 -21
- package/docs/zh/configure/app/output/disable-css-extract.mdx +0 -16
- package/docs/zh/configure/app/output/disable-filename-hash.mdx +0 -16
- package/docs/zh/configure/app/output/disable-minimize.mdx +0 -14
- package/docs/zh/configure/app/output/disable-node-polyfill.mdx +0 -22
- package/docs/zh/configure/app/output/disable-source-map.mdx +0 -31
- package/docs/zh/configure/app/output/enable-asset-fallback.mdx +0 -36
- package/docs/zh/configure/app/output/enable-inline-scripts.mdx +0 -22
- package/docs/zh/configure/app/output/enable-inline-styles.mdx +0 -22
- package/docs/zh/configure/app/output/enable-latest-decorators.mdx +0 -14
- package/docs/zh/configure/app/performance/transform-lodash.mdx +0 -52
- package/docs/zh/configure/app/runtime/master-app.mdx +0 -38
- package/docs/zh/configure/app/runtime/state.mdx +0 -52
- package/docs/zh/configure/app/source/disable-entry-dirs.mdx +0 -38
- package/docs/zh/configure/app/source/enable-custom-entry.mdx +0 -67
- package/docs/zh/configure/app/source/module-scopes.mdx +0 -72
- package/docs/zh/configure/app/source/resolve-extension-prefix.mdx +0 -57
- package/docs/zh/configure/app/source/resolve-main-fields.mdx +0 -46
- package/docs/zh/configure/app/tools/esbuild.mdx +0 -44
- package/docs/zh/configure/app/tools/pug.mdx +0 -54
- package/docs/zh/configure/app/tools/styled-components.mdx +0 -54
- package/docs/zh/configure/app/tools/tailwindcss.mdx +0 -98
- package/docs/zh/configure/app/tools/terser.mdx +0 -58
- package/docs/zh/configure/app/tools/ts-loader.mdx +0 -76
- package/docs/zh/configure/app/tools/webpack-chain.mdx +0 -253
- package/docs/zh/configure/app/tools/webpack.mdx +0 -305
- package/docs/zh/guides/advanced-features/rspack-start.mdx +0 -154
- package/docs/zh/guides/deprecated.md +0 -19
- package/docs/zh/guides/topic-detail/micro-frontend/c01-introduction.mdx +0 -26
- package/docs/zh/guides/topic-detail/micro-frontend/c02-development.mdx +0 -332
- package/docs/zh/guides/topic-detail/micro-frontend/c03-main-app.mdx +0 -296
- package/docs/zh/guides/topic-detail/micro-frontend/c04-communicate.mdx +0 -58
- package/docs/zh/guides/topic-detail/micro-frontend/c05-mixed-stack.mdx +0 -27
- package/docs/zh/guides/topic-detail/model/_meta.json +0 -14
- package/docs/zh/guides/topic-detail/model/auto-actions.mdx +0 -88
- package/docs/zh/guides/topic-detail/model/computed-state.mdx +0 -147
- package/docs/zh/guides/topic-detail/model/define-model.mdx +0 -63
- package/docs/zh/guides/topic-detail/model/faq.mdx +0 -36
- package/docs/zh/guides/topic-detail/model/manage-effects.mdx +0 -256
- package/docs/zh/guides/topic-detail/model/model-communicate.mdx +0 -217
- package/docs/zh/guides/topic-detail/model/performance.mdx +0 -167
- package/docs/zh/guides/topic-detail/model/quick-start.mdx +0 -117
- package/docs/zh/guides/topic-detail/model/redux-integration.mdx +0 -20
- package/docs/zh/guides/topic-detail/model/typescript-best-practice.mdx +0 -67
- package/docs/zh/guides/topic-detail/model/use-model.mdx +0 -248
- package/docs/zh/guides/topic-detail/model/use-out-of-modernjs.mdx +0 -46
- package/docs/zh/plugin/official/cli-plugins/plugin-swc.mdx +0 -351
- package/docs/zh/plugin/official/cli-plugins/plugin-tailwind.mdx +0 -5
- package/docs/zh/plugin/official/rsbuild-plugins/_meta.json +0 -1
- package/docs/zh/plugin/official/rsbuild-plugins/plugin-esbuild.mdx +0 -201
- package/docs/zh/plugin/official/rsbuild-plugins.mdx +0 -3
- package/docs/zh/tutorials/first-app/c01-start.mdx +0 -99
- package/docs/zh/tutorials/first-app/c02-component.mdx +0 -60
- package/docs/zh/tutorials/first-app/c03-css.mdx +0 -323
- package/docs/zh/tutorials/first-app/c04-routes.mdx +0 -172
- package/docs/zh/tutorials/first-app/c05-loader.mdx +0 -89
- package/docs/zh/tutorials/first-app/c06-model.mdx +0 -274
- package/docs/zh/tutorials/first-app/c07-container.mdx +0 -281
- package/docs/zh/tutorials/first-app/c08-entries.mdx +0 -135
- /package/docs/en/components/{reduck-migration.mdx → auto-upgrade.mdx} +0 -0
- /package/docs/{zh/components/reduck-migration.mdx → en/components/international/platform-support.mdx} +0 -0
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# Tailwind 插件变更
|
|
2
|
+
|
|
3
|
+
Modern.js 3.0 推荐通过 Rsbuild 原生方式接入 Tailwind CSS,不再依赖 `@modern-js/plugin-tailwindcss` 插件,从而充分利用 Rsbuild 提供的更灵活的配置能力和更优的构建体验。
|
|
4
|
+
|
|
5
|
+
## 迁移步骤
|
|
6
|
+
|
|
7
|
+
本小节中的迁移操作都是仅当项目中实际使用了 `@modern-js/plugin-tailwindcss` 插件时才需要执行。
|
|
8
|
+
|
|
9
|
+
### 1. 移除旧插件
|
|
10
|
+
|
|
11
|
+
移除 `@modern-js/plugin-tailwindcss` 依赖和配置。
|
|
12
|
+
|
|
13
|
+
**2.0 版本:**
|
|
14
|
+
|
|
15
|
+
```ts title="modern.config.ts"
|
|
16
|
+
import { defineConfig } from '@modern-js/app-tools';
|
|
17
|
+
import tailwindcssPlugin from '@modern-js/plugin-tailwindcss';
|
|
18
|
+
|
|
19
|
+
export default defineConfig({
|
|
20
|
+
plugins: [tailwindcssPlugin()],
|
|
21
|
+
});
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**3.0 版本:**
|
|
25
|
+
|
|
26
|
+
```ts title="modern.config.ts"
|
|
27
|
+
import { defineConfig } from '@modern-js/app-tools';
|
|
28
|
+
|
|
29
|
+
export default defineConfig({
|
|
30
|
+
plugins: [],
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
同时移除 `package.json` 中的 `@modern-js/plugin-tailwindcss` 依赖。
|
|
35
|
+
|
|
36
|
+
### 2. 配置 PostCSS
|
|
37
|
+
|
|
38
|
+
创建或更新 `postcss.config.cjs` 文件。
|
|
39
|
+
|
|
40
|
+
```js title="postcss.config.cjs"
|
|
41
|
+
module.exports = {
|
|
42
|
+
plugins: {
|
|
43
|
+
tailwindcss: {},
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### 3. Tailwind CSS 配置迁移
|
|
49
|
+
|
|
50
|
+
**单一配置情况**:
|
|
51
|
+
|
|
52
|
+
- 若仅在 `tailwind.config.{ts,js}` 中配置,则无需额外处理
|
|
53
|
+
- 若仅在 `modern.config.ts` 中配置,需将 Tailwind 相关配置移植到 `tailwind.config.{ts,js}` 中
|
|
54
|
+
|
|
55
|
+
**双重配置情况**:
|
|
56
|
+
|
|
57
|
+
若在 `tailwind.config.{ts,js}` 与 `modern.config.ts` 中都有配置,需要合并两者的配置内容,并将合并后的配置移植到 `tailwind.config.{ts,js}`。
|
|
58
|
+
|
|
59
|
+
**特殊目录处理**:
|
|
60
|
+
|
|
61
|
+
若项目中存在 storybook 或 config/html 目录,需在 `tailwind.config.{ts,js}` 的 `content` 中补充:
|
|
62
|
+
|
|
63
|
+
```ts title="tailwind.config.ts"
|
|
64
|
+
export default {
|
|
65
|
+
content: [
|
|
66
|
+
'./src/**/*.{js,jsx,ts,tsx}',
|
|
67
|
+
'./storybook/**/*', // 如果存在 storybook 目录
|
|
68
|
+
'./config/html/**/*.{html,ejs,hbs}', // 如果存在 config/html 目录
|
|
69
|
+
],
|
|
70
|
+
};
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### 4. CSS 样式引入
|
|
74
|
+
|
|
75
|
+
将 CSS 导入方式变更为 `@tailwind` 指令方式。
|
|
76
|
+
|
|
77
|
+
**2.0 版本:**
|
|
78
|
+
|
|
79
|
+
```css
|
|
80
|
+
@import 'tailwindcss/base.css';
|
|
81
|
+
@import 'tailwindcss/components.css';
|
|
82
|
+
@import 'tailwindcss/utilities.css';
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
**3.0 版本:**
|
|
86
|
+
|
|
87
|
+
```css
|
|
88
|
+
@tailwind base;
|
|
89
|
+
@tailwind components;
|
|
90
|
+
@tailwind utilities;
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 5. Twin.macro 集成
|
|
94
|
+
|
|
95
|
+
若项目中有使用 twin.macro,需要手动配置。未使用则可忽略此步骤。
|
|
96
|
+
|
|
97
|
+
**处理步骤**:
|
|
98
|
+
|
|
99
|
+
1. 手动安装依赖:`pnpm add twin.macro styled-components babel-plugin-macros -D`
|
|
100
|
+
2. 在 `modern.config.ts` 中配置 `babel-plugin-macros` 插件:
|
|
101
|
+
|
|
102
|
+
```ts title="modern.config.ts"
|
|
103
|
+
export default defineConfig({
|
|
104
|
+
plugins: [appTools()],
|
|
105
|
+
tools: {
|
|
106
|
+
babel: {
|
|
107
|
+
plugins: [
|
|
108
|
+
[
|
|
109
|
+
'babel-plugin-macros',
|
|
110
|
+
{
|
|
111
|
+
twin: {
|
|
112
|
+
preset: 'styled-components',
|
|
113
|
+
config: './tailwind.config.ts',
|
|
114
|
+
},
|
|
115
|
+
},
|
|
116
|
+
],
|
|
117
|
+
],
|
|
118
|
+
},
|
|
119
|
+
},
|
|
120
|
+
});
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## Tailwind CSS V2 版本迁移
|
|
124
|
+
|
|
125
|
+
如果你的项目仍使用 Tailwind CSS v2,我们推荐你升级到 v3 以支持 JIT 等能力。关于 Tailwind CSS v2 与 v3 版本之间的差异,请参考:
|
|
126
|
+
|
|
127
|
+
- [Tailwind CSS v3.0](https://tailwindcss.com/blog/tailwindcss-v3)
|
|
128
|
+
- [Upgrade Guide](https://v3.tailwindcss.com/docs/upgrade-guide)
|
|
129
|
+
|
|
130
|
+
Tailwind CSS v2 迁移同样参考上述步骤,但需要注意的是,原插件自动适配 Tailwind v2(`purge` 配置)与 v3(`content` 配置)的差异。移除插件后,如果使用 v2,需在 `tailwind.config.{ts,js}` 中使用 `purge` 配置项来指定需要保留的 CSS 类名。
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# 自定义 Web Server 变化
|
|
2
|
+
|
|
3
|
+
本章节覆盖两类旧版自定义 Server API 的升级
|
|
4
|
+
|
|
5
|
+
- **unstableMiddleware**
|
|
6
|
+
- **Hook**
|
|
7
|
+
|
|
8
|
+
这两种写法在旧版中互斥,迁移时请根据项目实际使用的能力选择对应路径。
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## unstableMiddleware
|
|
12
|
+
|
|
13
|
+
### 核心差异
|
|
14
|
+
|
|
15
|
+
- **文件结构**:`server/index.ts` → `server/modern.server.ts`
|
|
16
|
+
- **导出方式**:`unstableMiddleware` 数组 → `defineServerConfig`
|
|
17
|
+
- **Context API**:Modern.js Server Context → Hono Context(`c.req`/`c.res`)
|
|
18
|
+
- **中间件执行**:旧版可不调用 `next()`,新版必须调用后续链路才会执行
|
|
19
|
+
- **响应方式**:`c.response.raw()` → `c.text()` / `c.json()`
|
|
20
|
+
|
|
21
|
+
### 文件与导出
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
// 旧版 - server/index.ts
|
|
25
|
+
export const unstableMiddleware: UnstableMiddleware[] = [middleware1, middleware2];
|
|
26
|
+
|
|
27
|
+
// 新版 - server/modern.server.ts
|
|
28
|
+
import { defineServerConfig } from '@modern-js/server-runtime';
|
|
29
|
+
|
|
30
|
+
export default defineServerConfig({
|
|
31
|
+
middlewares: [
|
|
32
|
+
{ name: 'middleware1', handler: middleware1 },
|
|
33
|
+
{ name: 'middleware2', handler: middleware2 },
|
|
34
|
+
],
|
|
35
|
+
});
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### 类型与 next 调用
|
|
39
|
+
|
|
40
|
+
```typescript
|
|
41
|
+
// 旧版
|
|
42
|
+
import type { UnstableMiddleware, UnstableMiddlewareContext } from '@modern-js/server-runtime';
|
|
43
|
+
const middleware: UnstableMiddleware = async (c: UnstableMiddlewareContext, next) => {
|
|
44
|
+
return c.response.raw('response'); // 不调用 next 也会继续渲染
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
// 新版
|
|
48
|
+
import { defineServerConfig, type MiddlewareHandler } from '@modern-js/server-runtime';
|
|
49
|
+
const middleware: MiddlewareHandler = async (c, next) => {
|
|
50
|
+
await next(); // 必须调用
|
|
51
|
+
return c.text('response');
|
|
52
|
+
};
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Context API 对照
|
|
56
|
+
|
|
57
|
+
| 旧版 API | 新版 API | 说明 |
|
|
58
|
+
| -------------------- | ---------------------- | ------------- |
|
|
59
|
+
| `c.request.cookie` | `getCookie(c, 'key')` | Cookie 读取 |
|
|
60
|
+
| `c.req.cookie()` | `getCookie(c, 'key')` | Hono v4 已废弃 |
|
|
61
|
+
| `c.request.pathname` | `c.req.path` | 请求路径 |
|
|
62
|
+
| `c.request.host` | `c.req.header('Host')` | 请求主机 |
|
|
63
|
+
| `c.request.query` | `c.req.query()` | 查询参数 |
|
|
64
|
+
| `c.request.headers` | `c.req.header()` | 请求头 |
|
|
65
|
+
| `c.response.status` | `c.status()` | 响应状态码 |
|
|
66
|
+
| `c.response.set` | `c.res.headers.set` | 设置响应头 |
|
|
67
|
+
| `c.response.raw` | `c.text` / `c.json` | 响应体 |
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
## afterRender Hook
|
|
71
|
+
|
|
72
|
+
`afterRender` 仅用于页面渲染完成后的 HTML 处理。
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import { defineServerConfig, type MiddlewareHandler } from '@modern-js/server-runtime';
|
|
76
|
+
|
|
77
|
+
const renderMiddleware: MiddlewareHandler = async (c, next) => {
|
|
78
|
+
await next(); // 先等待页面渲染
|
|
79
|
+
const { res } = c;
|
|
80
|
+
const html = await res.text();
|
|
81
|
+
|
|
82
|
+
const modified = html
|
|
83
|
+
.replace('<head>', '<head><meta name="author" content="ByteDance">')
|
|
84
|
+
.replace('<body>', '<body><div id="loading">Loading...</div>')
|
|
85
|
+
.replace('</body>', '<script>console.log("Page loaded")</script></body>');
|
|
86
|
+
|
|
87
|
+
c.res = c.body(modified, { status: res.status, headers: res.headers });
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
export default defineServerConfig({
|
|
91
|
+
renderMiddlewares: [{ name: 'custom-content-injection', handler: renderMiddleware }],
|
|
92
|
+
});
|
|
93
|
+
```
|
|
@@ -13,9 +13,9 @@ CLI 插件需要通过 `modern.config.ts` 中的 [`plugins`](/configure/app/plug
|
|
|
13
13
|
一个典型的 CLI 插件结构如下:
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import type {
|
|
16
|
+
import type { CliPlugin, AppTools } from '@modern-js/app-tools';
|
|
17
17
|
|
|
18
|
-
const myCliPlugin = ():
|
|
18
|
+
const myCliPlugin = (): CliPlugin<AppTools> => ({
|
|
19
19
|
name: '@my-org/my-plugin', // 插件名称,确保唯一性
|
|
20
20
|
setup: api => {
|
|
21
21
|
// 在这里使用 API 注册钩子、添加命令等
|
|
@@ -59,7 +59,6 @@ export default myCliPlugin;
|
|
|
59
59
|
| `apiDirectory` | `string` | API 模块目录的绝对路径 (BFF 使用) | - |
|
|
60
60
|
| `lambdaDirectory` | `string` | Lambda 模块目录的绝对路径 (BFF 使用) | - |
|
|
61
61
|
| `runtimeConfigFile` | `string` | 运行时配置文件的名称 | - |
|
|
62
|
-
| `serverConfigFile` | `string` | 服务器配置文件的名称 | - |
|
|
63
62
|
| `checkedEntries` | `string[]` | 指定的入口信息 | - |
|
|
64
63
|
| `apiOnly` | `boolean` | 是否为 `apiOnly` 模式 | - |
|
|
65
64
|
|
|
@@ -129,8 +128,8 @@ api.onBeforeBuild(() => {
|
|
|
129
128
|
- **示例:**
|
|
130
129
|
|
|
131
130
|
```typescript
|
|
132
|
-
if (api.isPluginExists('@modern-js/plugin-
|
|
133
|
-
console.log('
|
|
131
|
+
if (api.isPluginExists('@modern-js/plugin-bff')) {
|
|
132
|
+
console.log('BFF 插件已启用');
|
|
134
133
|
}
|
|
135
134
|
```
|
|
136
135
|
|
|
@@ -6,30 +6,11 @@ Modern.js 插件系统在不断演进,为了提供更清晰的 API 和更强
|
|
|
6
6
|
|
|
7
7
|
### 迁移步骤总览
|
|
8
8
|
|
|
9
|
-
1.
|
|
10
|
-
2.
|
|
11
|
-
3. **替换已变更的 API**:参照详细的 API 映射表,更新您的代码。
|
|
9
|
+
1. **调整 Hooks 调用方式**:从 `return hooks` 模式迁移到 `api.xxx` 直接调用。
|
|
10
|
+
2. **替换已变更的 API**:参照详细的 API 映射表,更新您的代码。
|
|
12
11
|
|
|
13
12
|
### 详细迁移步骤
|
|
14
13
|
|
|
15
|
-
#### 更新插件类型定义
|
|
16
|
-
|
|
17
|
-
这是迁移的第一步,也是最关键的一步。它确保您的插件能够与新版插件系统正确交互。
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
// 旧版写法
|
|
21
|
-
import type { CliPlugin, AppTools } from '@modern-js/app-tools';
|
|
22
|
-
|
|
23
|
-
const plugin: CliPlugin<AppTools<'shared'>> = { ... };
|
|
24
|
-
|
|
25
|
-
// 新版写法
|
|
26
|
-
import type { CliPluginFuture, AppTools } from '@modern-js/app-tools';
|
|
27
|
-
|
|
28
|
-
const plugin: CliPluginFuture<AppTools<'shared'>> = { ... };
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
**说明:** `CliPluginFuture` 类型是新版插件的标准定义,它带来了更好的类型推断和更清晰的 API 结构。
|
|
32
|
-
|
|
33
14
|
#### 调整 Hooks 调用方式
|
|
34
15
|
|
|
35
16
|
新版插件系统推荐使用 `api` 对象直接调用 Hooks,这种方式更直观、更易于维护。
|
|
@@ -38,15 +19,19 @@ const plugin: CliPluginFuture<AppTools<'shared'>> = { ... };
|
|
|
38
19
|
// 旧版写法 (return hooks)
|
|
39
20
|
{
|
|
40
21
|
setup: () => ({
|
|
41
|
-
commands({ program }) {
|
|
42
|
-
|
|
22
|
+
commands({ program }) {
|
|
23
|
+
/*...*/
|
|
24
|
+
},
|
|
25
|
+
});
|
|
43
26
|
}
|
|
44
27
|
|
|
45
28
|
// 新版写法 (api.xxx)
|
|
46
29
|
{
|
|
47
30
|
setup: api => {
|
|
48
|
-
api.addCommand(({ program }) => {
|
|
49
|
-
|
|
31
|
+
api.addCommand(({ program }) => {
|
|
32
|
+
/*...*/
|
|
33
|
+
});
|
|
34
|
+
};
|
|
50
35
|
}
|
|
51
36
|
```
|
|
52
37
|
|
|
@@ -56,26 +41,26 @@ const plugin: CliPluginFuture<AppTools<'shared'>> = { ... };
|
|
|
56
41
|
|
|
57
42
|
为了保持 API 的一致性和清晰性,我们对部分 API 的名称进行了调整。下表列出了所有变更的 API 及其新旧对应关系:
|
|
58
43
|
|
|
59
|
-
| 旧版 API
|
|
60
|
-
|
|
|
61
|
-
| `useAppContext`
|
|
62
|
-
| `useConfigContext`
|
|
63
|
-
| `useResolvedConfigContext` | `getNormalizedConfig`
|
|
64
|
-
| `beforeConfig`
|
|
65
|
-
| `prepare`
|
|
66
|
-
| `afterPrepare`
|
|
67
|
-
| `beforePrintInstructions
|
|
68
|
-
| `commands`
|
|
69
|
-
| `watchFiles`
|
|
70
|
-
| `fileChange`
|
|
71
|
-
| `beforeCreateCompiler`
|
|
72
|
-
| `afterCreateCompiler`
|
|
73
|
-
| `beforeBuild`
|
|
74
|
-
| `afterBuild`
|
|
75
|
-
| `beforeDev`
|
|
76
|
-
| `afterDev`
|
|
77
|
-
| `beforeExit`
|
|
78
|
-
| `htmlPartials`
|
|
44
|
+
| 旧版 API | 新版 API | 说明 |
|
|
45
|
+
| :------------------------- | :-------------------------- | :--------------------------------------------------------------------------------- |
|
|
46
|
+
| `useAppContext` | `getAppContext` | 获取应用上下文信息。 |
|
|
47
|
+
| `useConfigContext` | `getConfig` | 获取用户配置文件中的配置。 |
|
|
48
|
+
| `useResolvedConfigContext` | `getNormalizedConfig` | 获取经过插件处理后的最终配置。 |
|
|
49
|
+
| `beforeConfig` | (直接在 `setup` 中定义) | 不再需要单独的 `beforeConfig` Hook,直接在 `setup` 函数中编写相关逻辑即可。 |
|
|
50
|
+
| `prepare` | `onPrepare` | 运行主流程的前置准备阶段。 |
|
|
51
|
+
| `afterPrepare` | `onAfterPrepare` (不推荐) | 在 `onPrepare` 之后执行,但可能在未来版本中废弃。建议将逻辑合并到 `onPrepare` 中。 |
|
|
52
|
+
| `beforePrintInstructions` | `onBeforePrintInstructions` | 在打印日志信息前执行。 |
|
|
53
|
+
| `commands` | `addCommand` | 添加新的 CLI 命令。 |
|
|
54
|
+
| `watchFiles` | `addWatchFiles` | 添加需要监听的文件。 |
|
|
55
|
+
| `fileChange` | `onFileChanged` | 监听文件变化事件。 |
|
|
56
|
+
| `beforeCreateCompiler` | `onBeforeCreateCompiler` | 创建编译器前执行。 |
|
|
57
|
+
| `afterCreateCompiler` | `onAfterCreateCompiler` | 创建编译器后执行。 |
|
|
58
|
+
| `beforeBuild` | `onBeforeBuild` | 构建前执行。 |
|
|
59
|
+
| `afterBuild` | `onAfterBuild` | 构建后执行。 |
|
|
60
|
+
| `beforeDev` | `onBeforeDev` | 运行 `dev` 命令前执行。 |
|
|
61
|
+
| `afterDev` | `onDevCompileDone` | `dev` 命令编译完成后执行。 |
|
|
62
|
+
| `beforeExit` | `onBeforeExit` | 进程退出前执行。 |
|
|
63
|
+
| `htmlPartials` | `modifyHtmlPartials` | 修改 HTML 模板片段。 |
|
|
79
64
|
|
|
80
65
|
**说明:** 请务必仔细检查您的代码,确保所有旧版 API 都已替换为新版 API。
|
|
81
66
|
|
|
@@ -70,21 +70,36 @@ export default defineRuntimeConfig({
|
|
|
70
70
|
});
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
|
|
74
|
-
{/* #### Server 插件
|
|
73
|
+
#### Server 插件
|
|
75
74
|
|
|
76
75
|
Server 插件用于在应用接受请求时提供额外功能,例如添加中间件、修改请求响应等。
|
|
77
76
|
|
|
78
77
|
Server 插件通过 `server/modern.server.ts` 中的 `plugins` 字段进行配置。
|
|
79
78
|
|
|
80
|
-
|
|
81
|
-
import {
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
79
|
+
```ts title="server/modern.server.ts"
|
|
80
|
+
import { defineServerConfig } from '@modern-js/server-runtime';
|
|
81
|
+
|
|
82
|
+
export default defineServerConfig({
|
|
83
|
+
plugins: [
|
|
84
|
+
{
|
|
85
|
+
name: 'custom-plugin-in-config',
|
|
86
|
+
setup: api => {
|
|
87
|
+
api.onPrepare(() => {
|
|
88
|
+
const { middlewares } = api.getServerContext();
|
|
89
|
+
|
|
90
|
+
middlewares?.push({
|
|
91
|
+
name: 'server-plugin-middleware',
|
|
92
|
+
handler: async (c, next) => {
|
|
93
|
+
c.res.headers.set('x-render-middleware-plugin', 'ok');
|
|
94
|
+
await next();
|
|
95
|
+
},
|
|
96
|
+
});
|
|
97
|
+
});
|
|
98
|
+
},
|
|
99
|
+
},
|
|
100
|
+
],
|
|
86
101
|
});
|
|
87
|
-
```
|
|
102
|
+
```
|
|
88
103
|
|
|
89
104
|
:::tip
|
|
90
105
|
Modern.js 从 `MAJOR_VERSION.66.0` 起正式对外使用新的插件机制。
|
|
@@ -123,21 +138,16 @@ Modern.js 从 `MAJOR_VERSION.46.0` 起,底层构建工具升级为 [Rsbuild](h
|
|
|
123
138
|
|
|
124
139
|
以下为已在 Modern.js 中内置的 Rsbuild 官方插件,无需安装,即可启用:
|
|
125
140
|
|
|
126
|
-
| 插件
|
|
127
|
-
|
|
|
128
|
-
| [React 插件](https://rsbuild.rs/zh/plugins/list/plugin-react)
|
|
129
|
-
| [SVGR 插件](https://rsbuild.rs/zh/plugins/list/plugin-svgr)
|
|
130
|
-
| [
|
|
131
|
-
| [
|
|
132
|
-
| [
|
|
133
|
-
| [
|
|
134
|
-
| [
|
|
135
|
-
| [
|
|
136
|
-
| [CSS Minimizer 插件](https://github.com/rspack-contrib/rsbuild-plugin-css-minimizer) | 用于自定义 CSS 压缩工具,切换到 [cssnano](https://cssnano.co/) 或其他工具进行 CSS 压缩 | [tools.minifyCss](/configure/app/tools/minify-css.html) |
|
|
137
|
-
| [Pug 插件](https://github.com/rspack-contrib/rsbuild-plugin-pug) | 提供对 Pug 模板引擎的支持 | [tools.pug](/configure/app/tools/pug.html) |
|
|
138
|
-
| [Rem 插件](https://github.com/rspack-contrib/rsbuild-plugin-rem) | 用于实现移动端页面的 rem 自适应布局 | [output.convertToRem](/configure/app/output/convert-to-rem.html) |
|
|
139
|
-
| [YAML 插件](https://github.com/rspack-contrib/rsbuild-plugin-yaml) | 用于引用 YAML 文件,并将其转换为 JavaScript 对象 | [YAML 文件](/guides/basic-features/static-assets/json-files.html#yaml-文件) |
|
|
140
|
-
| [TOML 插件](https://github.com/rspack-contrib/rsbuild-plugin-toml) | 用于引用 TOML 文件,并将其转换为 JavaScript 对象 | [TOML 文件](/guides/basic-features/static-assets/json-files.html#toml-文件) |
|
|
141
|
+
| 插件 | 介绍 | Modern.js 链接 |
|
|
142
|
+
| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
143
|
+
| [React 插件](https://rsbuild.rs/zh/plugins/list/plugin-react) | 提供对 React 的支持 | - |
|
|
144
|
+
| [SVGR 插件](https://rsbuild.rs/zh/plugins/list/plugin-svgr) | 支持将 SVG 图片转换为一个 React 组件 | [output.disableSvgr](/configure/app/output/disable-svgr)<br />[output.svgDefaultExport](/configure/app/output/svg-default-export) |
|
|
145
|
+
| [Assets Retry 插件](https://rsbuild.rs/zh/plugins/list/plugin-assets-retry) | 用于在静态资源加载失败时自动发起重试请求 | [output.assetsRetry](/configure/app/output/assets-retry.html) |
|
|
146
|
+
| [Type Check 插件](https://github.com/rspack-contrib/rsbuild-plugin-type-check) | 用于在单独的进程中运行 TypeScript 类型检查 | [output.disableTsChecker](/configure/app/output/disable-ts-checker.html)<br />[tools.tsChecker](/configure/app/tools/ts-checker.html) |
|
|
147
|
+
| [Source Build 插件](https://github.com/rspack-contrib/rsbuild-plugin-source-build) | 用于 monorepo 场景,支持引用其他子目录的源代码,并完成构建和热更新 | [experiments.sourceBuild](/configure/app/experiments/source-build.html) |
|
|
148
|
+
| [Check Syntax 插件](https://github.com/rspack-contrib/rsbuild-plugin-check-syntax) | 用于分析产物的语法兼容性,判断是否存在导致兼容性问题的高级语法 | [security.checkSyntax](/configure/app/security/check-syntax.html) |
|
|
149
|
+
| [CSS Minimizer 插件](https://github.com/rspack-contrib/rsbuild-plugin-css-minimizer) | 用于自定义 CSS 压缩工具,切换到 [cssnano](https://cssnano.co/) 或其他工具进行 CSS 压缩 | [tools.minifyCss](/configure/app/tools/minify-css.html) |
|
|
150
|
+
| [Rem 插件](https://github.com/rspack-contrib/rsbuild-plugin-rem) | 用于实现移动端页面的 rem 自适应布局 | [output.convertToRem](/configure/app/output/convert-to-rem.html) |
|
|
141
151
|
|
|
142
152
|
#### 未内置的插件
|
|
143
153
|
|
|
@@ -146,6 +156,8 @@ Modern.js 从 `MAJOR_VERSION.46.0` 起,底层构建工具升级为 [Rsbuild](h
|
|
|
146
156
|
- [Image Compress 插件](https://github.com/rspack-contrib/rsbuild-plugin-image-compress):将项目中用到的图片资源进行压缩处理。
|
|
147
157
|
- [Stylus 插件](https://rsbuild.rs/zh/plugins/list/plugin-stylus):使用 Stylus 作为 CSS 预处理器。
|
|
148
158
|
- [UMD 插件](https://github.com/rspack-contrib/rsbuild-plugin-umd):用于构建 UMD 格式的产物。
|
|
159
|
+
- [YAML 插件](https://github.com/rspack-contrib/rsbuild-plugin-yaml):用于引用 YAML 文件,并将其转换为 JavaScript 对象。
|
|
160
|
+
- [TOML 插件](https://github.com/rspack-contrib/rsbuild-plugin-toml):用于引用 TOML 文件,并将其转换为 JavaScript 对象。
|
|
149
161
|
|
|
150
162
|
import OtherPlugins from '@site-docs/components/other-plugins.mdx';
|
|
151
163
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
["plugin-
|
|
1
|
+
["plugin-bff", "plugin-ssg", "plugin-styled-components"]
|
|
@@ -1,6 +1,4 @@
|
|
|
1
1
|
# 概览
|
|
2
2
|
|
|
3
|
-
- [@modern-js/plugin-tailwindcss](/plugin/official/cli-plugins/plugin-tailwind):提供使用 Tailwind CSS 样式的能力。
|
|
4
3
|
- [@modern-js/plugin-bff](/plugin/official/cli-plugins/plugin-bff):提供 BFF 服务,一体化调用的能力。
|
|
5
4
|
- [@modern-js/plugin-ssg](/plugin/official/cli-plugins/plugin-bff):提供静态站点生成的能力。
|
|
6
|
-
- [@modern-js/plugin-swc](/plugin/official/cli-plugins/plugin-swc):提供 SWC 编译支持。
|