@modern-js/module-tools-docs 2.49.0 → 2.49.2

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @modern-js/module-tools-docs
 
+## 2.49.2
+
+## 2.49.1
+
+### Patch Changes
+
+- bfba084: docs: bump Rspress v1.18.2 and remove dividers
+- 4d5d222: docs(module-doc): align `define` description to actual behavior
+  docs(module-doc): 对齐 `define` 的文档描述和实际行为一致
+
 ## 2.49.0
 
 ## 2.48.6

package/docs/en/api/config/build-config.mdx

@@ -376,16 +376,23 @@ Define global variables that will be injected into the code
 - **Type**: `Record<string, string>`
 - **Default**: `{}`
 
-Since the `define` function is implemented by global text replacement, you need to ensure that the global variable values are strings. A safer approach is to convert the value of each global variable to a string, using `JSON.stringify`, as follows.
+Since the `define` function is implemented by global text replacement, you need to ensure that the global variable values are strings. A safer approach is to convert the value of each global variable to a string, as follows.
+
+:::info
+Modern.js automatically performs JSON serialization handling internally, so manual serialization is not required.
+
+If automatic serialization is not needed, you can define [`alias`](https://esbuild.github.io/api/#alias) using [`esbuildOptions`](/api/config/build-config.html#esbuildoptions) configuration.
+
+:::
 
 ```js title="modern.config.ts"
-export default {
+export default defineConfig({
   buildConfig: {
     define: {
-      VERSION: JSON.stringify('1.0'),
+      VERSION: require('./package.json').version || '0.0.0',
     },
   },
-};
+});
 ```
 
 If the project is a TypeScript project, then you may need to add the following to the `.d.ts` file in the project source directory.
@@ -403,7 +410,7 @@ import { defineConfig } from '@modern-js/module-tools';
 export default defineConfig({
   buildConfig: {
     define: {
-      'process.env.VERSION': JSON.stringify(process.env.VERSION || '0.0.0'),
+      'process.env.VERSION': process.env.VERSION || '0.0.0',
     },
   },
 });

package/docs/zh/api/config/build-config.mdx

@@ -369,13 +369,19 @@ type Options = {
 - 类型： `Record<string, string>`
 - 默认值： `{}`
 
-由于 `define` 功能是由全局文本替换实现的，所以需要保证全局变量值为字符串，更为安全的做法是将每个全局变量的值转化为字符串，使用 `JSON.stringify` 进行转换，如下所示：
+由于 `define` 功能是由全局文本替换实现的，所以需要保证全局变量值为字符串，更为安全的做法是将每个全局变量的值转化为字符串，如下所示：
+
+:::info
+框架内部会自动进行 JSON 序列化处理，因此不需要手动执行序列化。
+
+如果不需要自动序列化，可以通过配置 [`esbuildOptions`](/api/config/build-config.html#esbuildoptions) 定义 [`alias`](https://esbuild.github.io/api/#alias) 来实现。
+:::
 
 ```js title="modern.config.ts"
 export default defineConfig({
   buildConfig: {
     define: {
-      VERSION: JSON.stringify(require('./package.json').version || '0.0.0'),
+      VERSION: require('./package.json').version || '0.0.0',
     },
   },
 });
@@ -396,7 +402,7 @@ import { defineConfig } from '@modern-js/module-tools';
 export default defineConfig({
   buildConfig: {
     define: {
-      'process.env.VERSION': JSON.stringify(process.env.VERSION || '0.0.0'),
+      'process.env.VERSION': process.env.VERSION || '0.0.0',
     },
   },
 });

package/package.json

@@ -9,14 +9,14 @@
     "directory": "packages/document/module-doc"
   },
   "license": "MIT",
-  "version": "2.49.0",
+  "version": "2.49.2",
   "main": "index.js",
   "devDependencies": {
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rspress": "1.16.0",
-    "@rspress/shared": "1.16.0",
-    "@modern-js/doc-plugin-auto-sidebar": "2.49.0"
+    "rspress": "1.18.2",
+    "@rspress/shared": "1.18.2",
+    "@modern-js/doc-plugin-auto-sidebar": "2.49.2"
   },
   "scripts": {
     "dev": "rspress dev",