@modern-js/app-tools 3.9.3 → 3.10.0

package/docs/apis/app/runtime/core/runtime-context.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # RuntimeContext
 
 `RuntimeContext` is a React Context used to get Runtime context information in components. This Context can be accessed through React's `use` or `useContext` API.
@@ -16,7 +18,7 @@ import { RuntimeContext } from '@modern-js/runtime';
 
 export function App() {
   const runtimeContext = use(RuntimeContext); // You can also use useContext(RuntimeContext)
-  return <div>Hello World</div>
+  return <div>Hello World</div>;
 }
 ```
 
@@ -50,21 +52,21 @@ type TRuntimeContext = {
 ```ts
 type RequestContext = {
   request: {
-    params: Record<string, string>;      // Route parameters
-    pathname: string;                     // Pathname
-    query: Record<string, string>;        // Query parameters
-    headers: IncomingHttpHeaders;         // Request headers
-    host: string;                         // Hostname
-    url: string;                          // Full URL
-    referer?: string;                     // Referrer page
-    userAgent?: string;                   // User agent
-    cookie?: string;                      // Cookie string
-    cookieMap?: Record<string, string>;   // Cookie map object
+    params: Record<string, string>; // Route parameters
+    pathname: string; // Pathname
+    query: Record<string, string>; // Query parameters
+    headers: IncomingHttpHeaders; // Request headers
+    host: string; // Hostname
+    url: string; // Full URL
+    referer?: string; // Referrer page
+    userAgent?: string; // User agent
+    cookie?: string; // Cookie string
+    cookieMap?: Record<string, string>; // Cookie map object
   };
   response: {
-    setHeader: (key: string, value: string) => void;  // Set response header (server-side only)
-    status: (code: number) => void;                   // Set status code (server-side only)
-    locals: Record<string, any>;                      // Local data
+    setHeader: (key: string, value: string) => void; // Set response header (server-side only)
+    status: (code: number) => void; // Set status code (server-side only)
+    locals: Record<string, any>; // Local data
   };
 };
 ```
@@ -88,11 +90,11 @@ function App() {
 
   if (isBrowser === true) {
     // Browser-side execution logic
-    console.log('browser render')
+    console.log('browser render');
   } else {
     // Server-side execution logic
     // Note: Functions like logger need to be injected into context through Runtime plugins
-    console.log('server render')
+    console.log('server render');
   }
 }
 ```

package/docs/apis/app/runtime/router/router.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # router
 
 :::info
@@ -131,8 +133,10 @@ export default ErrorBoundary;
 ```ts
 declare function Link(props: LinkProps): React.ReactElement;
 
-interface LinkProps
-  extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
+interface LinkProps extends Omit<
+  React.AnchorHTMLAttributes<HTMLAnchorElement>,
+  'href'
+> {
   replace?: boolean;
   state?: any;
   to: To;
@@ -153,12 +157,13 @@ A `<Link>` is an element that lets the user navigate to another page by clicking
 ```ts
 declare function NavLink(props: NavLinkProps): React.ReactElement;
 
-interface NavLinkProps
-  extends Omit<LinkProps, 'className' | 'style' | 'children'> {
+interface NavLinkProps extends Omit<
+  LinkProps,
+  'className' | 'style' | 'children'
+> {
   caseSensitive?: boolean;
   children?:
-    | React.ReactNode
-    | ((props: { isActive: boolean }) => React.ReactNode);
+    React.ReactNode | ((props: { isActive: boolean }) => React.ReactNode);
   className?: string | ((props: { isActive: boolean }) => string | undefined);
   end?: boolean;
   style?:

package/docs/apis/app/runtime/ssr/no-ssr.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # NoSSR
 
 The content wrapped by NoSSR will not be rendered at the server, nor will it be rendered during the client side hydrate. it will only be rendered immediately after the entire app is rendered.

package/docs/apis/app/runtime/ssr/renderStreaming.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # renderStreaming
 
 Used for `React v18` + `Streaming SSR` to render readable streams, used in conjunction with `createRequestHandler`.

package/docs/apis/app/runtime/ssr/renderString.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # renderString
 
 Used for React String SSR to render strings, used in conjunction with `createRequestHandler`.

package/docs/apis/app/runtime/ssr/requestHandler.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # createRequestHandler
 
 Used to customize the Server-Side Rendering entry to return the `requestHandler`.

package/docs/apis/app/runtime/utility/css-in-js.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # CSS-In-JS API
 
 Use Style Component to write CSS.

package/docs/apis/app/runtime/utility/head.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # Head
 
 Used to add html elements (such as title, meta, script, etc.) to the `<head>` element, supports SSR.

package/docs/apis/app/runtime/utility/loadable.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # loadable
 
 Used to create Loadable component

package/docs/community/blog/2022-0708-updates.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # 2022 年 7 \~ 8 月更新内容
 
 > 发表于 2022.09.05

package/docs/community/blog/2022-0910-updates.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # 2022 年 9 \~ 10 月更新内容
 
 > 发表于 2022.11.01

package/docs/community/blog/overview.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # Overview
 
 Welcome to Modern.js blog!

package/docs/community/blog/v2-release-note.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # Modern.js v2 发布：支持 Rspack 构建
 
 > 发表于 2023.03.16

package/docs/community/blog/v3-release-note.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # Modern.js v3 Release: Focused on web framework, embracing ecosystem development
 
 > Published on 2025.02.06
@@ -63,7 +65,7 @@ In Modern.js 3.0, simply enable RSC in the configuration:
 export default defineConfig({
   server: {
     rsc: true,
-  }
+  },
 });
 ```
 
@@ -151,7 +153,7 @@ import('./module').then(({ value }) => {
 });
 
 // Destructuring in function body
-import('./module').then((mod) => {
+import('./module').then(mod => {
   const { value } = mod;
   console.log(value);
 });
@@ -231,7 +233,10 @@ In practice, we found that some projects need to extend the Web Server — for e
 In Modern.js 3.0, we rebuilt the Web Server using [Hono](https://hono.dev) and officially opened up server middleware and plugin capabilities. Developers can use Hono middleware to meet their needs:
 
 ```ts title="server/modern.server.ts"
-import { defineServerConfig, type MiddlewareHandler } from "@modern-js/server-runtime";
+import {
+  defineServerConfig,
+  type MiddlewareHandler,
+} from '@modern-js/server-runtime';
 
 const timingMiddleware: MiddlewareHandler = async (c, next) => {
   const start = Date.now();
@@ -244,8 +249,8 @@ const htmlMiddleware: MiddlewareHandler = async (c, next) => {
   await next();
   const html = await c.res.text();
   const modified = html.replace(
-    "<head>",
-    '<head><meta name="generator" content="Modern.js">'
+    '<head>',
+    '<head><meta name="generator" content="Modern.js">',
   );
   c.res = c.body(modified, { status: c.res.status, headers: c.res.headers });
 };
@@ -316,13 +321,13 @@ In Modern.js, we recommend using convention-based routing to organize code. Howe
 Therefore, Modern.js 3.0 provides full config-based routing support, which can be used alongside convention-based routing or independently.
 
 ```ts title="src/modern.routes.ts"
-import { defineRoutes } from "@modern-js/runtime/config-routes";
+import { defineRoutes } from '@modern-js/runtime/config-routes';
 
 export default defineRoutes(({ route, layout, page }) => {
   return [
-    route("home.tsx", "/"),
-    route("about.tsx", "about"),
-    route("blog.tsx", "blog/:id"),
+    route('home.tsx', '/'),
+    route('about.tsx', 'about'),
+    route('blog.tsx', 'blog/:id'),
   ];
 });
 ```
@@ -408,19 +413,19 @@ For render cache usage, see the docs: [Render Cache](/guides/basic-features/rend
 The new version provides a `cache` function that offers finer-grained data-level control compared to render cache. When multiple data requests depend on the same data, `cache` can avoid duplicate requests:
 
 ```ts title="server/loader.ts"
-import { cache } from "@modern-js/runtime/cache";
-import { fetchUserData, fetchUserProjects, fetchUserTeam } from "./api";
+import { cache } from '@modern-js/runtime/cache';
+import { fetchUserData, fetchUserProjects, fetchUserTeam } from './api';
 
 // Cache user data to avoid duplicate requests
 const getUser = cache(fetchUserData);
 
 const getProjects = async () => {
-  const user = await getUser("test-user");
+  const user = await getUser('test-user');
   return fetchUserProjects(user.id);
 };
 
 const getTeam = async () => {
-  const user = await getUser("test-user"); // Reuses cache, no duplicate request
+  const user = await getUser('test-user'); // Reuses cache, no duplicate request
   return fetchUserTeam(user.id);
 };
 

package/docs/community/contributing-guide.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # Contributing Guide
 
 Thanks for that you are interested in contributing to Modern.js. Before starting your contribution, please take a moment to read the following guidelines.
@@ -32,13 +34,6 @@ nvm alias default 22
 nvm use 22
 ```
 
-### Install pnpm
-
-```sh
-# Enable pnpm with corepack, only available on Node.js >= `v14.19.0`
-corepack enable
-```
-
 ### Install Dependencies
 
 ```sh
@@ -53,28 +48,6 @@ What this will do:
 
 > A full rebuild of all packages is generally not required after this. If a new feature you are developing requires an updated version of another package, it is usually sufficient to build the changed dependencies.
 
-### Set Git Email
-
-Please make sure you have your email set up in `<https://github.com/settings/emails>`. This will be needed later when you want to submit a pull request.
-
-Check that your git client is already configured the email:
-
-```sh
-git config --list | grep email
-```
-
-Set the email to global config:
-
-```sh
-git config --global user.email "SOME_EMAIL@example.com"
-```
-
-Set the email for local repo:
-
-```sh
-git config user.email "SOME_EMAIL@example.com"
-```
-
 ## Making Changes and Building
 
 Once you have set up the local development environment in your forked repo, we can start development.
@@ -128,7 +101,7 @@ Modern.js uses [Rstest](https://rstest.rs/) for unit tests across the repository
 Before submitting a pull request, it's important to make sure that the changes haven't introduced any regressions or bugs. You can run the unit tests for the project by executing the following command:
 
 ```sh
-pnpm run test
+pnpm run test:ut
 ```
 
 Alternatively, you can run the unit tests of single package using the `--filter` option:
@@ -141,10 +114,11 @@ pnpm run --filter @modern-js/some-package test
 
 In addition to the unit tests, the Modern.js also includes end-to-end (E2E) tests, which checks the functionality of the application as a whole.
 
-You can run the `test:e2e` command to run the E2E tests:
+Run the framework integration tests and Builder E2E tests with the following commands:
 
 ```sh
-pnpm run test:e2e
+pnpm run test:framework
+pnpm run test:builder
 ```
 
 If you need to run a specified test, you can add keywords to filter:
@@ -156,7 +130,7 @@ npx rstest copy-assets
 
 ## Linting
 
-To help maintain consistency and readability of the codebase, we use a ESLint to lint the codes.
+To help maintain consistency and readability across the codebase, we use [Rstack CLI](https://rstack.rs/) for linting and formatting.
 
 You can run the Linter by executing the following command:
 
@@ -164,6 +138,14 @@ You can run the Linter by executing the following command:
 pnpm run lint
 ```
 
+Run the formatter from the repository root:
+
+```sh
+pnpm run format
+```
+
+Append a file or directory path to either command to limit its scope.
+
 ## Benchmarking
 
 You can input `!bench-framework` or `!bench-module` in the comment area of ​​the PR to do benchmarking on `@modern-js/app-tools` and `@modern-js/module-tools` respectively (you need to have Collaborator and above permissions).
@@ -245,6 +227,8 @@ pnpm run prepare
 pnpm run bump
 ```
 
+After Changesets updates the package versions, this command synchronizes internal `peerDependencies` ranges to `workspace:^<dependency version>` to satisfy the changeset validation.
+
 5. Commit the version change.
 
 ```sh

package/docs/community/releases.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # Releases
 
 ## Changelog

package/docs/community/showcase.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # Showcase
 
 Welcome to the Modern.js showcase page! Here, we present a collection of websites that have been built using Modern.js.

package/docs/community/team.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # Meet the Team
 
 The development of Modern.js is driven by ByteDance's Modern.js team and community contributors.

package/docs/configure/app/bff/cross-project.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # bff.crossProject
 
 - **Type:** `boolean`

package/docs/configure/app/bff/prefix.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # bff.prefix
 
 - **Type:** `string`

package/docs/configure/app/builder-plugins.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # builderPlugins
 
 - **Type:** `RsbuildPlugin[]`

package/docs/configure/app/dev/asset-prefix.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.assetPrefix
 
 - **Type:** `boolean | string | 'auto'`

package/docs/configure/app/dev/before-start-url.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.beforeStartUrl
 
 - **Type:** `() => Promise<void> | void`

package/docs/configure/app/dev/client.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.client
 
 - **Type:**

package/docs/configure/app/dev/hmr.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.hmr
 
 - **Type:** `boolean`

package/docs/configure/app/dev/host.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.host
 
 - **Type:** `string`

package/docs/configure/app/dev/https.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.https
 
 - **Type:** `boolean | { key: string; cert: string }`

package/docs/configure/app/dev/lazy-compilation.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.lazyCompilation
 
 - **Type:**
@@ -29,10 +31,26 @@ type LazyCompilationOptions =
     };
 ```
 
-- **Default:** `false`
+- **Default:** depends on how the application renders:
+  - Pure CSR and streaming SSR applications: `{ imports: true, entries: false }`, which compiles dynamic imports on demand;
+  - Applications using string SSR (including any entry in `server.ssrByEntries` using string SSR), RSC or SSG: `false`.
 
 Enable lazy compilation (compilation on demand), implemented based on Rspack's [lazy compilation](https://rspack.rs/guide/features/lazy-compilation) feature.
 
+This option only takes effect in the dev server and does not affect production build output. When enabled for streaming SSR applications, route components are still compiled eagerly so that first-screen JS/CSS injection stays correct.
+
+An explicitly configured `dev.lazyCompilation` always takes precedence over the default. To disable it:
+
+```ts
+import { defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  dev: {
+    lazyCompilation: false,
+  },
+});
+```
+
 :::info
 The usage of this configuration item is exactly the same as that of Rsbuild. For detailed information, please refer to [Rsbuild - dev.lazyCompilation](https://v2.rsbuild.dev/config/dev/lazy-compilation)。
 In Rspack build mode,

package/docs/configure/app/dev/live-reload.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.liveReload
 
 - **Type:** `boolean`

package/docs/configure/app/dev/mock-dir.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.mockDir
 
 - **Type:** `string`

package/docs/configure/app/dev/progress-bar.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.progressBar
 
 - **Type:**

package/docs/configure/app/dev/server.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.server
 
 - **Type:** `Object`

package/docs/configure/app/dev/setup-middlewares.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.setupMiddlewares
 
 - **Type:**

package/docs/configure/app/dev/start-url.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.startUrl
 
 - **Type:** `boolean | string | string[] | undefined`

package/docs/configure/app/dev/watch-files.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.watchFiles
 
 - **Type:**

package/docs/configure/app/dev/write-to-disk.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # dev.writeToDisk
 
 - **Type:** `boolean | ((filename: string) => boolean)`

package/docs/configure/app/experiments/source-build.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # sourceBuild
 
 - **Type:** `boolean | PluginSourceBuildOptions`

package/docs/configure/app/html/app-icon.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.appIcon
 
 - **Type:**

package/docs/configure/app/html/crossorigin.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.crossorigin
 
 - **Type:** `boolean | 'anonymous' | 'use-credentials'`

package/docs/configure/app/html/favicon.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.favicon
 
 - **Type:** `string ｜ Function`

package/docs/configure/app/html/inject.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.inject
 
 - **Type:** `'head' | 'body' | boolean | Function`

package/docs/configure/app/html/meta.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.meta
 
 - **Type:** `Object | Function`

package/docs/configure/app/html/mount-id.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.mountId
 
 - **Type:** `string`

package/docs/configure/app/html/output-structure.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.outputStructure
 
 - **Type:** `'flat' | 'nested'`

package/docs/configure/app/html/script-loading.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.scriptLoading
 
 - **Type:** `'defer' | 'blocking' | 'module'`

package/docs/configure/app/html/tags.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.tags
 
 - **Type:**

package/docs/configure/app/html/template-parameters.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.templateParameters
 
 - **Type:** `Record<string, unknown> | Function`

package/docs/configure/app/html/template.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.template
 
 - **Type:** `string | Function`

package/docs/configure/app/html/title.md

@@ -1,3 +1,5 @@
+> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
+
 # html.title
 
 - **Type:** `string ｜ Function`