@bleedingdev/modern-js-main-doc 3.2.0-ultramodern.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/LICENSE +21 -0
- package/README.md +23 -0
- package/builder-doc/docs/en/config/performance/rsdoctor.md +37 -0
- package/builder-doc/docs/zh/config/performance/rsdoctor.md +37 -0
- package/docs/en/_nav.json +36 -0
- package/docs/en/apis/_meta.json +13 -0
- package/docs/en/apis/app/commands.mdx +215 -0
- package/docs/en/apis/app/hooks/_meta.json +28 -0
- package/docs/en/apis/app/hooks/api/lambda.mdx +13 -0
- package/docs/en/apis/app/hooks/config/_meta.json +1 -0
- package/docs/en/apis/app/hooks/config/favicon.mdx +29 -0
- package/docs/en/apis/app/hooks/config/html.mdx +9 -0
- package/docs/en/apis/app/hooks/config/icon.mdx +29 -0
- package/docs/en/apis/app/hooks/config/mock.mdx +7 -0
- package/docs/en/apis/app/hooks/config/public.mdx +30 -0
- package/docs/en/apis/app/hooks/config/upload.mdx +54 -0
- package/docs/en/apis/app/hooks/modern-config.mdx +9 -0
- package/docs/en/apis/app/hooks/server/server.mdx +10 -0
- package/docs/en/apis/app/hooks/shared.mdx +7 -0
- package/docs/en/apis/app/hooks/src/app.mdx +30 -0
- package/docs/en/apis/app/hooks/src/entry.mdx +39 -0
- package/docs/en/apis/app/hooks/src/entry.server.mdx +56 -0
- package/docs/en/apis/app/hooks/src/modern.runtime.mdx +9 -0
- package/docs/en/apis/app/hooks/src/routes.mdx +90 -0
- package/docs/en/apis/app/hooks/src/server.mdx +7 -0
- package/docs/en/apis/app/runtime/_meta.json +32 -0
- package/docs/en/apis/app/runtime/bff/use-backend-context.mdx +30 -0
- package/docs/en/apis/app/runtime/core/create-root.mdx +22 -0
- package/docs/en/apis/app/runtime/core/render.mdx +42 -0
- package/docs/en/apis/app/runtime/core/runtime-context.mdx +160 -0
- package/docs/en/apis/app/runtime/router/router.mdx +288 -0
- package/docs/en/apis/app/runtime/ssr/no-ssr.mdx +38 -0
- package/docs/en/apis/app/runtime/ssr/renderStreaming.mdx +71 -0
- package/docs/en/apis/app/runtime/ssr/renderString.mdx +64 -0
- package/docs/en/apis/app/runtime/ssr/requestHandler.mdx +48 -0
- package/docs/en/apis/app/runtime/utility/css-in-js.mdx +44 -0
- package/docs/en/apis/app/runtime/utility/head.mdx +38 -0
- package/docs/en/apis/app/runtime/utility/loadable.mdx +85 -0
- package/docs/en/community/_meta.json +11 -0
- package/docs/en/community/blog/2022-0708-updates.md +95 -0
- package/docs/en/community/blog/2022-0910-updates.md +80 -0
- package/docs/en/community/blog/_meta.json +7 -0
- package/docs/en/community/blog/overview.md +67 -0
- package/docs/en/community/blog/v2-release-note.mdx +244 -0
- package/docs/en/community/blog/v3-release-note.mdx +628 -0
- package/docs/en/community/contributing-guide.mdx +257 -0
- package/docs/en/community/releases.mdx +31 -0
- package/docs/en/community/showcase.mdx +15 -0
- package/docs/en/community/team.mdx +29 -0
- package/docs/en/components/auto-upgrade.mdx +0 -0
- package/docs/en/components/bff-upload.mdx +97 -0
- package/docs/en/components/build-output.mdx +45 -0
- package/docs/en/components/bundler.mdx +3 -0
- package/docs/en/components/convention-routing-motivation.mdx +0 -0
- package/docs/en/components/debug-app.mdx +15 -0
- package/docs/en/components/default-browserslist.mdx +7 -0
- package/docs/en/components/deploy-command.mdx +14 -0
- package/docs/en/components/deploy.mdx +1 -0
- package/docs/en/components/enable-bff-caution.mdx +3 -0
- package/docs/en/components/enable-bff.mdx +56 -0
- package/docs/en/components/enable-ssg.mdx +49 -0
- package/docs/en/components/entry-mode.mdx +0 -0
- package/docs/en/components/entry-scan-logic.mdx +7 -0
- package/docs/en/components/extend-bff-function.mdx +3 -0
- package/docs/en/components/hono.mdx +120 -0
- package/docs/en/components/init-app.mdx +111 -0
- package/docs/en/components/init-rspack-app.mdx +5 -0
- package/docs/en/components/internal-logger.mdx +25 -0
- package/docs/en/components/internal-metrics.mdx +20 -0
- package/docs/en/components/international/custom-instance-code.mdx +16 -0
- package/docs/en/components/international/init-options-desc.mdx +1 -0
- package/docs/en/components/international/install-command.mdx +10 -0
- package/docs/en/components/international/instance-code.mdx +16 -0
- package/docs/en/components/international/introduce.mdx +5 -0
- package/docs/en/components/international/platform-support.mdx +0 -0
- package/docs/en/components/language-config.mdx +9 -0
- package/docs/en/components/micro-frontend.mdx +6 -0
- package/docs/en/components/micro-master-manifest-config.mdx +15 -0
- package/docs/en/components/micro-runtime-config.mdx +17 -0
- package/docs/en/components/module-federation.mdx +7 -0
- package/docs/en/components/new-entry-tooltip.mdx +0 -0
- package/docs/en/components/nodeVersion.mdx +28 -0
- package/docs/en/components/other-plugins.mdx +0 -0
- package/docs/en/components/output-asset-prefix-extend.mdx +0 -0
- package/docs/en/components/output-distpath-warning.mdx +0 -0
- package/docs/en/components/output-polyfill-extend.mdx +1 -0
- package/docs/en/components/prerequisites.mdx +18 -0
- package/docs/en/components/release-note.mdx +1 -0
- package/docs/en/components/routes-practice.mdx +0 -0
- package/docs/en/components/rsbuild-config-tooltip.mdx +5 -0
- package/docs/en/components/rsbuild.mdx +3 -0
- package/docs/en/components/rsc-deploy-tip.mdx +1 -0
- package/docs/en/components/rspack.mdx +3 -0
- package/docs/en/components/rspackTip.mdx +7 -0
- package/docs/en/components/runtime-cli-config.mdx +0 -0
- package/docs/en/components/serve-command.mdx +22 -0
- package/docs/en/components/ssr-monitor.mdx +3 -0
- package/docs/en/components/stream-ssr-performance.mdx +0 -0
- package/docs/en/components/swc.mdx +3 -0
- package/docs/en/components/tech-stack-node-framework.mdx +1 -0
- package/docs/en/components/turtorials-example-list.mdx +2 -0
- package/docs/en/components/ua-polyfill.mdx +44 -0
- package/docs/en/components/upgrade-browserslist.mdx +0 -0
- package/docs/en/components/upgrade-config-deploy.mdx +0 -0
- package/docs/en/components/upgrade-faq.mdx +0 -0
- package/docs/en/configure/_meta.json +78 -0
- package/docs/en/configure/app/bff/cross-project.mdx +24 -0
- package/docs/en/configure/app/bff/effect.mdx +152 -0
- package/docs/en/configure/app/bff/prefix.mdx +33 -0
- package/docs/en/configure/app/bff/runtime-framework.mdx +28 -0
- package/docs/en/configure/app/builder-plugins.mdx +70 -0
- package/docs/en/configure/app/dev/asset-prefix.mdx +18 -0
- package/docs/en/configure/app/dev/before-start-url.mdx +21 -0
- package/docs/en/configure/app/dev/client.mdx +45 -0
- package/docs/en/configure/app/dev/hmr.mdx +14 -0
- package/docs/en/configure/app/dev/host.mdx +22 -0
- package/docs/en/configure/app/dev/https.mdx +81 -0
- package/docs/en/configure/app/dev/lazy-compilation.mdx +45 -0
- package/docs/en/configure/app/dev/live-reload.mdx +14 -0
- package/docs/en/configure/app/dev/progress-bar.mdx +23 -0
- package/docs/en/configure/app/dev/server.mdx +128 -0
- package/docs/en/configure/app/dev/setup-middlewares.mdx +36 -0
- package/docs/en/configure/app/dev/start-url.mdx +53 -0
- package/docs/en/configure/app/dev/watch-files.mdx +31 -0
- package/docs/en/configure/app/dev/write-to-disk.mdx +14 -0
- package/docs/en/configure/app/experiments/source-build.mdx +33 -0
- package/docs/en/configure/app/html/app-icon.mdx +32 -0
- package/docs/en/configure/app/html/crossorigin.mdx +14 -0
- package/docs/en/configure/app/html/favicon.mdx +20 -0
- package/docs/en/configure/app/html/inject.mdx +14 -0
- package/docs/en/configure/app/html/meta.mdx +28 -0
- package/docs/en/configure/app/html/mount-id.mdx +14 -0
- package/docs/en/configure/app/html/output-structure.mdx +14 -0
- package/docs/en/configure/app/html/script-loading.mdx +14 -0
- package/docs/en/configure/app/html/tags.mdx +19 -0
- package/docs/en/configure/app/html/template-parameters.mdx +37 -0
- package/docs/en/configure/app/html/template.mdx +14 -0
- package/docs/en/configure/app/html/title.mdx +22 -0
- package/docs/en/configure/app/output/asset-prefix.mdx +18 -0
- package/docs/en/configure/app/output/assets-retry.mdx +81 -0
- package/docs/en/configure/app/output/charset.mdx +14 -0
- package/docs/en/configure/app/output/clean-dist-path.mdx +20 -0
- package/docs/en/configure/app/output/convert-to-rem.mdx +83 -0
- package/docs/en/configure/app/output/copy.mdx +14 -0
- package/docs/en/configure/app/output/css-modules.mdx +52 -0
- package/docs/en/configure/app/output/data-uri-limit.mdx +30 -0
- package/docs/en/configure/app/output/disable-css-module-extension.mdx +59 -0
- package/docs/en/configure/app/output/disable-inline-runtime-chunk.mdx +45 -0
- package/docs/en/configure/app/output/disable-svgr.mdx +20 -0
- package/docs/en/configure/app/output/disable-ts-checker.mdx +53 -0
- package/docs/en/configure/app/output/dist-path.mdx +51 -0
- package/docs/en/configure/app/output/enable-asset-manifest.mdx +40 -0
- package/docs/en/configure/app/output/enable-css-module-tsdeclaration.mdx +32 -0
- package/docs/en/configure/app/output/enable-inline-route-manifests.mdx +20 -0
- package/docs/en/configure/app/output/externals.mdx +24 -0
- package/docs/en/configure/app/output/filename-hash.mdx +14 -0
- package/docs/en/configure/app/output/filename.mdx +59 -0
- package/docs/en/configure/app/output/inject-styles.mdx +14 -0
- package/docs/en/configure/app/output/inline-scripts.mdx +33 -0
- package/docs/en/configure/app/output/inline-styles.mdx +33 -0
- package/docs/en/configure/app/output/legal-comments.mdx +22 -0
- package/docs/en/configure/app/output/minify.mdx +26 -0
- package/docs/en/configure/app/output/override-browserslist.mdx +26 -0
- package/docs/en/configure/app/output/polyfill.mdx +18 -0
- package/docs/en/configure/app/output/source-map.mdx +34 -0
- package/docs/en/configure/app/output/split-route-chunks.mdx +20 -0
- package/docs/en/configure/app/output/ssg.mdx +85 -0
- package/docs/en/configure/app/output/ssgByEntries.mdx +93 -0
- package/docs/en/configure/app/output/svg-default-export.mdx +34 -0
- package/docs/en/configure/app/output/temp-dir.mdx +24 -0
- package/docs/en/configure/app/performance/build-cache.mdx +43 -0
- package/docs/en/configure/app/performance/chunk-split.mdx +44 -0
- package/docs/en/configure/app/performance/dns-prefetch.mdx +19 -0
- package/docs/en/configure/app/performance/preconnect.mdx +20 -0
- package/docs/en/configure/app/performance/prefetch.mdx +25 -0
- package/docs/en/configure/app/performance/preload.mdx +27 -0
- package/docs/en/configure/app/performance/print-file-size.mdx +44 -0
- package/docs/en/configure/app/performance/profile.mdx +14 -0
- package/docs/en/configure/app/performance/remove-console.mdx +14 -0
- package/docs/en/configure/app/performance/remove-moment-locale.mdx +14 -0
- package/docs/en/configure/app/performance/rsdoctor.mdx +39 -0
- package/docs/en/configure/app/plugins.mdx +59 -0
- 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 +61 -0
- package/docs/en/configure/app/runtime/plugins.mdx +58 -0
- package/docs/en/configure/app/runtime/router.mdx +39 -0
- package/docs/en/configure/app/security/check-syntax.mdx +73 -0
- package/docs/en/configure/app/security/nonce.mdx +19 -0
- package/docs/en/configure/app/security/sri.mdx +24 -0
- package/docs/en/configure/app/server/base-url.mdx +30 -0
- package/docs/en/configure/app/server/port.mdx +22 -0
- package/docs/en/configure/app/server/public-routes.mdx +26 -0
- package/docs/en/configure/app/server/routes.mdx +90 -0
- package/docs/en/configure/app/server/rsc.mdx +30 -0
- package/docs/en/configure/app/server/ssr-by-entries.mdx +29 -0
- package/docs/en/configure/app/server/ssr.mdx +85 -0
- package/docs/en/configure/app/server/tsconfig-path.mdx +63 -0
- package/docs/en/configure/app/source/alias-strategy.mdx +18 -0
- package/docs/en/configure/app/source/alias.mdx +27 -0
- package/docs/en/configure/app/source/config-dir.mdx +24 -0
- package/docs/en/configure/app/source/decorators.mdx +29 -0
- package/docs/en/configure/app/source/define.mdx +20 -0
- package/docs/en/configure/app/source/disable-default-entries.mdx +32 -0
- package/docs/en/configure/app/source/enable-async-entry.mdx +54 -0
- package/docs/en/configure/app/source/enable-async-pre-entry.mdx +30 -0
- package/docs/en/configure/app/source/entries-dir.mdx +39 -0
- package/docs/en/configure/app/source/entries.mdx +183 -0
- package/docs/en/configure/app/source/exclude.mdx +14 -0
- package/docs/en/configure/app/source/global-vars.mdx +110 -0
- package/docs/en/configure/app/source/include.mdx +40 -0
- package/docs/en/configure/app/source/main-entry-name.mdx +28 -0
- package/docs/en/configure/app/source/pre-entry.mdx +14 -0
- package/docs/en/configure/app/source/transform-import.mdx +31 -0
- package/docs/en/configure/app/split-chunks.mdx +17 -0
- package/docs/en/configure/app/tools/autoprefixer.mdx +48 -0
- package/docs/en/configure/app/tools/bundler-chain.mdx +30 -0
- package/docs/en/configure/app/tools/css-extract.mdx +37 -0
- package/docs/en/configure/app/tools/css-loader.mdx +21 -0
- package/docs/en/configure/app/tools/dev-server.mdx +117 -0
- package/docs/en/configure/app/tools/html-plugin.mdx +45 -0
- package/docs/en/configure/app/tools/less.mdx +85 -0
- package/docs/en/configure/app/tools/lightningcss-loader.mdx +39 -0
- package/docs/en/configure/app/tools/minify-css.mdx +57 -0
- package/docs/en/configure/app/tools/postcss.mdx +38 -0
- package/docs/en/configure/app/tools/rspack.mdx +14 -0
- package/docs/en/configure/app/tools/sass.mdx +82 -0
- package/docs/en/configure/app/tools/style-loader.mdx +14 -0
- package/docs/en/configure/app/tools/swc.mdx +69 -0
- package/docs/en/configure/app/tools/ts-checker.mdx +56 -0
- package/docs/en/configure/app/usage.mdx +276 -0
- package/docs/en/guides/_meta.json +37 -0
- package/docs/en/guides/advanced-features/_meta.json +32 -0
- package/docs/en/guides/advanced-features/bff/_meta.json +10 -0
- package/docs/en/guides/advanced-features/bff/cross-project.mdx +110 -0
- package/docs/en/guides/advanced-features/bff/data-platform.mdx +118 -0
- package/docs/en/guides/advanced-features/bff/extend-server.mdx +120 -0
- package/docs/en/guides/advanced-features/bff/frameworks.mdx +118 -0
- package/docs/en/guides/advanced-features/bff/function.mdx +261 -0
- package/docs/en/guides/advanced-features/bff/operators.mdx +629 -0
- package/docs/en/guides/advanced-features/bff/sdk.mdx +116 -0
- package/docs/en/guides/advanced-features/bff/upload.mdx +7 -0
- package/docs/en/guides/advanced-features/bff.mdx +22 -0
- package/docs/en/guides/advanced-features/build-performance.mdx +134 -0
- package/docs/en/guides/advanced-features/compatibility.mdx +81 -0
- package/docs/en/guides/advanced-features/international/_meta.json +10 -0
- package/docs/en/guides/advanced-features/international/advanced.mdx +132 -0
- package/docs/en/guides/advanced-features/international/api.mdx +235 -0
- package/docs/en/guides/advanced-features/international/best-practices.mdx +290 -0
- package/docs/en/guides/advanced-features/international/configuration.mdx +221 -0
- package/docs/en/guides/advanced-features/international/locale-detection.mdx +130 -0
- package/docs/en/guides/advanced-features/international/quick-start.mdx +112 -0
- package/docs/en/guides/advanced-features/international/resource-loading.mdx +158 -0
- package/docs/en/guides/advanced-features/international/routing.mdx +134 -0
- package/docs/en/guides/advanced-features/international.mdx +29 -0
- package/docs/en/guides/advanced-features/low-level.mdx +50 -0
- package/docs/en/guides/advanced-features/page-performance/_meta.json +1 -0
- package/docs/en/guides/advanced-features/page-performance/code-split.mdx +81 -0
- package/docs/en/guides/advanced-features/page-performance/inline-assets.mdx +163 -0
- package/docs/en/guides/advanced-features/page-performance/optimize-bundle.mdx +101 -0
- package/docs/en/guides/advanced-features/page-performance/react-compiler.mdx +54 -0
- package/docs/en/guides/advanced-features/server-monitor/_meta.json +1 -0
- package/docs/en/guides/advanced-features/server-monitor/logger.mdx +19 -0
- package/docs/en/guides/advanced-features/server-monitor/metrics.mdx +41 -0
- package/docs/en/guides/advanced-features/server-monitor/monitors.mdx +242 -0
- package/docs/en/guides/advanced-features/source-build.mdx +168 -0
- package/docs/en/guides/advanced-features/web-server.mdx +284 -0
- package/docs/en/guides/basic-features/_meta.json +49 -0
- package/docs/en/guides/basic-features/alias.mdx +106 -0
- package/docs/en/guides/basic-features/css/_meta.json +1 -0
- package/docs/en/guides/basic-features/css/css-in-js.mdx +69 -0
- package/docs/en/guides/basic-features/css/css-modules.mdx +212 -0
- package/docs/en/guides/basic-features/css/css.mdx +31 -0
- package/docs/en/guides/basic-features/css/tailwindcss.mdx +27 -0
- package/docs/en/guides/basic-features/data/_meta.json +1 -0
- package/docs/en/guides/basic-features/data/data-cache.mdx +515 -0
- package/docs/en/guides/basic-features/data/data-fetch.mdx +419 -0
- package/docs/en/guides/basic-features/data/data-write.mdx +230 -0
- package/docs/en/guides/basic-features/debug/_meta.json +1 -0
- package/docs/en/guides/basic-features/debug/mock.mdx +102 -0
- package/docs/en/guides/basic-features/debug/proxy.mdx +25 -0
- package/docs/en/guides/basic-features/debug/rsdoctor.mdx +48 -0
- package/docs/en/guides/basic-features/debug/using-storybook.mdx +100 -0
- package/docs/en/guides/basic-features/deploy.mdx +448 -0
- package/docs/en/guides/basic-features/env-vars.mdx +181 -0
- package/docs/en/guides/basic-features/html.mdx +259 -0
- package/docs/en/guides/basic-features/output-files.mdx +145 -0
- package/docs/en/guides/basic-features/render/_meta.json +10 -0
- package/docs/en/guides/basic-features/render/before-render.mdx +108 -0
- package/docs/en/guides/basic-features/render/overview.mdx +52 -0
- package/docs/en/guides/basic-features/render/rsc.mdx +534 -0
- package/docs/en/guides/basic-features/render/ssg.mdx +167 -0
- package/docs/en/guides/basic-features/render/ssr-cache.mdx +201 -0
- package/docs/en/guides/basic-features/render/ssr.mdx +323 -0
- package/docs/en/guides/basic-features/render/streaming-ssr.mdx +267 -0
- package/docs/en/guides/basic-features/render/tanstack-rsc.mdx +226 -0
- 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/routes.mdx +517 -0
- package/docs/en/guides/basic-features/static-assets/_meta.json +1 -0
- package/docs/en/guides/basic-features/static-assets/json-files.mdx +124 -0
- package/docs/en/guides/basic-features/static-assets/svg-assets.mdx +172 -0
- package/docs/en/guides/basic-features/static-assets/wasm-assets.mdx +66 -0
- package/docs/en/guides/basic-features/static-assets.mdx +164 -0
- package/docs/en/guides/basic-features/testing/_meta.json +1 -0
- package/docs/en/guides/basic-features/testing/cypress.mdx +95 -0
- package/docs/en/guides/basic-features/testing/jest.mdx +148 -0
- package/docs/en/guides/basic-features/testing/playwright.mdx +111 -0
- package/docs/en/guides/basic-features/testing/rstest.mdx +163 -0
- package/docs/en/guides/basic-features/testing/vitest.mdx +100 -0
- package/docs/en/guides/concept/_meta.json +1 -0
- package/docs/en/guides/concept/builder.mdx +60 -0
- package/docs/en/guides/concept/entries.mdx +325 -0
- package/docs/en/guides/concept/server.mdx +35 -0
- package/docs/en/guides/get-started/_meta.json +8 -0
- package/docs/en/guides/get-started/glossary.mdx +63 -0
- package/docs/en/guides/get-started/introduction.mdx +45 -0
- package/docs/en/guides/get-started/quick-start.mdx +92 -0
- package/docs/en/guides/get-started/tech-stack.mdx +91 -0
- package/docs/en/guides/get-started/ultramodern.mdx +98 -0
- package/docs/en/guides/get-started/upgrade.mdx +114 -0
- package/docs/en/guides/topic-detail/_meta.json +8 -0
- package/docs/en/guides/topic-detail/module-federation/_meta.json +1 -0
- package/docs/en/guides/topic-detail/module-federation/application.mdx +116 -0
- package/docs/en/guides/topic-detail/module-federation/deploy.mdx +104 -0
- package/docs/en/guides/topic-detail/module-federation/i18n.mdx +670 -0
- package/docs/en/guides/topic-detail/module-federation/introduce.mdx +36 -0
- package/docs/en/guides/topic-detail/module-federation/ssr.mdx +170 -0
- package/docs/en/guides/topic-detail/module-federation/usage.mdx +202 -0
- package/docs/en/guides/troubleshooting/_meta.json +1 -0
- package/docs/en/guides/troubleshooting/builder.mdx +114 -0
- package/docs/en/guides/troubleshooting/cli.mdx +39 -0
- package/docs/en/guides/troubleshooting/dependencies.mdx +123 -0
- package/docs/en/guides/troubleshooting/hmr.mdx +148 -0
- package/docs/en/guides/upgrade/_meta.json +1 -0
- package/docs/en/guides/upgrade/config.mdx +949 -0
- package/docs/en/guides/upgrade/entry.mdx +463 -0
- package/docs/en/guides/upgrade/other.mdx +183 -0
- package/docs/en/guides/upgrade/overview.mdx +33 -0
- package/docs/en/guides/upgrade/tailwindcss.mdx +92 -0
- package/docs/en/guides/upgrade/web-server.md +109 -0
- package/docs/en/index.md +4 -0
- package/docs/en/plugin/_meta.json +25 -0
- package/docs/en/plugin/cli-plugins/_meta.json +1 -0
- package/docs/en/plugin/cli-plugins/api.mdx +573 -0
- package/docs/en/plugin/cli-plugins/life-cycle.mdx +135 -0
- package/docs/en/plugin/introduction.mdx +153 -0
- package/docs/en/plugin/official/_meta.json +7 -0
- package/docs/en/plugin/official/cli-plugins/_meta.json +1 -0
- package/docs/en/plugin/official/cli-plugins/plugin-bff.mdx +5 -0
- package/docs/en/plugin/official/cli-plugins/plugin-ssg.mdx +5 -0
- package/docs/en/plugin/official/cli-plugins/plugin-styled-components.mdx +5 -0
- package/docs/en/plugin/official/cli-plugins.mdx +4 -0
- package/docs/en/plugin/plugin-system.mdx +244 -0
- package/docs/en/plugin/runtime-plugins/_meta.json +1 -0
- package/docs/en/plugin/runtime-plugins/api.mdx +193 -0
- package/docs/en/plugin/runtime-plugins/life-cycle.mdx +29 -0
- package/docs/en/plugin/server-plugins/_meta.json +1 -0
- package/docs/en/plugin/server-plugins/api.mdx +212 -0
- package/docs/en/plugin/server-plugins/life-cycle.mdx +43 -0
- package/docs/en/tutorials/_meta.json +7 -0
- package/docs/en/tutorials/examples/csr-auth.mdx +31 -0
- package/docs/en/tutorials/foundations/introduction.mdx +22 -0
- package/docs/zh/_nav.json +36 -0
- package/docs/zh/apis/_meta.json +13 -0
- package/docs/zh/apis/app/commands.mdx +215 -0
- package/docs/zh/apis/app/hooks/_meta.json +28 -0
- package/docs/zh/apis/app/hooks/api/lambda.mdx +14 -0
- package/docs/zh/apis/app/hooks/config/_meta.json +1 -0
- package/docs/zh/apis/app/hooks/config/favicon.mdx +29 -0
- package/docs/zh/apis/app/hooks/config/html.mdx +9 -0
- package/docs/zh/apis/app/hooks/config/icon.mdx +29 -0
- package/docs/zh/apis/app/hooks/config/mock.mdx +7 -0
- package/docs/zh/apis/app/hooks/config/public.mdx +30 -0
- package/docs/zh/apis/app/hooks/config/upload.mdx +54 -0
- package/docs/zh/apis/app/hooks/modern-config.mdx +9 -0
- package/docs/zh/apis/app/hooks/server/server.mdx +10 -0
- package/docs/zh/apis/app/hooks/shared.mdx +7 -0
- package/docs/zh/apis/app/hooks/src/app.mdx +36 -0
- package/docs/zh/apis/app/hooks/src/entry.mdx +39 -0
- package/docs/zh/apis/app/hooks/src/entry.server.mdx +56 -0
- package/docs/zh/apis/app/hooks/src/modern.runtime.mdx +9 -0
- package/docs/zh/apis/app/hooks/src/routes.mdx +90 -0
- package/docs/zh/apis/app/hooks/src/server.mdx +7 -0
- package/docs/zh/apis/app/runtime/_meta.json +32 -0
- package/docs/zh/apis/app/runtime/bff/use-backend-context.mdx +31 -0
- package/docs/zh/apis/app/runtime/core/create-root.mdx +22 -0
- package/docs/zh/apis/app/runtime/core/render.mdx +43 -0
- package/docs/zh/apis/app/runtime/core/runtime-context.mdx +160 -0
- package/docs/zh/apis/app/runtime/router/router.mdx +287 -0
- package/docs/zh/apis/app/runtime/ssr/no-ssr.mdx +38 -0
- package/docs/zh/apis/app/runtime/ssr/renderStreaming.mdx +71 -0
- package/docs/zh/apis/app/runtime/ssr/renderString.mdx +64 -0
- package/docs/zh/apis/app/runtime/ssr/requestHandler.mdx +48 -0
- package/docs/zh/apis/app/runtime/utility/css-in-js.mdx +44 -0
- package/docs/zh/apis/app/runtime/utility/head.mdx +38 -0
- package/docs/zh/apis/app/runtime/utility/loadable.mdx +83 -0
- package/docs/zh/community/_meta.json +11 -0
- package/docs/zh/community/blog/2022-0708-updates.md +95 -0
- package/docs/zh/community/blog/2022-0910-updates.md +80 -0
- package/docs/zh/community/blog/_meta.json +7 -0
- package/docs/zh/community/blog/overview.md +74 -0
- package/docs/zh/community/blog/v2-release-note.mdx +244 -0
- package/docs/zh/community/blog/v3-release-note.mdx +628 -0
- package/docs/zh/community/contributing-guide.mdx +256 -0
- package/docs/zh/community/releases.mdx +31 -0
- package/docs/zh/community/showcase.mdx +15 -0
- package/docs/zh/community/team.mdx +29 -0
- package/docs/zh/components/auto-upgrade.mdx +0 -0
- package/docs/zh/components/bff-operator-code.mdx +5 -0
- package/docs/zh/components/bff-upload.mdx +98 -0
- package/docs/zh/components/build-output.mdx +45 -0
- package/docs/zh/components/bundler.mdx +3 -0
- package/docs/zh/components/convention-routing-motivation.mdx +0 -0
- package/docs/zh/components/debug-app.mdx +16 -0
- package/docs/zh/components/default-browserslist.mdx +7 -0
- package/docs/zh/components/deploy-command.mdx +14 -0
- package/docs/zh/components/deploy.mdx +1 -0
- package/docs/zh/components/enable-bff-caution.mdx +4 -0
- package/docs/zh/components/enable-bff.mdx +56 -0
- package/docs/zh/components/enable-ssg.mdx +49 -0
- package/docs/zh/components/entry-mode.mdx +0 -0
- package/docs/zh/components/entry-scan-logic.mdx +7 -0
- package/docs/zh/components/extend-bff-function.mdx +3 -0
- package/docs/zh/components/hono.mdx +120 -0
- package/docs/zh/components/init-app.mdx +111 -0
- package/docs/zh/components/init-rspack-app.mdx +5 -0
- package/docs/zh/components/internal-logger.mdx +25 -0
- package/docs/zh/components/internal-metrics.mdx +20 -0
- package/docs/zh/components/international/custom-instance-code.mdx +16 -0
- package/docs/zh/components/international/init-options-desc.mdx +1 -0
- package/docs/zh/components/international/install-command.mdx +11 -0
- package/docs/zh/components/international/instance-code.mdx +16 -0
- package/docs/zh/components/international/introduce.mdx +5 -0
- package/docs/zh/components/international/platform-support.mdx +0 -0
- package/docs/zh/components/language-config.mdx +9 -0
- package/docs/zh/components/micro-frontend.mdx +6 -0
- package/docs/zh/components/micro-master-manifest-config.mdx +15 -0
- package/docs/zh/components/micro-runtime-config.mdx +17 -0
- package/docs/zh/components/module-federation.mdx +7 -0
- package/docs/zh/components/new-entry-tooltip.mdx +0 -0
- package/docs/zh/components/nodeVersion.mdx +28 -0
- package/docs/zh/components/other-plugins.mdx +0 -0
- package/docs/zh/components/output-asset-prefix-extend.mdx +0 -0
- package/docs/zh/components/output-distpath-warning.mdx +0 -0
- package/docs/zh/components/output-polyfill-extend.mdx +1 -0
- package/docs/zh/components/prerequisites.mdx +18 -0
- package/docs/zh/components/release-note.mdx +1 -0
- package/docs/zh/components/routes-practice.mdx +0 -0
- package/docs/zh/components/rsbuild-config-tooltip.mdx +5 -0
- package/docs/zh/components/rsbuild.mdx +3 -0
- package/docs/zh/components/rsc-deploy-tip.mdx +1 -0
- package/docs/zh/components/rspack.mdx +3 -0
- package/docs/zh/components/rspackTip.mdx +7 -0
- package/docs/zh/components/runtime-cli-config.mdx +0 -0
- package/docs/zh/components/self-route-example.mdx +21 -0
- package/docs/zh/components/serve-command.mdx +22 -0
- package/docs/zh/components/ssr-monitor.mdx +3 -0
- package/docs/zh/components/stream-ssr-performance.mdx +0 -0
- package/docs/zh/components/swc.mdx +3 -0
- package/docs/zh/components/tech-stack-node-framework.mdx +1 -0
- package/docs/zh/components/turtorials-example-list.mdx +2 -0
- package/docs/zh/components/ua-polyfill.mdx +44 -0
- package/docs/zh/components/upgrade-browserslist.mdx +0 -0
- package/docs/zh/components/upgrade-config-deploy.mdx +0 -0
- package/docs/zh/components/upgrade-faq.mdx +0 -0
- package/docs/zh/configure/_meta.json +78 -0
- package/docs/zh/configure/app/bff/cross-project.mdx +24 -0
- package/docs/zh/configure/app/bff/effect.mdx +152 -0
- package/docs/zh/configure/app/bff/prefix.mdx +33 -0
- package/docs/zh/configure/app/bff/runtime-framework.mdx +28 -0
- package/docs/zh/configure/app/builder-plugins.mdx +72 -0
- package/docs/zh/configure/app/dev/asset-prefix.mdx +18 -0
- package/docs/zh/configure/app/dev/before-start-url.mdx +21 -0
- package/docs/zh/configure/app/dev/client.mdx +45 -0
- package/docs/zh/configure/app/dev/hmr.mdx +14 -0
- package/docs/zh/configure/app/dev/host.mdx +22 -0
- package/docs/zh/configure/app/dev/https.mdx +82 -0
- package/docs/zh/configure/app/dev/lazy-compilation.mdx +44 -0
- package/docs/zh/configure/app/dev/live-reload.mdx +14 -0
- package/docs/zh/configure/app/dev/progress-bar.mdx +23 -0
- package/docs/zh/configure/app/dev/server.mdx +128 -0
- package/docs/zh/configure/app/dev/setup-middlewares.mdx +36 -0
- package/docs/zh/configure/app/dev/start-url.mdx +54 -0
- package/docs/zh/configure/app/dev/watch-files.mdx +31 -0
- package/docs/zh/configure/app/dev/write-to-disk.mdx +14 -0
- package/docs/zh/configure/app/experiments/source-build.mdx +35 -0
- package/docs/zh/configure/app/html/app-icon.mdx +32 -0
- package/docs/zh/configure/app/html/crossorigin.mdx +15 -0
- package/docs/zh/configure/app/html/favicon.mdx +21 -0
- package/docs/zh/configure/app/html/inject.mdx +14 -0
- package/docs/zh/configure/app/html/meta.mdx +28 -0
- package/docs/zh/configure/app/html/mount-id.mdx +14 -0
- package/docs/zh/configure/app/html/output-structure.mdx +14 -0
- package/docs/zh/configure/app/html/script-loading.mdx +14 -0
- package/docs/zh/configure/app/html/tags.mdx +19 -0
- package/docs/zh/configure/app/html/template-parameters.mdx +37 -0
- package/docs/zh/configure/app/html/template.mdx +14 -0
- package/docs/zh/configure/app/html/title.mdx +22 -0
- package/docs/zh/configure/app/output/asset-prefix.mdx +18 -0
- package/docs/zh/configure/app/output/assets-retry.mdx +81 -0
- package/docs/zh/configure/app/output/charset.mdx +14 -0
- package/docs/zh/configure/app/output/clean-dist-path.mdx +20 -0
- package/docs/zh/configure/app/output/convert-to-rem.mdx +84 -0
- package/docs/zh/configure/app/output/copy.mdx +14 -0
- package/docs/zh/configure/app/output/css-modules.mdx +52 -0
- package/docs/zh/configure/app/output/data-uri-limit.mdx +30 -0
- package/docs/zh/configure/app/output/disable-css-module-extension.mdx +59 -0
- package/docs/zh/configure/app/output/disable-inline-runtime-chunk.mdx +45 -0
- package/docs/zh/configure/app/output/disable-svgr.mdx +21 -0
- package/docs/zh/configure/app/output/disable-ts-checker.mdx +53 -0
- package/docs/zh/configure/app/output/dist-path.mdx +50 -0
- package/docs/zh/configure/app/output/enable-asset-manifest.mdx +40 -0
- package/docs/zh/configure/app/output/enable-css-module-tsdeclaration.mdx +32 -0
- package/docs/zh/configure/app/output/enable-inline-route-manifests.mdx +21 -0
- package/docs/zh/configure/app/output/externals.mdx +24 -0
- package/docs/zh/configure/app/output/filename-hash.mdx +14 -0
- package/docs/zh/configure/app/output/filename.mdx +62 -0
- package/docs/zh/configure/app/output/inject-styles.mdx +14 -0
- package/docs/zh/configure/app/output/inline-scripts.mdx +33 -0
- package/docs/zh/configure/app/output/inline-styles.mdx +33 -0
- package/docs/zh/configure/app/output/legal-comments.mdx +22 -0
- package/docs/zh/configure/app/output/minify.mdx +26 -0
- package/docs/zh/configure/app/output/override-browserslist.mdx +26 -0
- package/docs/zh/configure/app/output/polyfill.mdx +18 -0
- package/docs/zh/configure/app/output/source-map.mdx +38 -0
- package/docs/zh/configure/app/output/split-route-chunks.mdx +20 -0
- package/docs/zh/configure/app/output/ssg.mdx +84 -0
- package/docs/zh/configure/app/output/ssgByEntries.mdx +94 -0
- package/docs/zh/configure/app/output/svg-default-export.mdx +34 -0
- package/docs/zh/configure/app/output/temp-dir.mdx +22 -0
- package/docs/zh/configure/app/performance/build-cache.mdx +43 -0
- package/docs/zh/configure/app/performance/chunk-split.mdx +44 -0
- package/docs/zh/configure/app/performance/dns-prefetch.mdx +19 -0
- package/docs/zh/configure/app/performance/preconnect.mdx +20 -0
- package/docs/zh/configure/app/performance/prefetch.mdx +25 -0
- package/docs/zh/configure/app/performance/preload.mdx +27 -0
- package/docs/zh/configure/app/performance/print-file-size.mdx +44 -0
- package/docs/zh/configure/app/performance/profile.mdx +14 -0
- package/docs/zh/configure/app/performance/remove-console.mdx +14 -0
- package/docs/zh/configure/app/performance/remove-moment-locale.mdx +14 -0
- package/docs/zh/configure/app/performance/rsdoctor.mdx +39 -0
- package/docs/zh/configure/app/plugins.mdx +59 -0
- 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 +58 -0
- package/docs/zh/configure/app/runtime/plugins.mdx +58 -0
- package/docs/zh/configure/app/runtime/router.mdx +39 -0
- package/docs/zh/configure/app/security/check-syntax.mdx +73 -0
- package/docs/zh/configure/app/security/nonce.mdx +19 -0
- package/docs/zh/configure/app/security/sri.mdx +24 -0
- package/docs/zh/configure/app/server/base-url.mdx +30 -0
- package/docs/zh/configure/app/server/port.mdx +23 -0
- package/docs/zh/configure/app/server/public-routes.mdx +26 -0
- package/docs/zh/configure/app/server/routes.mdx +90 -0
- package/docs/zh/configure/app/server/rsc.mdx +30 -0
- package/docs/zh/configure/app/server/ssr-by-entries.mdx +29 -0
- package/docs/zh/configure/app/server/ssr.mdx +85 -0
- package/docs/zh/configure/app/server/tsconfig-path.mdx +63 -0
- package/docs/zh/configure/app/source/alias-strategy.mdx +18 -0
- package/docs/zh/configure/app/source/alias.mdx +27 -0
- package/docs/zh/configure/app/source/config-dir.mdx +24 -0
- package/docs/zh/configure/app/source/decorators.mdx +27 -0
- package/docs/zh/configure/app/source/define.mdx +20 -0
- package/docs/zh/configure/app/source/disable-default-entries.mdx +32 -0
- package/docs/zh/configure/app/source/enable-async-entry.mdx +54 -0
- package/docs/zh/configure/app/source/enable-async-pre-entry.mdx +77 -0
- package/docs/zh/configure/app/source/entries-dir.mdx +39 -0
- package/docs/zh/configure/app/source/entries.mdx +185 -0
- package/docs/zh/configure/app/source/exclude.mdx +14 -0
- package/docs/zh/configure/app/source/global-vars.mdx +109 -0
- package/docs/zh/configure/app/source/include.mdx +40 -0
- package/docs/zh/configure/app/source/main-entry-name.mdx +28 -0
- package/docs/zh/configure/app/source/pre-entry.mdx +14 -0
- package/docs/zh/configure/app/source/transform-import.mdx +31 -0
- package/docs/zh/configure/app/split-chunks.mdx +17 -0
- package/docs/zh/configure/app/tools/autoprefixer.mdx +48 -0
- package/docs/zh/configure/app/tools/bundler-chain.mdx +33 -0
- package/docs/zh/configure/app/tools/css-extract.mdx +34 -0
- package/docs/zh/configure/app/tools/css-loader.mdx +21 -0
- package/docs/zh/configure/app/tools/dev-server.mdx +117 -0
- package/docs/zh/configure/app/tools/html-plugin.mdx +45 -0
- package/docs/zh/configure/app/tools/less.mdx +86 -0
- package/docs/zh/configure/app/tools/lightningcss-loader.mdx +39 -0
- package/docs/zh/configure/app/tools/minify-css.mdx +57 -0
- package/docs/zh/configure/app/tools/postcss.mdx +39 -0
- package/docs/zh/configure/app/tools/rspack.mdx +14 -0
- package/docs/zh/configure/app/tools/sass.mdx +80 -0
- package/docs/zh/configure/app/tools/style-loader.mdx +14 -0
- package/docs/zh/configure/app/tools/swc.mdx +69 -0
- package/docs/zh/configure/app/tools/ts-checker.mdx +56 -0
- package/docs/zh/configure/app/usage.mdx +276 -0
- package/docs/zh/guides/_meta.json +37 -0
- package/docs/zh/guides/advanced-features/_meta.json +32 -0
- package/docs/zh/guides/advanced-features/bff/_meta.json +10 -0
- package/docs/zh/guides/advanced-features/bff/cross-project.mdx +112 -0
- package/docs/zh/guides/advanced-features/bff/data-platform.mdx +118 -0
- package/docs/zh/guides/advanced-features/bff/extend-server.mdx +125 -0
- package/docs/zh/guides/advanced-features/bff/frameworks.mdx +118 -0
- package/docs/zh/guides/advanced-features/bff/function.mdx +262 -0
- package/docs/zh/guides/advanced-features/bff/operators.mdx +629 -0
- package/docs/zh/guides/advanced-features/bff/sdk.mdx +117 -0
- package/docs/zh/guides/advanced-features/bff/upload.mdx +7 -0
- package/docs/zh/guides/advanced-features/bff.mdx +21 -0
- package/docs/zh/guides/advanced-features/build-performance.mdx +134 -0
- package/docs/zh/guides/advanced-features/compatibility.mdx +80 -0
- package/docs/zh/guides/advanced-features/international/_meta.json +10 -0
- package/docs/zh/guides/advanced-features/international/advanced.mdx +132 -0
- package/docs/zh/guides/advanced-features/international/api.mdx +234 -0
- package/docs/zh/guides/advanced-features/international/best-practices.mdx +290 -0
- package/docs/zh/guides/advanced-features/international/configuration.mdx +219 -0
- package/docs/zh/guides/advanced-features/international/locale-detection.mdx +130 -0
- package/docs/zh/guides/advanced-features/international/quick-start.mdx +112 -0
- package/docs/zh/guides/advanced-features/international/resource-loading.mdx +155 -0
- package/docs/zh/guides/advanced-features/international/routing.mdx +134 -0
- package/docs/zh/guides/advanced-features/international.mdx +29 -0
- package/docs/zh/guides/advanced-features/low-level.mdx +48 -0
- package/docs/zh/guides/advanced-features/page-performance/_meta.json +1 -0
- package/docs/zh/guides/advanced-features/page-performance/code-split.mdx +81 -0
- package/docs/zh/guides/advanced-features/page-performance/inline-assets.mdx +162 -0
- package/docs/zh/guides/advanced-features/page-performance/optimize-bundle.mdx +101 -0
- package/docs/zh/guides/advanced-features/page-performance/react-compiler.mdx +54 -0
- package/docs/zh/guides/advanced-features/server-monitor/_meta.json +1 -0
- package/docs/zh/guides/advanced-features/server-monitor/logger.mdx +21 -0
- package/docs/zh/guides/advanced-features/server-monitor/metrics.mdx +42 -0
- package/docs/zh/guides/advanced-features/server-monitor/monitors.mdx +240 -0
- package/docs/zh/guides/advanced-features/source-build.mdx +168 -0
- package/docs/zh/guides/advanced-features/web-server.mdx +281 -0
- package/docs/zh/guides/basic-features/_meta.json +49 -0
- package/docs/zh/guides/basic-features/alias.mdx +100 -0
- package/docs/zh/guides/basic-features/css/_meta.json +1 -0
- package/docs/zh/guides/basic-features/css/css-in-js.mdx +69 -0
- package/docs/zh/guides/basic-features/css/css-modules.mdx +218 -0
- package/docs/zh/guides/basic-features/css/css.mdx +31 -0
- package/docs/zh/guides/basic-features/css/tailwindcss.mdx +27 -0
- package/docs/zh/guides/basic-features/data/_meta.json +1 -0
- package/docs/zh/guides/basic-features/data/data-cache.mdx +498 -0
- package/docs/zh/guides/basic-features/data/data-fetch.mdx +421 -0
- package/docs/zh/guides/basic-features/data/data-write.mdx +234 -0
- package/docs/zh/guides/basic-features/debug/_meta.json +1 -0
- package/docs/zh/guides/basic-features/debug/mock.mdx +102 -0
- package/docs/zh/guides/basic-features/debug/proxy.mdx +25 -0
- package/docs/zh/guides/basic-features/debug/rsdoctor.mdx +48 -0
- package/docs/zh/guides/basic-features/debug/using-storybook.mdx +92 -0
- package/docs/zh/guides/basic-features/deploy.mdx +432 -0
- package/docs/zh/guides/basic-features/env-vars.mdx +180 -0
- package/docs/zh/guides/basic-features/html.mdx +262 -0
- package/docs/zh/guides/basic-features/output-files.mdx +145 -0
- package/docs/zh/guides/basic-features/render/_meta.json +10 -0
- package/docs/zh/guides/basic-features/render/before-render.mdx +108 -0
- package/docs/zh/guides/basic-features/render/overview.mdx +53 -0
- package/docs/zh/guides/basic-features/render/rsc.mdx +619 -0
- package/docs/zh/guides/basic-features/render/ssg.mdx +168 -0
- package/docs/zh/guides/basic-features/render/ssr-cache.mdx +205 -0
- package/docs/zh/guides/basic-features/render/ssr.mdx +334 -0
- package/docs/zh/guides/basic-features/render/streaming-ssr.mdx +276 -0
- package/docs/zh/guides/basic-features/render/tanstack-rsc.mdx +226 -0
- 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/routes.mdx +521 -0
- package/docs/zh/guides/basic-features/static-assets/_meta.json +1 -0
- package/docs/zh/guides/basic-features/static-assets/json-files.mdx +124 -0
- package/docs/zh/guides/basic-features/static-assets/svg-assets.mdx +174 -0
- package/docs/zh/guides/basic-features/static-assets/wasm-assets.mdx +66 -0
- package/docs/zh/guides/basic-features/static-assets.mdx +160 -0
- package/docs/zh/guides/basic-features/testing/_meta.json +1 -0
- package/docs/zh/guides/basic-features/testing/cypress.mdx +95 -0
- package/docs/zh/guides/basic-features/testing/jest.mdx +148 -0
- package/docs/zh/guides/basic-features/testing/playwright.mdx +112 -0
- package/docs/zh/guides/basic-features/testing/rstest.mdx +163 -0
- package/docs/zh/guides/basic-features/testing/vitest.mdx +100 -0
- package/docs/zh/guides/concept/_meta.json +1 -0
- package/docs/zh/guides/concept/builder.mdx +60 -0
- package/docs/zh/guides/concept/entries.mdx +323 -0
- package/docs/zh/guides/concept/server.mdx +35 -0
- package/docs/zh/guides/get-started/_meta.json +8 -0
- package/docs/zh/guides/get-started/glossary.mdx +63 -0
- package/docs/zh/guides/get-started/introduction.mdx +45 -0
- package/docs/zh/guides/get-started/quick-start.mdx +90 -0
- package/docs/zh/guides/get-started/tech-stack.mdx +91 -0
- package/docs/zh/guides/get-started/ultramodern.mdx +80 -0
- package/docs/zh/guides/get-started/upgrade.mdx +114 -0
- package/docs/zh/guides/topic-detail/_meta.json +8 -0
- package/docs/zh/guides/topic-detail/module-federation/_meta.json +1 -0
- package/docs/zh/guides/topic-detail/module-federation/application.mdx +117 -0
- package/docs/zh/guides/topic-detail/module-federation/deploy.mdx +104 -0
- package/docs/zh/guides/topic-detail/module-federation/i18n.mdx +623 -0
- package/docs/zh/guides/topic-detail/module-federation/introduce.mdx +35 -0
- package/docs/zh/guides/topic-detail/module-federation/ssr.mdx +168 -0
- package/docs/zh/guides/topic-detail/module-federation/usage.mdx +200 -0
- package/docs/zh/guides/troubleshooting/_meta.json +1 -0
- package/docs/zh/guides/troubleshooting/builder.mdx +134 -0
- package/docs/zh/guides/troubleshooting/cli.mdx +39 -0
- package/docs/zh/guides/troubleshooting/dependencies.mdx +123 -0
- package/docs/zh/guides/troubleshooting/hmr.mdx +148 -0
- package/docs/zh/guides/upgrade/_meta.json +1 -0
- package/docs/zh/guides/upgrade/config.mdx +953 -0
- package/docs/zh/guides/upgrade/entry.mdx +463 -0
- package/docs/zh/guides/upgrade/other.md +190 -0
- package/docs/zh/guides/upgrade/overview.mdx +36 -0
- package/docs/zh/guides/upgrade/tailwindcss.mdx +92 -0
- package/docs/zh/guides/upgrade/web-server.md +111 -0
- package/docs/zh/index.md +4 -0
- package/docs/zh/plugin/_meta.json +25 -0
- package/docs/zh/plugin/cli-plugins/_meta.json +1 -0
- package/docs/zh/plugin/cli-plugins/api.mdx +569 -0
- package/docs/zh/plugin/cli-plugins/life-cycle.mdx +135 -0
- package/docs/zh/plugin/introduction.mdx +153 -0
- package/docs/zh/plugin/official/_meta.json +7 -0
- package/docs/zh/plugin/official/cli-plugins/_meta.json +1 -0
- package/docs/zh/plugin/official/cli-plugins/plugin-bff.mdx +5 -0
- package/docs/zh/plugin/official/cli-plugins/plugin-ssg.mdx +5 -0
- package/docs/zh/plugin/official/cli-plugins/plugin-styled-components.mdx +5 -0
- package/docs/zh/plugin/official/cli-plugins.mdx +4 -0
- package/docs/zh/plugin/plugin-system.mdx +231 -0
- package/docs/zh/plugin/runtime-plugins/_meta.json +1 -0
- package/docs/zh/plugin/runtime-plugins/api.mdx +193 -0
- package/docs/zh/plugin/runtime-plugins/life-cycle.mdx +29 -0
- package/docs/zh/plugin/server-plugins/_meta.json +1 -0
- package/docs/zh/plugin/server-plugins/api.mdx +212 -0
- package/docs/zh/plugin/server-plugins/life-cycle.mdx +43 -0
- package/docs/zh/tutorials/_meta.json +7 -0
- package/docs/zh/tutorials/examples/csr-auth.mdx +31 -0
- package/docs/zh/tutorials/foundations/introduction.mdx +22 -0
- package/i18n.json +142 -0
- package/main-doc/docs/en/guides/get-started/ultramodern.mdx +320 -0
- package/main-doc/docs/zh/guides/get-started/ultramodern.mdx +304 -0
- package/package.json +52 -0
- package/rspress.config.ts +153 -0
- package/src/components/ContentCard/index.module.scss +65 -0
- package/src/components/ContentCard/index.tsx +24 -0
- package/src/components/FeatureLayout/index.module.css +8 -0
- package/src/components/FeatureLayout/index.tsx +8 -0
- package/src/components/Footer/index.tsx +118 -0
- package/src/components/Footer/styles.module.scss +49 -0
- package/src/components/FrameworkCode/index.tsx +605 -0
- package/src/components/ListCard/index.module.css +57 -0
- package/src/components/ListCard/index.tsx +26 -0
- package/src/components/Mermaid/index.tsx +64 -0
- package/src/components/Mermaid/style.scss +221 -0
- package/src/components/RandomMemberList/index.module.scss +35 -0
- package/src/components/RandomMemberList/index.tsx +122 -0
- package/src/components/RsbuildLink/index.tsx +19 -0
- package/src/components/Sandpack/index.css +10 -0
- package/src/components/Sandpack/index.tsx +22 -0
- package/src/components/SecondaryTitle/index.module.css +14 -0
- package/src/components/SecondaryTitle/index.tsx +15 -0
- package/src/components/ShowcaseList/index.module.scss +80 -0
- package/src/components/ShowcaseList/index.tsx +39 -0
- package/src/components/ShowcaseList/useShowcases.ts +101 -0
- package/src/components/SolutionCards/index.module.scss +73 -0
- package/src/components/SolutionCards/index.tsx +30 -0
- package/src/custom.scss +15 -0
- package/src/global.d.ts +28 -0
- package/src/i18n/enUS.ts +54 -0
- package/src/i18n/index.ts +18 -0
- package/src/i18n/zhCN.ts +54 -0
- package/src/index.ts +5 -0
- package/src/pages/index.module.scss +349 -0
- package/src/pages/index.tsx +133 -0
- package/src/sandbox/csr-auth/src/routes/Auth-tsx.txt +74 -0
- package/src/sandbox/csr-auth/src/routes/fakeAuth-ts.txt +16 -0
- package/src/sandbox/csr-auth/src/routes/layout-tsx.txt +21 -0
- package/src/sandbox/csr-auth/src/routes/login/page-tsx.txt +40 -0
- package/src/sandbox/csr-auth/src/routes/page-tsx.txt +17 -0
- package/src/sandbox/csr-auth/src/routes/protected/page-tsx.txt +11 -0
- package/static/img/favicon.ico +0 -0
- package/static/img/features/ai.svg +1 -0
- package/static/img/features/api.svg +1 -0
- package/static/img/features/app.svg +1 -0
- package/static/img/features/blocks.svg +1 -0
- package/static/img/features/browser.svg +12 -0
- package/static/img/features/cloud.svg +1 -0
- package/static/img/features/coding-backend.svg +1 -0
- package/static/img/features/compiler.svg +1 -0
- package/static/img/features/css-file.svg +1 -0
- package/static/img/features/customize.svg +1 -0
- package/static/img/features/developer.svg +1 -0
- package/static/img/features/dynamic.svg +1 -0
- package/static/img/features/editor.svg +1 -0
- package/static/img/features/framework-config.svg +1 -0
- package/static/img/features/framework.svg +1 -0
- package/static/img/features/frameworks.svg +1 -0
- package/static/img/features/html.svg +1 -0
- package/static/img/features/icon2.svg +1 -0
- package/static/img/features/javascript.svg +1 -0
- package/static/img/features/monorepo.svg +1 -0
- package/static/img/features/product.svg +1 -0
- package/static/img/features/server-network.svg +1 -0
- package/static/img/features/serverless.svg +1 -0
- package/static/img/features/test.svg +1 -0
- package/static/img/features/trinity.svg +1 -0
- package/static/img/features/unity.svg +1 -0
- package/static/img/features/url.svg +1 -0
- package/static/img/features/visual.svg +1 -0
- package/static/img/features/web-server.svg +1 -0
|
@@ -0,0 +1,569 @@
|
|
|
1
|
+
# 插件 API
|
|
2
|
+
|
|
3
|
+
Modern.js 的 CLI 插件允许您在 Modern.js 项目的构建和开发过程中扩展和定制功能。
|
|
4
|
+
|
|
5
|
+
:::info
|
|
6
|
+
|
|
7
|
+
CLI 插件需要通过 `modern.config.ts` 中的 [`plugins`](/configure/app/plugins) 字段配置。
|
|
8
|
+
|
|
9
|
+
:::
|
|
10
|
+
|
|
11
|
+
## 插件基础结构
|
|
12
|
+
|
|
13
|
+
一个典型的 CLI 插件结构如下:
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { CliPlugin, AppTools } from '@modern-js/app-tools';
|
|
17
|
+
|
|
18
|
+
const myCliPlugin = (): CliPlugin<AppTools> => ({
|
|
19
|
+
name: '@my-org/my-plugin', // 插件名称,确保唯一性
|
|
20
|
+
setup: api => {
|
|
21
|
+
// 在这里使用 API 注册钩子、添加命令等
|
|
22
|
+
api.onBeforeBuild(() => {
|
|
23
|
+
console.log('构建即将开始...');
|
|
24
|
+
});
|
|
25
|
+
},
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
export default myCliPlugin;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
- `name`: 插件的唯一标识符。
|
|
32
|
+
- `setup` 函数接收一个 `api` 对象,该对象提供了所有可用的 CLI 插件 API。
|
|
33
|
+
|
|
34
|
+
## 信息获取
|
|
35
|
+
|
|
36
|
+
#### `api.getAppContext`
|
|
37
|
+
|
|
38
|
+
获取 Modern.js 应用的上下文信息。
|
|
39
|
+
|
|
40
|
+
- **返回值:** `AppContext` 对象,包含以下字段:
|
|
41
|
+
|
|
42
|
+
| 字段名 | 类型 | 描述 | 何时可用 |
|
|
43
|
+
| ---------------------- | ------------------- | -------------------------------------------------- | --------------------------- |
|
|
44
|
+
| `command` | `string` | 当前执行的命令 (e.g., `dev`, `build`, `deploy`) | - |
|
|
45
|
+
| `port` | `number` | 开发服务器端口号 | `onPrepare` 之后 |
|
|
46
|
+
| `configFile` | `string` | 配置文件的绝对路径 | - |
|
|
47
|
+
| `isProd` | `boolean` | 是否为生产模式 | - |
|
|
48
|
+
| `appDirectory` | `string` | 项目根目录的绝对路径 | - |
|
|
49
|
+
| `srcDirectory` | `string` | 项目源码目录的绝对路径 | - |
|
|
50
|
+
| `distDirectory` | `string` | 项目产物输出目录的绝对路径 | `onPrepare`(及之后) |
|
|
51
|
+
| `sharedDirectory` | `string` | 公共模块目录的绝对路径 | - |
|
|
52
|
+
| `nodeModulesDirectory` | `string` | `node_modules` 目录的绝对路径 | - |
|
|
53
|
+
| `ip` | `string` | 当前机器的 IPv4 地址 | - |
|
|
54
|
+
| `packageName` | `string` | 项目 `package.json` 中的 `name` 字段 | - |
|
|
55
|
+
| `plugins` | `object[]` | 当前已注册的插件列表 | - |
|
|
56
|
+
| `entrypoints` | `object[]` | 页面入口信息 | - |
|
|
57
|
+
| `serverRoutes` | `object[]` | 服务端路由信息 | - |
|
|
58
|
+
| `bundlerType` | `rspack` | 当前使用的打包工具类型 | `onPrepare` 之后 |
|
|
59
|
+
| `metaName` | `string` | 框架内部名称 | - |
|
|
60
|
+
| `apiDirectory` | `string` | API 模块目录的绝对路径 (BFF 使用) | - |
|
|
61
|
+
| `lambdaDirectory` | `string` | Lambda 模块目录的绝对路径 (BFF 使用) | - |
|
|
62
|
+
| `runtimeConfigFile` | `string` | 运行时配置文件的名称 | - |
|
|
63
|
+
| `checkedEntries` | `string[]` | 指定的入口信息 | - |
|
|
64
|
+
| `apiOnly` | `boolean` | 是否为 `apiOnly` 模式 | - |
|
|
65
|
+
|
|
66
|
+
- **示例:**
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
api.onPrepare(() => {
|
|
70
|
+
const appContext = api.getAppContext();
|
|
71
|
+
console.log(`当前项目运行在 ${appContext.isProd ? '生产' : '开发'} 模式`);
|
|
72
|
+
console.log(`打包工具: ${appContext.bundlerType}`);
|
|
73
|
+
});
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
:::info
|
|
77
|
+
`getAppContext` 返回的上下文信息是只读的,无法直接进行修改。
|
|
78
|
+
:::
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
#### `api.getConfig`
|
|
83
|
+
|
|
84
|
+
获取用户在 `modern.config.ts` 文件中定义的配置。
|
|
85
|
+
|
|
86
|
+
- **返回值:** 用户定义的配置对象。
|
|
87
|
+
- **示例:**
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
api.onPrepare(() => {
|
|
91
|
+
const userConfig = api.getConfig();
|
|
92
|
+
if (userConfig.output) {
|
|
93
|
+
console.log('用户自定义了 output 配置');
|
|
94
|
+
}
|
|
95
|
+
});
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
#### `api.getNormalizedConfig`
|
|
101
|
+
|
|
102
|
+
获取经过 Modern.js 内部处理和插件修改后的最终配置(归一化配置)。
|
|
103
|
+
|
|
104
|
+
- **返回值:** 归一化后的配置对象。
|
|
105
|
+
- **何时可用:** 必须在 `onPrepare`(及之后的 hook,例如 `onBeforeBuild`)中使用。
|
|
106
|
+
- **示例:**
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
api.onPrepare(() => {
|
|
110
|
+
const finalConfig = api.getNormalizedConfig();
|
|
111
|
+
console.log('最终配置:', finalConfig);
|
|
112
|
+
});
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
#### `api.isPluginExists`
|
|
118
|
+
|
|
119
|
+
检查指定的插件是否已注册。
|
|
120
|
+
|
|
121
|
+
- **参数:**
|
|
122
|
+
- `pluginName: string`: 要检查的插件名称。
|
|
123
|
+
- **返回值:** `boolean` 值,表示插件是否存在。
|
|
124
|
+
- **示例:**
|
|
125
|
+
|
|
126
|
+
```typescript
|
|
127
|
+
if (api.isPluginExists('@modern-js/plugin-bff')) {
|
|
128
|
+
console.log('BFF 插件已启用');
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
#### `api.getHooks`
|
|
135
|
+
|
|
136
|
+
获取所有已注册的钩子函数。
|
|
137
|
+
|
|
138
|
+
- **返回值:** 包含所有钩子函数的对象。
|
|
139
|
+
- **示例:**
|
|
140
|
+
|
|
141
|
+
```typescript
|
|
142
|
+
const hooks = api.getHooks();
|
|
143
|
+
// 手动触发 onPrepare 钩子
|
|
144
|
+
hooks.onPrepare.call();
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
:::warning
|
|
148
|
+
在自定义插件中,只能手动调用对应插件注册的钩子,不能调用官方钩子,以免影响正常应用的执行顺序。
|
|
149
|
+
:::
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 配置修改
|
|
154
|
+
|
|
155
|
+
#### `api.config`
|
|
156
|
+
|
|
157
|
+
修改 Modern.js 的初始配置。
|
|
158
|
+
|
|
159
|
+
- **类型:** `api.config(configFn: () => UserConfig | Promise<UserConfig>)`
|
|
160
|
+
- **参数:**
|
|
161
|
+
- `configFn`: 一个返回配置对象或 Promise 的函数。
|
|
162
|
+
- **执行阶段:** 解析完 `modern.config.ts` 中的配置之后。
|
|
163
|
+
- **示例:**
|
|
164
|
+
|
|
165
|
+
```typescript
|
|
166
|
+
api.config(() => {
|
|
167
|
+
return {
|
|
168
|
+
output: {
|
|
169
|
+
disableTsChecker: true, // 关闭 TypeScript 类型检查
|
|
170
|
+
},
|
|
171
|
+
};
|
|
172
|
+
});
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
**配置合并优先级**(从高到低):
|
|
176
|
+
|
|
177
|
+
1. 用户在 `modern.config.*` 文件中定义的配置。
|
|
178
|
+
2. 插件通过 `api.config()` 注册的配置。
|
|
179
|
+
3. Modern.js 默认配置。
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
#### `api.modifyBundlerChain`
|
|
184
|
+
|
|
185
|
+
使用 chain API 修改 Rspack 配置。
|
|
186
|
+
|
|
187
|
+
- **类型:** `api.modifyBundlerChain(modifyFn: (chain: RspackChain, utils: RspackUtils) => void | Promise<void>)`
|
|
188
|
+
- **参数:**
|
|
189
|
+
- `modifyFn`: 修改函数,接收 `RspackChain` 实例和实用工具作为参数。
|
|
190
|
+
- **执行阶段:** 在生成最终的 Rspack 配置时。
|
|
191
|
+
- **对应 Rsbuild Hook**: [modifybundlerchain](https://v2.rsbuild.rs/zh/plugins/dev/hooks#modifybundlerchain)
|
|
192
|
+
- **示例:**
|
|
193
|
+
|
|
194
|
+
```typescript
|
|
195
|
+
api.modifyBundlerChain((chain, utils) => {
|
|
196
|
+
if (utils.env === 'development') {
|
|
197
|
+
chain.devtool('eval');
|
|
198
|
+
}
|
|
199
|
+
chain.plugin('bundle-analyze').use(BundleAnalyzerPlugin);
|
|
200
|
+
});
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
#### `api.modifyRsbuildConfig`
|
|
204
|
+
|
|
205
|
+
修改 Rsbuild 的配置。
|
|
206
|
+
|
|
207
|
+
- **类型:** `api.modifyRsbuildConfig(modifyFn: (config: RsbuildConfig, utils: RsbuildUtils) => RsbuildConfig | Promise<RsbuildConfig> | void)`
|
|
208
|
+
- **参数:**
|
|
209
|
+
- `modifyFn`: 修改函数,接收 Rsbuild 配置对象和实用工具作为参数,可以返回修改后的配置对象、Promise 或不返回(直接修改原对象)。
|
|
210
|
+
- **执行阶段:** 在生成最终的 Rsbuild 配置时。
|
|
211
|
+
- **对应 Rsbuild Hook**: [modifyRsbuildConfig](https://v2.rsbuild.rs/zh/plugins/dev/hooks#modifyrsbuildconfig)
|
|
212
|
+
- **示例:**
|
|
213
|
+
|
|
214
|
+
```typescript
|
|
215
|
+
api.modifyRsbuildConfig((config, utils) => {
|
|
216
|
+
// 添加一个自定义的 Rsbuild 插件
|
|
217
|
+
config.plugins.push(myCustomRsbuildPlugin());
|
|
218
|
+
});
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
#### `api.modifyRspackConfig`
|
|
224
|
+
|
|
225
|
+
修改 Rspack 的配置。(当使用 Rspack 作为打包工具时)
|
|
226
|
+
|
|
227
|
+
- **类型:** `api.modifyRspackConfig(modifyFn: (config: RspackConfig, utils: RspackUtils) => RspackConfig | Promise<RspackConfig> | void)`
|
|
228
|
+
- **参数:**
|
|
229
|
+
- `modifyFn`: 修改函数,接收 Rspack 配置对象和实用工具作为参数,可以返回修改后的配置对象、Promise 或不返回(直接修改原对象)。
|
|
230
|
+
- **执行阶段:** 在生成最终的 Rspack 配置时。
|
|
231
|
+
- **对应 Rsbuild Hook**: [modifyRspackConfig](https://v2.rsbuild.rs/zh/plugins/dev/hooks#modifyrspackconfig)
|
|
232
|
+
- **示例:**
|
|
233
|
+
|
|
234
|
+
```typescript
|
|
235
|
+
api.modifyRspackConfig((config, utils) => {
|
|
236
|
+
config.builtins.minify = {
|
|
237
|
+
enable: true,
|
|
238
|
+
implementation: utils.rspack.SwcJsMinimizerRspackPlugin,
|
|
239
|
+
}
|
|
240
|
+
});
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
**构建配置修改顺序**
|
|
246
|
+
|
|
247
|
+
```
|
|
248
|
+
modifyRsbuildConfig
|
|
249
|
+
modifyBundlerChain
|
|
250
|
+
tools.bundlerChain
|
|
251
|
+
modifyRspackConfig
|
|
252
|
+
tools.rspack
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
#### `api.modifyServerRoutes`
|
|
258
|
+
|
|
259
|
+
修改服务器路由配置。
|
|
260
|
+
|
|
261
|
+
- **类型** `api.modifyServerRoutes(transformFn: (routes: ServerRoute[]) => ServerRoute[])`
|
|
262
|
+
- **参数:**
|
|
263
|
+
- `transformFn`: 转换函数,接收当前服务器路由数组作为参数,返回修改后的数组。
|
|
264
|
+
- **执行阶段:** 在生成服务器路由文件之前 ( `prepare` 阶段)。
|
|
265
|
+
- **示例:**
|
|
266
|
+
|
|
267
|
+
```typescript
|
|
268
|
+
api.modifyServerRoutes(routes => {
|
|
269
|
+
// 添加一个新的 API 路由
|
|
270
|
+
routes.push({
|
|
271
|
+
urlPath: '/api',
|
|
272
|
+
isApi: true,
|
|
273
|
+
entryPath: '',
|
|
274
|
+
isSPA: false,
|
|
275
|
+
isSSR: false,
|
|
276
|
+
});
|
|
277
|
+
return routes;
|
|
278
|
+
});
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
#### `api.modifyHtmlPartials`
|
|
284
|
+
|
|
285
|
+
修改 HTML 模板片段。
|
|
286
|
+
|
|
287
|
+
- **类型** `api.modifyHtmlPartials(modifyFn: (partials: HtmlPartials, entrypoint: Entrypoint) => void)`
|
|
288
|
+
- **参数:**
|
|
289
|
+
- `modifyFn`: 修改函数,接收 HTML 模板片段对象和当前入口点信息作为参数。
|
|
290
|
+
- `partials`: 包含 `top`, `head`, `body` 三个部分,每个部分都有`append`, `prepend`, `replace`三个方法。
|
|
291
|
+
- **执行阶段:** 在生成 HTML 文件之前 ( `prepare` 阶段)。
|
|
292
|
+
- **示例:**
|
|
293
|
+
|
|
294
|
+
```typescript
|
|
295
|
+
api.modifyHtmlPartials(({ entrypoint, partials }) => {
|
|
296
|
+
// 在所有页面的 <head> 标签中添加一个 meta 标签
|
|
297
|
+
if (partials.head && partials.head.append) {
|
|
298
|
+
partials.head.append(`<meta name="my-custom-meta" content="value">`);
|
|
299
|
+
}
|
|
300
|
+
});
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
:::warning
|
|
304
|
+
当使用[完全自定义模板](/guides/basic-features/html.html#完全自定义-html-模板)时,该钩子函数将不会执行。
|
|
305
|
+
:::
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## 构建流程控制
|
|
310
|
+
|
|
311
|
+
#### `api.onPrepare`
|
|
312
|
+
|
|
313
|
+
在 Modern.js 准备阶段添加额外的逻辑。
|
|
314
|
+
|
|
315
|
+
- **类型** `api.onPrepare(prepareFn: () => void | Promise<void>)`
|
|
316
|
+
- **参数:**
|
|
317
|
+
- `prepareFn`: 准备函数,无参数,可异步。
|
|
318
|
+
- **执行阶段:** 在 Modern.js 完成配置校验之后。
|
|
319
|
+
- **示例:**
|
|
320
|
+
|
|
321
|
+
```typescript
|
|
322
|
+
api.onPrepare(async () => {
|
|
323
|
+
// 执行一些初始化操作,例如检查环境、下载依赖等
|
|
324
|
+
await prepareMyCustomEnvironment();
|
|
325
|
+
});
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
---
|
|
329
|
+
|
|
330
|
+
#### `api.addCommand`
|
|
331
|
+
|
|
332
|
+
添加自定义的 CLI 命令。
|
|
333
|
+
|
|
334
|
+
- **类型** `api.addCommand(commandFn: ({ program: Command }) => void)`
|
|
335
|
+
- **参数:**
|
|
336
|
+
- `commandFn`: 接收 `commander` 的 `program` 对象作为参数,用于定义新的命令。
|
|
337
|
+
- **执行阶段:** `prepare` 钩子运行完成后。
|
|
338
|
+
- **示例:**
|
|
339
|
+
|
|
340
|
+
```typescript
|
|
341
|
+
api.addCommand(({ program }) => {
|
|
342
|
+
program
|
|
343
|
+
.command('my-command')
|
|
344
|
+
.description('我的自定义命令')
|
|
345
|
+
.action(async () => {
|
|
346
|
+
// 执行命令逻辑
|
|
347
|
+
console.log('执行自定义命令...');
|
|
348
|
+
});
|
|
349
|
+
});
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
---
|
|
353
|
+
|
|
354
|
+
#### `api.addWatchFiles`
|
|
355
|
+
|
|
356
|
+
添加额外的文件监听列表(用于开发模式)。
|
|
357
|
+
|
|
358
|
+
- **类型** `api.addWatchFiles(watchFn: () => string[] | { files: string[]; isPrivate: boolean; })`
|
|
359
|
+
- **参数:**
|
|
360
|
+
- `watchFn`: 返回一个包含文件路径的数组,或一个包含 `files` 和 `isPrivate` 属性的对象。
|
|
361
|
+
- `files`: 要监听的文件路径数组。
|
|
362
|
+
- `isPrivate`: 是否为框架内部文件(影响文件变更时的行为)。
|
|
363
|
+
- **执行阶段:** `addCommand` 钩子运行完成之后。
|
|
364
|
+
- **示例:**
|
|
365
|
+
|
|
366
|
+
```typescript
|
|
367
|
+
api.addWatchFiles(() => {
|
|
368
|
+
// 监听项目根目录下的 .env 文件
|
|
369
|
+
return [path.resolve(api.getAppContext().appDirectory, '.env')];
|
|
370
|
+
});
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
---
|
|
374
|
+
|
|
375
|
+
#### `api.onFileChanged`
|
|
376
|
+
|
|
377
|
+
在监听文件发生变化时添加额外的逻辑(用于开发模式)。
|
|
378
|
+
|
|
379
|
+
- **类型** `api.onFileChanged(changeFn: (params: { filename: string; eventType: 'add' | 'change' | 'unlink'; isPrivate: boolean; }) => void)`
|
|
380
|
+
- **参数:**
|
|
381
|
+
- `changeFn`: 文件变化处理函数,接收以下参数:
|
|
382
|
+
- `filename`: 发生变化的文件路径。
|
|
383
|
+
- `eventType`: 变化类型 (`add`, `change`, `unlink`)。
|
|
384
|
+
- `isPrivate`: 是否为框架内部文件。
|
|
385
|
+
- **执行阶段:** 监听文件变化之后。
|
|
386
|
+
- **示例:**
|
|
387
|
+
|
|
388
|
+
```typescript
|
|
389
|
+
api.onFileChanged(({ filename, eventType }) => {
|
|
390
|
+
if (eventType === 'change' && filename.endsWith('.ts')) {
|
|
391
|
+
console.log('TypeScript 文件发生变化,可能需要重新编译...');
|
|
392
|
+
}
|
|
393
|
+
});
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
---
|
|
397
|
+
|
|
398
|
+
#### `api.onBeforeBuild`
|
|
399
|
+
|
|
400
|
+
在构建开始之前添加额外的逻辑。
|
|
401
|
+
|
|
402
|
+
- **类型** `api.onBeforeBuild(buildFn: () => void | Promise<void>)`
|
|
403
|
+
- **参数:**
|
|
404
|
+
- `buildFn`: 构建前执行的函数,无参数,可异步。
|
|
405
|
+
- **执行阶段:** 在执行构建流程之前。
|
|
406
|
+
- **对应 Rsbuild Hook**: [onBeforeBuild](https://v2.rsbuild.rs/zh/plugins/dev/hooks#onbeforebuild)
|
|
407
|
+
- **示例:**
|
|
408
|
+
|
|
409
|
+
```typescript
|
|
410
|
+
api.onBeforeBuild(() => {
|
|
411
|
+
// 构建前做一些环境检查
|
|
412
|
+
});
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
#### `api.onAfterBuild`
|
|
418
|
+
|
|
419
|
+
在构建完成后添加额外的逻辑。
|
|
420
|
+
|
|
421
|
+
- **类型:** `api.onAfterBuild(buildFn: () => void | Promise<void>)`
|
|
422
|
+
- **参数:**
|
|
423
|
+
- `buildFn`: 构建后执行的函数,无参数,可异步。
|
|
424
|
+
- **执行阶段:** 在执行构建流程之后。
|
|
425
|
+
- **对应 Rsbuild Hook**: [onAfterBuild](https://v2.rsbuild.rs/zh/plugins/dev/hooks#onafterbuild)
|
|
426
|
+
- **示例:**
|
|
427
|
+
|
|
428
|
+
```typescript
|
|
429
|
+
api.onAfterBuild(() => {
|
|
430
|
+
// 构建后上传sourceMap
|
|
431
|
+
});
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
---
|
|
435
|
+
|
|
436
|
+
#### `api.onDevCompileDone`
|
|
437
|
+
|
|
438
|
+
在开发服务器编译完成后添加额外的逻辑。
|
|
439
|
+
|
|
440
|
+
- **类型:** `api.onDevCompileDone(compileFn: () => void | Promise<void>)`
|
|
441
|
+
- **参数:**
|
|
442
|
+
- `compileFn`: 编译完成后执行的函数。
|
|
443
|
+
- **执行阶段:** 开发服务器启动,且首次编译完成后。
|
|
444
|
+
- **对应 Rsbuild Hook**: [onDevCompileDone](https://v2.rsbuild.rs/zh/plugins/dev/hooks#ondevcompiledone)
|
|
445
|
+
- **示例:**
|
|
446
|
+
|
|
447
|
+
```typescript
|
|
448
|
+
api.onDevCompileDone(() => {
|
|
449
|
+
// 首次编译完成,打开浏览器
|
|
450
|
+
});
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
---
|
|
454
|
+
|
|
455
|
+
#### `api.onBeforeCreateCompiler`
|
|
456
|
+
|
|
457
|
+
在创建编译器实例之前添加额外的逻辑。
|
|
458
|
+
|
|
459
|
+
- **类型:** `api.onBeforeCreateCompiler(createFn: () => void | Promise<void>)`
|
|
460
|
+
- **参数:**
|
|
461
|
+
- `createFn`: 创建前执行的函数,无参数,可异步。
|
|
462
|
+
- **执行阶段:** 在创建 Rspack 编译器实例之前。
|
|
463
|
+
- **对应 Rsbuild Hook**: [onBeforeCreateCompiler](https://v2.rsbuild.rs/zh/plugins/dev/hooks#onbeforecreatecompiler)
|
|
464
|
+
- **示例:**
|
|
465
|
+
|
|
466
|
+
```typescript
|
|
467
|
+
api.onBeforeCreateCompiler(() => {
|
|
468
|
+
// 可以获取 compiler 相关配置
|
|
469
|
+
});
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
---
|
|
473
|
+
|
|
474
|
+
#### `api.onAfterCreateCompiler`
|
|
475
|
+
|
|
476
|
+
在创建编译器实例之后添加额外的逻辑。
|
|
477
|
+
|
|
478
|
+
- **类型:** `api.onAfterCreateCompiler(createFn: () => void | Promise<void>)`
|
|
479
|
+
- **参数:**
|
|
480
|
+
- `createFn`: 创建后执行的函数,无参数,可异步。
|
|
481
|
+
- **执行阶段:** 在创建 Rspack 编译器实例之后。
|
|
482
|
+
- **对应 Rsbuild Hook**: [onAfterCreateCompiler](https://v2.rsbuild.rs/zh/plugins/dev/hooks#onaftercreatecompiler)
|
|
483
|
+
- **示例:**
|
|
484
|
+
|
|
485
|
+
```typescript
|
|
486
|
+
api.onAfterCreateCompiler(() => {
|
|
487
|
+
// 可以获取 compiler 实例
|
|
488
|
+
});
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
---
|
|
492
|
+
|
|
493
|
+
#### `api.onBeforeDev`
|
|
494
|
+
|
|
495
|
+
在开发服务器启动前添加额外的逻辑。
|
|
496
|
+
|
|
497
|
+
- **类型:** `api.onBeforeDev(devFn: () => void | Promise<void>)`
|
|
498
|
+
- **参数:**
|
|
499
|
+
- `devFn`: 开发服务器启动前执行的函数,无参数,可异步。
|
|
500
|
+
- **执行阶段:** 在执行 `dev` 命令启动开发服务器之前。
|
|
501
|
+
- **示例:**
|
|
502
|
+
|
|
503
|
+
```typescript
|
|
504
|
+
api.onBeforeDev(async () => {
|
|
505
|
+
// 检查端口是否被占用
|
|
506
|
+
await checkPortAvailability(3000);
|
|
507
|
+
});
|
|
508
|
+
```
|
|
509
|
+
|
|
510
|
+
---
|
|
511
|
+
|
|
512
|
+
#### `api.onAfterDev`
|
|
513
|
+
|
|
514
|
+
在开发服务器启动后添加额外的逻辑。
|
|
515
|
+
|
|
516
|
+
- **类型:** `api.onAfterDev(devFn: () => void | Promise<void>)`
|
|
517
|
+
- **参数:**
|
|
518
|
+
- `devFn`: 开发服务器启动后执行的函数。
|
|
519
|
+
- **执行阶段:** 开发服务器成功启动后。
|
|
520
|
+
- **对应 Rsbuild Hook**: [onAfterStartDevServer](https://v2.rsbuild.rs/zh/plugins/dev/hooks#onafterstartdevserver)
|
|
521
|
+
- **示例:**
|
|
522
|
+
|
|
523
|
+
```typescript
|
|
524
|
+
api.onAfterDev(() => {
|
|
525
|
+
// 上报 dev 相关信息
|
|
526
|
+
});
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
---
|
|
530
|
+
|
|
531
|
+
#### `api.onBeforeExit`
|
|
532
|
+
|
|
533
|
+
在进程退出前添加额外的逻辑。
|
|
534
|
+
|
|
535
|
+
- **类型:** `api.onBeforeExit(exitFn: () => void | Promise<void>)`
|
|
536
|
+
- **参数:**
|
|
537
|
+
- `exitFn`: 进程退出前执行的函数,无参数,可异步。
|
|
538
|
+
- **执行阶段:** 在 Modern.js 进程即将退出时(例如,用户按下 Ctrl+C)。
|
|
539
|
+
- **示例:**
|
|
540
|
+
|
|
541
|
+
```typescript
|
|
542
|
+
api.onBeforeExit(async () => {
|
|
543
|
+
// 执行一些清理操作,例如关闭数据库连接、删除临时文件等
|
|
544
|
+
await cleanupMyResources();
|
|
545
|
+
});
|
|
546
|
+
```
|
|
547
|
+
|
|
548
|
+
---
|
|
549
|
+
|
|
550
|
+
#### `api.onBeforePrintInstructions`
|
|
551
|
+
|
|
552
|
+
在打印成功信息前添加额外的逻辑。
|
|
553
|
+
|
|
554
|
+
- **类型:** `api.onBeforePrintInstructions(printFn: ({instructions: string}) => {instructions: string} | Promise<{instructions: string}>)`
|
|
555
|
+
- **参数:**
|
|
556
|
+
- `printFn`: 修改打印信息的函数, 返回修改后的信息。
|
|
557
|
+
- **执行阶段:** 打印成功信息前。
|
|
558
|
+
- **示例:**
|
|
559
|
+
|
|
560
|
+
```typescript
|
|
561
|
+
api.onBeforePrintInstructions(({ instructions }) => {
|
|
562
|
+
// do something
|
|
563
|
+
return { instructions };
|
|
564
|
+
});
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
## 其他说明
|
|
568
|
+
|
|
569
|
+
- 可以参考 [CLI 插件生命周期](./life-cycle.mdx) 了解插件钩子的执行顺序。
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# 生命周期
|
|
2
|
+
|
|
3
|
+
import Mermaid from '@site/src/components/Mermaid';
|
|
4
|
+
|
|
5
|
+
<Mermaid>
|
|
6
|
+
{`
|
|
7
|
+
flowchart TD
|
|
8
|
+
init{{"CLI 初始化"}}
|
|
9
|
+
env(初始化环境变量)
|
|
10
|
+
load_config(加载用户配置文件)
|
|
11
|
+
cli_plugin(加载 CLI 插件)
|
|
12
|
+
registry_hooks(注册 Hooks 函数<br><sub>执行插件 setup 函数,注册插件中定义的 Hook, 插件 setup 中逻辑也会在这里执行</sub>)
|
|
13
|
+
|
|
14
|
+
app_tools{{"app-tools"}}
|
|
15
|
+
|
|
16
|
+
config(config)
|
|
17
|
+
onPrepare(onPrepare)
|
|
18
|
+
addCommand(addCommand)
|
|
19
|
+
addWatchFiles(addWatchFiles)
|
|
20
|
+
onFileChanged(onFileChanged)
|
|
21
|
+
onBeforeExit(onBeforeExit<br><sub>SIGINT, SIGTERM, unhandledRejection, uncaughtException 事件触发</sub>)
|
|
22
|
+
|
|
23
|
+
onBeforeDev(onBeforeDev)
|
|
24
|
+
onBeforeRestart(onBeforeRestart<br><sub>修改的文件需要重启服务时触发</sub>)
|
|
25
|
+
onBeforeBuild(onBeforeBuild<br><sub>在独立 BFF 项目时触发</sub>)
|
|
26
|
+
onAfterBuild(onAfterBuild<br><sub>在独立 BFF 项目时触发</sub>)
|
|
27
|
+
modifyServerRoutes(modifyServerRoutes)
|
|
28
|
+
modifyHtmlPartials(modifyHtmlPartials)
|
|
29
|
+
|
|
30
|
+
onPrepare_fork(onPrepare)
|
|
31
|
+
addCommand_fork(addCommand)
|
|
32
|
+
onFileChanged_fork(onFileChanged)
|
|
33
|
+
|
|
34
|
+
registry_rsbuild_hooks(注册 rsbuild Hooks<br><sub>这里只是注册 rsbuild 的 Hook,具体的执行时机是由 rsbuild 的插件机制决定的</sub>)
|
|
35
|
+
|
|
36
|
+
modifyBundlerChain(modifyBundlerChain)
|
|
37
|
+
modifyRsbuildConfig(modifyRsbuildConfig)
|
|
38
|
+
modifyRspackConfig(modifyRspackConfig)
|
|
39
|
+
|
|
40
|
+
onBeforeBuild_rsbuild(onBeforeBuild)
|
|
41
|
+
onAfterBuild_rsbuild(onAfterBuild)
|
|
42
|
+
onDevCompileDone(onDevCompileDone)
|
|
43
|
+
onBeforeCreateCompiler(onBeforeCreateCompiler)
|
|
44
|
+
onAfterCreateCompiler(onAfterCreateCompiler)
|
|
45
|
+
onAfterDev(onAfterDev<br><sub>对应 rsbuild 的 onAfterStartDevServer Hook</sub>)
|
|
46
|
+
|
|
47
|
+
dev[/dev/]
|
|
48
|
+
build[/build/]
|
|
49
|
+
extra_command[/.../]
|
|
50
|
+
|
|
51
|
+
dev_fork[/dev/]
|
|
52
|
+
build_fork[/build/]
|
|
53
|
+
serve[/serve/]
|
|
54
|
+
deploy[/deploy/]
|
|
55
|
+
inspect[/inspect/]
|
|
56
|
+
upgrade[/upgrade/]
|
|
57
|
+
|
|
58
|
+
onPrepare_fork --> modifyServerRoutes
|
|
59
|
+
modifyServerRoutes --> modifyHtmlPartials
|
|
60
|
+
modifyHtmlPartials --> registry_rsbuild_hooks
|
|
61
|
+
registry_rsbuild_hooks --> modifyBundlerChain
|
|
62
|
+
modifyBundlerChain --> modifyRsbuildConfig
|
|
63
|
+
modifyRsbuildConfig --> modifyRspackConfig
|
|
64
|
+
registry_rsbuild_hooks --> onBeforeBuild_rsbuild
|
|
65
|
+
onBeforeBuild_rsbuild --> onAfterBuild_rsbuild
|
|
66
|
+
onAfterBuild_rsbuild --> onDevCompileDone
|
|
67
|
+
onDevCompileDone --> onBeforeCreateCompiler
|
|
68
|
+
onBeforeCreateCompiler --> onAfterCreateCompiler
|
|
69
|
+
onAfterCreateCompiler --> onAfterDev
|
|
70
|
+
|
|
71
|
+
dev_fork --> onBeforeDev
|
|
72
|
+
onBeforeDev --> onFileChanged_fork
|
|
73
|
+
onFileChanged_fork --> onBeforeRestart
|
|
74
|
+
|
|
75
|
+
build_fork --> onBeforeBuild
|
|
76
|
+
onBeforeBuild --> onAfterBuild
|
|
77
|
+
|
|
78
|
+
app_tools --- spacer5[ ] --- spacer6[ ] --- spacer7[ ] --- spacer8[ ] --- spacer9[ ] --> onPrepare_fork
|
|
79
|
+
onPrepare_fork --> addCommand_fork
|
|
80
|
+
addCommand_fork --> dev_fork
|
|
81
|
+
addCommand_fork --> build_fork
|
|
82
|
+
addCommand_fork --> serve
|
|
83
|
+
addCommand_fork --> deploy
|
|
84
|
+
addCommand_fork --> inspect
|
|
85
|
+
addCommand_fork --> upgrade
|
|
86
|
+
|
|
87
|
+
init --> env
|
|
88
|
+
env --> load_config
|
|
89
|
+
load_config --> cli_plugin
|
|
90
|
+
cli_plugin --> registry_hooks
|
|
91
|
+
|
|
92
|
+
registry_hooks --> config
|
|
93
|
+
config --> onPrepare
|
|
94
|
+
onPrepare --> addCommand
|
|
95
|
+
|
|
96
|
+
addCommand --> dev
|
|
97
|
+
addCommand --> build
|
|
98
|
+
addCommand --> extra_command
|
|
99
|
+
|
|
100
|
+
dev --> addWatchFiles
|
|
101
|
+
addWatchFiles --> onFileChanged
|
|
102
|
+
|
|
103
|
+
onFileChanged --> onBeforeExit
|
|
104
|
+
build --- spacer[ ] --- spacer2[ ] --> onBeforeExit
|
|
105
|
+
extra_command --- spacer3[ ] --- spacer4[ ] --> onBeforeExit
|
|
106
|
+
|
|
107
|
+
style init fill:#FDE68A;
|
|
108
|
+
style app_tools fill:#FDE68A;
|
|
109
|
+
style env stroke-dasharray:5 5,fill:#86EFAC;
|
|
110
|
+
style registry_rsbuild_hooks stroke-dasharray:5 5,fill:#9CA3AF;
|
|
111
|
+
style load_config stroke-dasharray:5 5,fill:#86EFAC;
|
|
112
|
+
style cli_plugin stroke-dasharray:5 5,fill:#86EFAC;
|
|
113
|
+
style registry_hooks stroke-dasharray:5 5,fill:#9CA3AF;
|
|
114
|
+
|
|
115
|
+
style dev fill:#7DD3FC;
|
|
116
|
+
style build fill:#7DD3FC;
|
|
117
|
+
style extra_command fill:#7DD3FC;
|
|
118
|
+
style dev_fork fill:#7DD3FC;
|
|
119
|
+
style build_fork fill:#7DD3FC;
|
|
120
|
+
style serve fill:#7DD3FC;
|
|
121
|
+
style upgrade fill:#7DD3FC;
|
|
122
|
+
style deploy fill:#7DD3FC;
|
|
123
|
+
style inspect fill:#7DD3FC;
|
|
124
|
+
|
|
125
|
+
style spacer fill:none,stroke:none,height:0px;
|
|
126
|
+
style spacer2 fill:none,stroke:none,height:0px;
|
|
127
|
+
style spacer3 fill:none,stroke:none,height:0px;
|
|
128
|
+
style spacer4 fill:none,stroke:none,height:0px;
|
|
129
|
+
style spacer5 fill:none,stroke:none,height:0px;
|
|
130
|
+
style spacer6 fill:none,stroke:none,height:0px;
|
|
131
|
+
style spacer7 fill:none,stroke:none,height:0px;
|
|
132
|
+
style spacer8 fill:none,stroke:none,height:0px;
|
|
133
|
+
style spacer9 fill:none,stroke:none,height:0px;
|
|
134
|
+
`}
|
|
135
|
+
</Mermaid>
|