@bleedingdev/modern-js-app-tools 3.9.0-ultramodern.1 → 3.9.0-ultramodern.3

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.
Files changed (275) hide show
  1. package/dist/types/precompress/LICENSE +20 -0
  2. package/dist/types/precompress/index.d.ts +76 -0
  3. package/dist/types/types/config/precompress.d.ts +1 -2
  4. package/docs/apis/app/commands.md +2 -0
  5. package/docs/apis/app/hooks/api/lambda.md +2 -0
  6. package/docs/apis/app/hooks/config/favicon.md +2 -0
  7. package/docs/apis/app/hooks/config/html.md +2 -0
  8. package/docs/apis/app/hooks/config/icon.md +2 -0
  9. package/docs/apis/app/hooks/config/mock.md +2 -0
  10. package/docs/apis/app/hooks/config/public.md +2 -0
  11. package/docs/apis/app/hooks/config/upload.md +2 -0
  12. package/docs/apis/app/hooks/modern-config.md +2 -0
  13. package/docs/apis/app/hooks/server/server.md +2 -0
  14. package/docs/apis/app/hooks/shared.md +2 -0
  15. package/docs/apis/app/hooks/src/app.md +2 -0
  16. package/docs/apis/app/hooks/src/entry.md +2 -0
  17. package/docs/apis/app/hooks/src/entry.server.md +2 -0
  18. package/docs/apis/app/hooks/src/modern.runtime.md +2 -0
  19. package/docs/apis/app/hooks/src/routes.md +2 -0
  20. package/docs/apis/app/hooks/src/server.md +2 -0
  21. package/docs/apis/app/runtime/bff/use-backend-context.md +2 -0
  22. package/docs/apis/app/runtime/core/create-root.md +2 -0
  23. package/docs/apis/app/runtime/core/render.md +2 -0
  24. package/docs/apis/app/runtime/core/runtime-context.md +2 -0
  25. package/docs/apis/app/runtime/router/router.md +2 -0
  26. package/docs/apis/app/runtime/ssr/no-ssr.md +2 -0
  27. package/docs/apis/app/runtime/ssr/renderStreaming.md +2 -0
  28. package/docs/apis/app/runtime/ssr/renderString.md +2 -0
  29. package/docs/apis/app/runtime/ssr/requestHandler.md +2 -0
  30. package/docs/apis/app/runtime/utility/css-in-js.md +2 -0
  31. package/docs/apis/app/runtime/utility/head.md +2 -0
  32. package/docs/apis/app/runtime/utility/loadable.md +2 -0
  33. package/docs/community/blog/2022-0708-updates.md +2 -0
  34. package/docs/community/blog/2022-0910-updates.md +2 -0
  35. package/docs/community/blog/overview.md +2 -0
  36. package/docs/community/blog/v2-release-note.md +2 -0
  37. package/docs/community/blog/v3-release-note.md +2 -0
  38. package/docs/community/contributing-guide.md +2 -0
  39. package/docs/community/releases.md +2 -0
  40. package/docs/community/showcase.md +2 -0
  41. package/docs/community/team.md +2 -0
  42. package/docs/configure/app/bff/cross-project.md +2 -0
  43. package/docs/configure/app/bff/effect.md +2 -0
  44. package/docs/configure/app/bff/prefix.md +2 -0
  45. package/docs/configure/app/bff/runtime-framework.md +2 -0
  46. package/docs/configure/app/builder-plugins.md +2 -0
  47. package/docs/configure/app/dev/asset-prefix.md +2 -0
  48. package/docs/configure/app/dev/before-start-url.md +2 -0
  49. package/docs/configure/app/dev/client.md +2 -0
  50. package/docs/configure/app/dev/hmr.md +2 -0
  51. package/docs/configure/app/dev/host.md +2 -0
  52. package/docs/configure/app/dev/https.md +2 -0
  53. package/docs/configure/app/dev/lazy-compilation.md +2 -0
  54. package/docs/configure/app/dev/live-reload.md +2 -0
  55. package/docs/configure/app/dev/mock-dir.md +2 -0
  56. package/docs/configure/app/dev/progress-bar.md +2 -0
  57. package/docs/configure/app/dev/server.md +2 -0
  58. package/docs/configure/app/dev/setup-middlewares.md +2 -0
  59. package/docs/configure/app/dev/start-url.md +2 -0
  60. package/docs/configure/app/dev/watch-files.md +2 -0
  61. package/docs/configure/app/dev/write-to-disk.md +2 -0
  62. package/docs/configure/app/experiments/source-build.md +2 -0
  63. package/docs/configure/app/html/app-icon.md +2 -0
  64. package/docs/configure/app/html/crossorigin.md +2 -0
  65. package/docs/configure/app/html/favicon.md +2 -0
  66. package/docs/configure/app/html/inject.md +2 -0
  67. package/docs/configure/app/html/meta.md +2 -0
  68. package/docs/configure/app/html/mount-id.md +2 -0
  69. package/docs/configure/app/html/output-structure.md +2 -0
  70. package/docs/configure/app/html/script-loading.md +2 -0
  71. package/docs/configure/app/html/tags.md +2 -0
  72. package/docs/configure/app/html/template-parameters.md +2 -0
  73. package/docs/configure/app/html/template.md +2 -0
  74. package/docs/configure/app/html/title.md +2 -0
  75. package/docs/configure/app/output/asset-prefix.md +2 -0
  76. package/docs/configure/app/output/assets-retry.md +2 -0
  77. package/docs/configure/app/output/charset.md +2 -0
  78. package/docs/configure/app/output/clean-dist-path.md +2 -0
  79. package/docs/configure/app/output/convert-to-rem.md +2 -0
  80. package/docs/configure/app/output/copy.md +2 -0
  81. package/docs/configure/app/output/css-modules.md +2 -0
  82. package/docs/configure/app/output/data-uri-limit.md +2 -0
  83. package/docs/configure/app/output/disable-css-module-extension.md +2 -0
  84. package/docs/configure/app/output/disable-inline-runtime-chunk.md +2 -0
  85. package/docs/configure/app/output/disable-svgr.md +2 -0
  86. package/docs/configure/app/output/disable-ts-checker.md +2 -0
  87. package/docs/configure/app/output/dist-path.md +2 -0
  88. package/docs/configure/app/output/enable-asset-manifest.md +2 -0
  89. package/docs/configure/app/output/enable-css-module-tsdeclaration.md +2 -0
  90. package/docs/configure/app/output/enable-inline-route-manifests.md +2 -0
  91. package/docs/configure/app/output/externals.md +2 -0
  92. package/docs/configure/app/output/filename-hash.md +2 -0
  93. package/docs/configure/app/output/filename.md +2 -0
  94. package/docs/configure/app/output/inject-styles.md +2 -0
  95. package/docs/configure/app/output/inline-scripts.md +2 -0
  96. package/docs/configure/app/output/inline-styles.md +2 -0
  97. package/docs/configure/app/output/legal-comments.md +2 -0
  98. package/docs/configure/app/output/minify.md +2 -0
  99. package/docs/configure/app/output/override-browserslist.md +2 -0
  100. package/docs/configure/app/output/polyfill.md +2 -0
  101. package/docs/configure/app/output/source-map.md +2 -0
  102. package/docs/configure/app/output/split-route-chunks.md +2 -0
  103. package/docs/configure/app/output/ssg.md +2 -0
  104. package/docs/configure/app/output/ssgByEntries.md +2 -0
  105. package/docs/configure/app/output/svg-default-export.md +2 -0
  106. package/docs/configure/app/output/temp-dir.md +2 -0
  107. package/docs/configure/app/performance/build-cache.md +2 -0
  108. package/docs/configure/app/performance/chunk-split.md +2 -0
  109. package/docs/configure/app/performance/dns-prefetch.md +2 -0
  110. package/docs/configure/app/performance/preconnect.md +2 -0
  111. package/docs/configure/app/performance/prefetch.md +2 -0
  112. package/docs/configure/app/performance/preload.md +2 -0
  113. package/docs/configure/app/performance/print-file-size.md +2 -0
  114. package/docs/configure/app/performance/profile.md +2 -0
  115. package/docs/configure/app/performance/remove-console.md +2 -0
  116. package/docs/configure/app/performance/remove-moment-locale.md +2 -0
  117. package/docs/configure/app/performance/rsdoctor.md +2 -0
  118. package/docs/configure/app/plugins.md +2 -0
  119. package/docs/configure/app/resolve/alias-strategy.md +2 -0
  120. package/docs/configure/app/resolve/alias.md +2 -0
  121. package/docs/configure/app/resolve/condition-names.md +2 -0
  122. package/docs/configure/app/resolve/dedupe.md +2 -0
  123. package/docs/configure/app/resolve/extensions.md +2 -0
  124. package/docs/configure/app/runtime/0-intro.md +2 -0
  125. package/docs/configure/app/runtime/plugins.md +2 -0
  126. package/docs/configure/app/runtime/router.md +2 -0
  127. package/docs/configure/app/security/check-syntax.md +2 -0
  128. package/docs/configure/app/security/nonce.md +2 -0
  129. package/docs/configure/app/security/sri.md +2 -0
  130. package/docs/configure/app/server/base-url.md +2 -0
  131. package/docs/configure/app/server/port.md +2 -0
  132. package/docs/configure/app/server/public-routes.md +2 -0
  133. package/docs/configure/app/server/routes.md +2 -0
  134. package/docs/configure/app/server/rsc.md +2 -0
  135. package/docs/configure/app/server/ssr-by-entries.md +2 -0
  136. package/docs/configure/app/server/ssr.md +2 -0
  137. package/docs/configure/app/server/tsconfig-path.md +2 -0
  138. package/docs/configure/app/source/alias-strategy.md +2 -0
  139. package/docs/configure/app/source/alias.md +2 -0
  140. package/docs/configure/app/source/config-dir.md +2 -0
  141. package/docs/configure/app/source/decorators.md +2 -0
  142. package/docs/configure/app/source/define.md +2 -0
  143. package/docs/configure/app/source/disable-default-entries.md +2 -0
  144. package/docs/configure/app/source/enable-async-entry.md +2 -0
  145. package/docs/configure/app/source/enable-async-pre-entry.md +2 -0
  146. package/docs/configure/app/source/entries-dir.md +2 -0
  147. package/docs/configure/app/source/entries.md +2 -0
  148. package/docs/configure/app/source/exclude.md +2 -0
  149. package/docs/configure/app/source/global-vars.md +2 -0
  150. package/docs/configure/app/source/include.md +2 -0
  151. package/docs/configure/app/source/main-entry-name.md +2 -0
  152. package/docs/configure/app/source/pre-entry.md +2 -0
  153. package/docs/configure/app/source/react-compiler.md +2 -0
  154. package/docs/configure/app/source/transform-import.md +2 -0
  155. package/docs/configure/app/split-chunks.md +2 -0
  156. package/docs/configure/app/tools/autoprefixer.md +2 -0
  157. package/docs/configure/app/tools/bundler-chain.md +2 -0
  158. package/docs/configure/app/tools/css-extract.md +2 -0
  159. package/docs/configure/app/tools/css-loader.md +2 -0
  160. package/docs/configure/app/tools/dev-server.md +2 -0
  161. package/docs/configure/app/tools/html-plugin.md +2 -0
  162. package/docs/configure/app/tools/less.md +2 -0
  163. package/docs/configure/app/tools/lightningcss-loader.md +2 -0
  164. package/docs/configure/app/tools/minify-css.md +2 -0
  165. package/docs/configure/app/tools/postcss.md +2 -0
  166. package/docs/configure/app/tools/rspack.md +2 -0
  167. package/docs/configure/app/tools/sass.md +2 -0
  168. package/docs/configure/app/tools/style-loader.md +2 -0
  169. package/docs/configure/app/tools/swc.md +2 -0
  170. package/docs/configure/app/tools/ts-checker.md +2 -0
  171. package/docs/configure/app/usage.md +2 -0
  172. package/docs/guides/advanced-features/bff/cross-project.md +2 -0
  173. package/docs/guides/advanced-features/bff/data-platform.md +2 -0
  174. package/docs/guides/advanced-features/bff/extend-server.md +2 -0
  175. package/docs/guides/advanced-features/bff/frameworks.md +2 -0
  176. package/docs/guides/advanced-features/bff/function.md +2 -0
  177. package/docs/guides/advanced-features/bff/operators.md +2 -0
  178. package/docs/guides/advanced-features/bff/sdk.md +2 -0
  179. package/docs/guides/advanced-features/bff/upload.md +2 -0
  180. package/docs/guides/advanced-features/bff.md +2 -0
  181. package/docs/guides/advanced-features/build-performance.md +2 -0
  182. package/docs/guides/advanced-features/compatibility.md +2 -0
  183. package/docs/guides/advanced-features/international/advanced.md +2 -0
  184. package/docs/guides/advanced-features/international/api.md +2 -0
  185. package/docs/guides/advanced-features/international/best-practices.md +2 -0
  186. package/docs/guides/advanced-features/international/configuration.md +2 -0
  187. package/docs/guides/advanced-features/international/locale-detection.md +2 -0
  188. package/docs/guides/advanced-features/international/quick-start.md +2 -0
  189. package/docs/guides/advanced-features/international/resource-loading.md +2 -0
  190. package/docs/guides/advanced-features/international/routing.md +2 -0
  191. package/docs/guides/advanced-features/international.md +2 -0
  192. package/docs/guides/advanced-features/low-level.md +2 -0
  193. package/docs/guides/advanced-features/page-performance/code-split.md +2 -0
  194. package/docs/guides/advanced-features/page-performance/inline-assets.md +2 -0
  195. package/docs/guides/advanced-features/page-performance/optimize-bundle.md +2 -0
  196. package/docs/guides/advanced-features/page-performance/react-compiler.md +2 -0
  197. package/docs/guides/advanced-features/server-monitor/logger.md +2 -0
  198. package/docs/guides/advanced-features/server-monitor/metrics.md +2 -0
  199. package/docs/guides/advanced-features/server-monitor/monitors.md +2 -0
  200. package/docs/guides/advanced-features/source-build.md +2 -0
  201. package/docs/guides/advanced-features/web-server.md +2 -0
  202. package/docs/guides/basic-features/alias.md +2 -0
  203. package/docs/guides/basic-features/css/css-in-js.md +2 -0
  204. package/docs/guides/basic-features/css/css-modules.md +2 -0
  205. package/docs/guides/basic-features/css/css.md +2 -0
  206. package/docs/guides/basic-features/css/tailwindcss.md +2 -0
  207. package/docs/guides/basic-features/data/data-cache.md +2 -0
  208. package/docs/guides/basic-features/data/data-fetch.md +2 -0
  209. package/docs/guides/basic-features/data/data-write.md +2 -0
  210. package/docs/guides/basic-features/debug/mock.md +2 -0
  211. package/docs/guides/basic-features/debug/proxy.md +2 -0
  212. package/docs/guides/basic-features/debug/rsdoctor.md +2 -0
  213. package/docs/guides/basic-features/debug/using-storybook.md +2 -0
  214. package/docs/guides/basic-features/deploy.md +2 -0
  215. package/docs/guides/basic-features/env-vars.md +2 -0
  216. package/docs/guides/basic-features/html.md +2 -0
  217. package/docs/guides/basic-features/output-files.md +2 -0
  218. package/docs/guides/basic-features/render/before-render.md +2 -0
  219. package/docs/guides/basic-features/render/overview.md +2 -0
  220. package/docs/guides/basic-features/render/rsc.md +2 -0
  221. package/docs/guides/basic-features/render/ssg.md +2 -0
  222. package/docs/guides/basic-features/render/ssr-cache.md +2 -0
  223. package/docs/guides/basic-features/render/ssr.md +2 -0
  224. package/docs/guides/basic-features/render/streaming-ssr.md +2 -0
  225. package/docs/guides/basic-features/routes/config-routes.md +2 -0
  226. package/docs/guides/basic-features/routes/routes.md +2 -0
  227. package/docs/guides/basic-features/static-assets/json-files.md +2 -0
  228. package/docs/guides/basic-features/static-assets/svg-assets.md +2 -0
  229. package/docs/guides/basic-features/static-assets/wasm-assets.md +2 -0
  230. package/docs/guides/basic-features/static-assets.md +2 -0
  231. package/docs/guides/basic-features/testing/playwright.md +2 -0
  232. package/docs/guides/basic-features/testing/rstest.md +2 -0
  233. package/docs/guides/concept/builder.md +2 -0
  234. package/docs/guides/concept/entries.md +2 -0
  235. package/docs/guides/concept/server.md +2 -0
  236. package/docs/guides/get-started/ai-coding-agents.md +2 -0
  237. package/docs/guides/get-started/glossary.md +2 -0
  238. package/docs/guides/get-started/introduction.md +2 -0
  239. package/docs/guides/get-started/quick-start.md +2 -0
  240. package/docs/guides/get-started/tech-stack.md +2 -0
  241. package/docs/guides/get-started/ultramodern.md +6 -4
  242. package/docs/guides/get-started/upgrade.md +2 -0
  243. package/docs/guides/topic-detail/module-federation/application.md +2 -0
  244. package/docs/guides/topic-detail/module-federation/deploy.md +2 -0
  245. package/docs/guides/topic-detail/module-federation/i18n.md +2 -0
  246. package/docs/guides/topic-detail/module-federation/introduce.md +2 -0
  247. package/docs/guides/topic-detail/module-federation/ssr.md +2 -0
  248. package/docs/guides/topic-detail/module-federation/usage.md +2 -0
  249. package/docs/guides/troubleshooting/builder.md +2 -0
  250. package/docs/guides/troubleshooting/cli.md +2 -0
  251. package/docs/guides/troubleshooting/dependencies.md +2 -0
  252. package/docs/guides/troubleshooting/hmr.md +2 -0
  253. package/docs/guides/upgrade/config.md +2 -0
  254. package/docs/guides/upgrade/entry.md +2 -0
  255. package/docs/guides/upgrade/other.md +2 -0
  256. package/docs/guides/upgrade/overview.md +2 -0
  257. package/docs/guides/upgrade/tailwindcss.md +2 -0
  258. package/docs/guides/upgrade/web-server.md +2 -0
  259. package/docs/index.md +2 -0
  260. package/docs/plugin/cli-plugins/api.md +2 -0
  261. package/docs/plugin/cli-plugins/life-cycle.md +2 -0
  262. package/docs/plugin/introduction.md +2 -0
  263. package/docs/plugin/official/cli-plugins/plugin-bff.md +2 -0
  264. package/docs/plugin/official/cli-plugins/plugin-ssg.md +2 -0
  265. package/docs/plugin/official/cli-plugins/plugin-styled-components.md +2 -0
  266. package/docs/plugin/official/cli-plugins.md +2 -0
  267. package/docs/plugin/plugin-system.md +2 -0
  268. package/docs/plugin/runtime-plugins/api.md +2 -0
  269. package/docs/plugin/runtime-plugins/life-cycle.md +2 -0
  270. package/docs/plugin/server-plugins/api.md +2 -0
  271. package/docs/plugin/server-plugins/life-cycle.md +2 -0
  272. package/docs/tutorials/examples/csr-auth.md +2 -0
  273. package/docs/tutorials/foundations/introduction.md +2 -0
  274. package/package.json +22 -22
  275. package/rslib.config.mts +5 -0
@@ -0,0 +1,20 @@
1
+ Copyright JS Foundation and other contributors
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ 'Software'), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,76 @@
1
+ type BasePluginOptions<T> = {
2
+ /**
3
+ * include all assets that pass test assertion
4
+ */
5
+ test?: Rules | undefined;
6
+ /**
7
+ * include all assets matching any of these conditions
8
+ */
9
+ include?: Rules | undefined;
10
+ /**
11
+ * exclude all assets matching any of these conditions
12
+ */
13
+ exclude?: Rules | undefined;
14
+ /**
15
+ * only assets bigger than this size are processed, in bytes
16
+ */
17
+ threshold?: number | undefined;
18
+ /**
19
+ * only assets that compress better than this ratio are processed (`minRatio = Compressed Size / Original Size`)
20
+ */
21
+ minRatio?: number | undefined;
22
+ /**
23
+ * whether to delete the original assets or not
24
+ */
25
+ deleteOriginalAssets?: DeleteOriginalAssets | undefined;
26
+ /**
27
+ * the target asset filename
28
+ */
29
+ filename?: Filename | undefined;
30
+ };
31
+ type Rules = Rule[] | Rule;
32
+ type Rule = RegExp | string;
33
+ type DeleteOriginalAssets =
34
+ | boolean
35
+ | "keep-source-map"
36
+ | ((name: string) => boolean);
37
+ type Filename = string | ((fileData: PathData) => string);
38
+ type PathData = import('@rsbuild/core').Rspack.PathData;
39
+ type DefinedDefaultAlgorithmAndOptions<T> = T extends ZlibOptions
40
+ ? {
41
+ algorithm?: string | AlgorithmFunction<T> | undefined;
42
+ compressionOptions?: CompressionOptions<T> | undefined;
43
+ }
44
+ : {
45
+ algorithm: string | AlgorithmFunction<T>;
46
+ compressionOptions?: CompressionOptions<T> | undefined;
47
+ };
48
+ type ZlibOptions = import("zlib").ZlibOptions;
49
+ type AlgorithmFunction<T> = (
50
+ input: Buffer,
51
+ options: CompressionOptions<T>,
52
+ callback: (
53
+ error: Error | null | undefined,
54
+ result:
55
+ | WithImplicitCoercion<ArrayBuffer | SharedArrayBuffer>
56
+ | Uint8Array
57
+ | ReadonlyArray<number>
58
+ | WithImplicitCoercion<Uint8Array | ReadonlyArray<number> | string>
59
+ | WithImplicitCoercion<string>
60
+ | {
61
+ [Symbol.toPrimitive](hint: "string"): string;
62
+ },
63
+ ) => void,
64
+ ) => any;
65
+ type CompressionOptions<T> = InferDefaultType<T>;
66
+ type InferDefaultType<T> = T extends infer U ? U : CustomOptions;
67
+ type CustomOptions = {
68
+ [key: string]: EXPECTED_ANY;
69
+ };
70
+ type EXPECTED_ANY = any;
71
+ type WithImplicitCoercion<T> =
72
+ | T
73
+ | {
74
+ valueOf(): T;
75
+ };
76
+ export type CompressionPluginOptions = BasePluginOptions<ZlibOptions> & DefinedDefaultAlgorithmAndOptions<ZlibOptions>;
@@ -1,5 +1,4 @@
1
- import type CompressionPlugin from 'compression-webpack-plugin';
2
- type CompressionPluginOptions = NonNullable<ConstructorParameters<typeof CompressionPlugin>[0]>;
1
+ import type { CompressionPluginOptions } from '../../precompress/index.js';
3
2
  export type PrecompressCodecOptions = boolean | CompressionPluginOptions;
4
3
  export interface PrecompressConfig {
5
4
  /**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Commands
2
4
 
3
5
  UltraModern.js has some built-in commands that can help you quickly start a development server, build production environment code, and more.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # lambda/\*.ts
2
4
 
3
5
  After enabling BFF, the files under the `lambda/` directory will be registered as BFF routes according to conventions.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Favicon
2
4
 
3
5
  When there is a `favicon.*` file in the `config` directory at the root of the project, Modern.js will automatically set the file to the [html.favicon](/configure/app/html/favicon.md) configuration option for generating the favicon icon on the page:
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html/
2
4
 
3
5
  You can inject custom HTML fragments at different locations of the default internal HTML template through the `config/html` directory.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Apple Touch Icon
2
4
 
3
5
  When there is an `icon.*` file in the `config` directory at the root of the project, Modern.js will automatically set the file to the [html.appIcon](/configure/app/html/app-icon.md) configuration option for generating the Apple Touch Icon icon under the iOS system.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # mock/
2
4
 
3
5
  When there is a `config/mock/index.ts` or `config/mock/index.js` file in the
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # public/
2
4
 
3
5
  Any static assets can be placed in the `public/` directory, and the files will be deployed to the corresponding application domain by the server.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # upload/
2
4
 
3
5
  Any static assets can be placed in the `upload/` directory.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # modern.config.ts
2
4
 
3
5
  The Modern.js configuration file. Through this file, you can personalize the configuration of various aspects of the current project.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # modern.server.ts
2
4
 
3
5
  This file extends the Modern.js Server. In this file, you can configure [Middleware](/guides/advanced-features/web-server.md#middleware), [RenderMiddleware](/guides/advanced-features/web-server.md#rendermiddleware), or [Plugin](/guides/advanced-features/web-server.md#plugin) for the Server that starts with the Modern.js project.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # shared/
2
4
 
3
5
  Shared source code directory. When there is common code in `api/`, `server/`, and `src/` in the project, you can put these codes in the `shared` directory instead of directly referencing them.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # App.tsx
2
4
 
3
5
  The entry identifier when using [Self-controlled Routing](/guides/concept/entries.md#self-controlled-routing) in the application.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # entry.tsx
2
4
 
3
5
  Normally, the [`routes/`](/apis/app/hooks/src/routes.md) and [`App.tsx`](/apis/app/hooks/src/app.md) hook files can meet our needs. When we need to add custom behavior before component rendering or take full control of the Rspack packaging entry, we can create `entry.ts` file in the src or entry directory. Here are two cases for discussion。
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # entry.server.tsx
2
4
 
3
5
  When the project initiates `server.ssr`, Modern.js generates a default Server-Side entry. The sample code is as follows:
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # modern.runtime.ts
2
4
 
3
5
  The Modern.js Runtime configuration file allows for personalized configuration of the Runtime capabilities for the current project.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # routes/
2
4
 
3
5
  The identifier for the entry point when the application uses [Conventional Routing](/guides/basic-features/routes/routes.md#conventional-routing).
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # \*.\[server|node].tsx
2
4
 
3
5
  Used in the application project to place server-side code. When `*.tsx` and `*.[server|node].tsx` coexist, SSR will prefer to use the `*.[server|node].tsx` file instead of the `*.tsx` file when rendering on the server.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # useHonoContext
2
4
 
3
5
  Used to obtain backend request context in an integrated BFF function.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # createRoot
2
4
 
3
5
  It is used to create the root component provided by Modern.js, which will automatically register Runtime plugins and complete the initialization of Runtime plugins.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # render
2
4
 
3
5
  It is used to render project components.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # RuntimeContext
2
4
 
3
5
  `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.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # router
2
4
 
3
5
  :::info
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # NoSSR
2
4
 
3
5
  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.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # renderStreaming
2
4
 
3
5
  Used for `React v18` + `Streaming SSR` to render readable streams, used in conjunction with `createRequestHandler`.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # renderString
2
4
 
3
5
  Used for React String SSR to render strings, used in conjunction with `createRequestHandler`.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # createRequestHandler
2
4
 
3
5
  Used to customize the Server-Side Rendering entry to return the `requestHandler`.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # CSS-In-JS API
2
4
 
3
5
  Use Style Component to write CSS.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Head
2
4
 
3
5
  Used to add html elements (such as title, meta, script, etc.) to the `<head>` element, supports SSR.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # loadable
2
4
 
3
5
  Used to create Loadable component
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # 2022 年 7 \~ 8 月更新内容
2
4
 
3
5
  > 发表于 2022.09.05
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # 2022 年 9 \~ 10 月更新内容
2
4
 
3
5
  > 发表于 2022.11.01
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Overview
2
4
 
3
5
  Welcome to Modern.js blog!
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Modern.js v2 发布:支持 Rspack 构建
2
4
 
3
5
  > 发表于 2023.03.16
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Modern.js v3 Release: Focused on web framework, embracing ecosystem development
2
4
 
3
5
  > Published on 2025.02.06
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Contributing Guide
2
4
 
3
5
  Thanks for that you are interested in contributing to Modern.js. Before starting your contribution, please take a moment to read the following guidelines.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Releases
2
4
 
3
5
  ## Changelog
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Ecosystem
2
4
 
3
5
  UltraModern.js builds on a focused ecosystem of frameworks and tools. These projects provide the Effect, TanStack Router, build, documentation, and Module Federation foundations used by the fork.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # Meet the Team
2
4
 
3
5
  The development of Modern.js is driven by ByteDance's Modern.js team and community contributors.
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # bff.crossProject
2
4
 
3
5
  - **Type:** `boolean`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # bff.effect
2
4
 
3
5
  - **Type:**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # bff.prefix
2
4
 
3
5
  - **Type:** `string`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # bff.runtimeFramework
2
4
 
3
5
  - **Type:** `'hono' | 'effect'`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # builderPlugins
2
4
 
3
5
  - **Type:** `RsbuildPlugin[]`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.assetPrefix
2
4
 
3
5
  - **Type:** `boolean | string | 'auto'`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.beforeStartUrl
2
4
 
3
5
  - **Type:** `() => Promise<void> | void`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.client
2
4
 
3
5
  - **Type:**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.hmr
2
4
 
3
5
  - **Type:** `boolean`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.host
2
4
 
3
5
  - **Type:** `string`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.https
2
4
 
3
5
  - **Type:** `boolean | { key: string; cert: string }`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.lazyCompilation
2
4
 
3
5
  - **Type:**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.liveReload
2
4
 
3
5
  - **Type:** `boolean`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.mockDir
2
4
 
3
5
  - **Type:** `string`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.progressBar
2
4
 
3
5
  - **Type:**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.server
2
4
 
3
5
  - **Type:** `Object`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.setupMiddlewares
2
4
 
3
5
  - **Type:**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.startUrl
2
4
 
3
5
  - **Type:** `boolean | string | string[] | undefined`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.watchFiles
2
4
 
3
5
  - **Type:**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # dev.writeToDisk
2
4
 
3
5
  - **Type:** `boolean | ((filename: string) => boolean)`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # sourceBuild
2
4
 
3
5
  - **Type:** `boolean | PluginSourceBuildOptions`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.appIcon
2
4
 
3
5
  - **Type:**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.crossorigin
2
4
 
3
5
  - **Type:** `boolean | 'anonymous' | 'use-credentials'`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.favicon
2
4
 
3
5
  - **Type:** `string | Function`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.inject
2
4
 
3
5
  - **Type:** `'head' | 'body' | boolean | Function`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.meta
2
4
 
3
5
  - **Type:** `Object | Function`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.mountId
2
4
 
3
5
  - **Type:** `string`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.outputStructure
2
4
 
3
5
  - **Type:** `'flat' | 'nested'`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.scriptLoading
2
4
 
3
5
  - **Type:** `'defer' | 'blocking' | 'module'`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.tags
2
4
 
3
5
  - **Type:**
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.templateParameters
2
4
 
3
5
  - **Type:** `Record<string, unknown> | Function`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.template
2
4
 
3
5
  - **Type:** `string | Function`
@@ -1,3 +1,5 @@
1
+ > For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.
2
+
1
3
  # html.title
2
4
 
3
5
  - **Type:** `string | Function`