@modern-js/module-tools-docs 2.0.0-beta.4 → 2.0.1

package/docs/{zh/api → en/api/config}/design-system.md

@@ -1,17 +1,20 @@
+---
+sidebar_position: 3
+---
+
 # DesignSystem
-本章描述了有关designSystem相关的配置
+
+This chapter describes the configuration related to designSystem
 
 :::tips
-需要先通过 `pnpm run new` 启用 Tailwind CSS 功能。
+The Tailwind CSS feature needs to be enabled first via `pnpm run new`.
 :::
 
+- type: `Object`
+- default: `see configuration details below`.
 
-- type:  `Object`
-- default: `见下方配置详情`。
-
-<details>
-  <summary>designSystem 配置详情</summary>
-
+<details
+  <summary>designSystem configuration details</summary>
 ```js
   const designSystem =  {
     screens: {
@@ -631,22 +634,23 @@
       '700': '700ms',
       '1000': '1000ms',
     },
-  };
-```
 
+};
+
+````
 :::tips
-更多关于[TailwindCSS 配置](https://tailwindcss.com/docs/configuration#theme)
+More about [TailwindCSS configuration](https://tailwindcss.com/docs/configuration#theme)
 :::
 </details>
 
 
-`designSystem` 用于定义项目的调色板、排版比例（Typographic Scales 或者 Type Scale）、字体列表、断点、边框圆角值等等。因为 Modern.js 借用了 Tailwind Theme 的设计方式，并且内部也集成了 Tailwind CSS，所以 `designSystem` 使用方式与 Tailwind CSS Theme 相同
+The `designSystem` is used to define the project's color palette, typographic scales (Typographic Scales or Type Scale), font list, breakpoints, border rounding values, etc. Since Modern.js borrows the design approach from Tailwind Theme and integrates with Tailwind CSS internally, `designSystem` is used in the same way as Tailwind CSS Theme
 
-`designSystem` 对象包含 `screens`、`colors` 和 `spacing` 的属性，以及每个可自定义核心插件。
+The `designSystem` object contains the `screens`, `colors` and `spacing` properties, as well as each customizable core plugin.
 
 ## Screens
 
-使用`screens` 可以自定义项目中的响应断点：
+The responsive breakpoints in your project can be customized using `screens`: the
 
 ```js
 const designSystem = {
@@ -657,11 +661,11 @@ const designSystem = {
     xl: '1280px',
   },
 };
-```
+````
 
-其中 `screens` 对象里的属性名是屏幕名称（用作 `Tailwind CSS` 生成的自适应实用程序变体的前缀，例如 `md:text-center`），值是该断点应在其开始的 `min-width`。
+where the property name in the `screens` object is the screen name (used as a prefix for the adaptive utility variants generated by `Tailwind CSS`, e.g. `md:text-center`) and the value is the `min-width` at which the breakpoint should start.
 
-默认断点受常见设备分辨率的启发：
+Default breakpoints are inspired by common device resolutions: the
 
 ```js
 const designSystem = {
@@ -681,7 +685,7 @@ const designSystem = {
 };
 ```
 
-你可以在你的项目中使用任意你喜欢的名称作为断点的属性：
+You can use any name you like as a breakpoint property in your project: the
 
 ```js
 const designSystem = {
@@ -698,32 +702,40 @@ const designSystem = {
 };
 ```
 
-这些屏幕名称反映在 `utilities` 中，因此 `text-center` 现在是这样的：
+These screen names are reflected in `utilities`, so `text-center` now looks like this
 
 ```css
-.text-center { text-align: center }
+.text-center {
+  text-align: center;
+}
 
 @media (min-width: 640px) {
-    .tablet\:text-center { text-align: center }
+  .tablet\:text-center {
+    text-align: center;
+  }
 }
 
 @media (min-width: 1024px) {
-    .laptop\:text-center { text-align: center }
+  .laptop\:text-center {
+    text-align: center;
+  }
 }
 
 @media (min-width: 1280px) {
-    .desktop\:text-center { text-align: center }
+  .desktop\:text-center {
+    text-align: center;
+  }
 }
 ```
 
-### Max-width 断点
+### Max-width breakpoints
 
-如果要使用 `max-width` 断点而不是 `min-width`，可以将屏幕指定为具有 `max` 属性的对象：
+To use the `max-width` breakpoint instead of `min-width`, you can specify the screen as an object with the `max` attribute.
 
 ```js
 const designSystem = {
   screens: {
-    xl: { max: '1279px' },
+    xl: { max: '1279px' }
     // => @media (max-width: 1279px) { ... }
 
     lg: { max: '1023px' },
@@ -738,24 +750,24 @@ const designSystem = {
 };
 ```
 
-如有必要，以创建带有 `min-width` 和  `max-width` 定义的断点，例如：
+If necessary, to create breakpoints with `min-width` and `max-width` definitions, e.g.
 
 ```js
 const designSystem = {
   screens: {
-    sm: { min: '640px', max: '767px' },
-    md: { min: '768px', max: '1023px' },
-    lg: { min: '1024px', max: '1279px' },
-    xl: { min: '1280px' },
+    sm: { min: '640px', max: '767px' }
+    md: { min: '768px', max: '1023px' }
+    lg: { min: '1024px', max: '1279px' }, lg: { min: '1024px', max: '1279px' },
+    xl: { min: '1280px' }
   },
 };
 ```
 
-### 多个范围的断点
+### Multiple range breakpoints
 
-有时，将单个断点定义应用于多个范围会很有用。
+Sometimes it can be useful to apply a single breakpoint definition to multiple scopes.
 
-例如，假设您有一个 `sidebar`，并且希望断点基于内容区域宽度而不是整个视口。您可以模拟这种情况，当 `sidebar` 可见并缩小内容区域时，断点的样式使用较小的断点样式：
+For example, suppose you have a `sidebar` and want the breakpoint to be based on the width of the content area rather than the entire viewport. You can simulate this situation by using a smaller breakpoint style when the `sidebar` is visible and the content area is narrowed: the
 
 ```js
 const designSystem = {
@@ -765,8 +777,8 @@ const designSystem = {
       // Sidebar appears at 768px, so revert to `sm:` styles between 768px
       // and 868px, after which the main content area is wide enough again to
       // apply the `md:` styles.
-      { min: '668px', max: '767px' },
-      { min: '868px' },
+      { min: '668px', max: '767px' }
+      { min: '868px' }, { min: '868px' },
     ],
     lg: '1100px',
     xl: '1400px',
@@ -774,9 +786,9 @@ const designSystem = {
 };
 ```
 
-### 自定义媒体查询
+### Custom media queries
 
-如果需要为断点提供完全自定义的媒体查询，则可以使用带有 `raw` 属性的对象：
+If a fully customizable media query is required for a breakpoint, an object with the `raw` attribute can be used.
 
 ```js
 const designSystem = {
@@ -789,30 +801,31 @@ const designSystem = {
 };
 ```
 
-### Print 样式
+### Print styles
 
-如果需要为打印应用不同的样式，则 `raw` 选项可能特别有用。
+The `raw` option may be particularly useful if you need to apply different styles to printing.
 
-需要做的就是在 `designSystem.extend.screens` 下添加一个 `print`：
+All that needs to be done is to add a `print` under `designSystem.extend.screens`.
 
-```js
+``js
 const designSystem = {
-  extend: {
-    screens: {
-      print: { raw: 'print' },
-      // => @media print { ... }
-    },
-  },
+extend: {
+screens: {
+print: { raw: 'print' },
+// => @media print { ... }
+},
+},
 };
-```
 
-然后，可以使用诸如 `print:text-black` 之类的类来指定仅当某人尝试打印页面时才应用的样式：
+````
+
+Then, a class such as ``print:text-black`` can be used to specify a style that is applied only when someone tries to print a page: ``
 
 ```html
 <div class="text-gray-700 print:text-black">
-  <!-- ... -->
+  <! -- ... -->
 </div>
-```
+````
 
 ### Dark Mode
 
@@ -833,7 +846,7 @@ const designSystem = {
 
 ```html
 <div class="text-gray-700 dark:text-gray-200">
-  <!-- ... -->
+  <! -- ... -->
 </div>
 ```
 
@@ -860,13 +873,13 @@ const designSystem = {
 };
 ```
 
-默认情况下，这些颜色由 `backgroundColor`，`textColor` 和 `borderColor` 核心插件继承。
+By default, these colors are inherited by the `backgroundColor`, `textColor` and `borderColor` core plugins.
 
-想了解更多，可以查看：[Customizing Colors](https://tailwindcss.com/docs/customizing-colors)。
+To learn more, you can check out: [Customizing Colors](https://tailwindcss.com/docs/customizing-colors).
 
 ## Spacing
 
-使用 `space` 属性，可以自定义项目的全局间距和缩放比例：
+The global spacing and scaling of items can be customized using the `space` attribute: the
 
 ```js
 const designSystem = {
@@ -894,52 +907,53 @@ const designSystem = {
 };
 ```
 
-默认情况下，这些值由 `padding`，`margin`，`negativeMargin`，`width` 和 `height` 核心插件继承。
+By default, these values are inherited by the `padding`, `margin`, `negativeMargin`, `width` and `height` core plugins.
 
-想要了解更多，看 [Customizing Spacing](https://tailwindcss.com/docs/customizing-spacing)。
+To learn more, see [Customizing Spacing](https://tailwindcss.com/docs/customizing-spacing).
 
-## 核心插件
+## Core plugins
 
-主题部分的其余部分用于配置每个核心插件可用的值。
+The rest of the theme section is used to configure the values available for each core plugin.
 
-例如，`borderRadius` 属性可让您自定义将生成的圆角的 `utilities`：
+For example, the `borderRadius` property allows you to customize the ``utilities` that will generate the rounded corners.
 
-```js
+``js
 const designSystem = {
-  borderRadius: {
-    none: '0',
-    sm: '.125rem',
-    default: '.25rem',
-    lg: '.5rem',
-    full: '9999px',
-  },
+borderRadius: {
+none: '0',
+sm: '.125rem',
+default: '.25rem',
+lg: '.5rem',
+full: '9999px',
+},
 };
-```
 
-**属性名确定所生成类的后缀，值确定实际CSS声明的值。**
-上面的示例`borderRadius`配置将生成以下CSS类：
+````
+
+** The attribute name determines the suffix of the generated class, and the value determines the value of the actual CSS declaration. **
+The example ``borderRadius`` configuration above will generate the following CSS classes.
 
 ```css
 .rounded-none { border-radius: 0 }
-.rounded-sm   { border-radius: .125rem }
-.rounded      { border-radius: .25rem }
-.rounded-lg   { border-radius: .5rem }
+.rounded-sm { border-radius: .125rem }
+.rounded { border-radius: .25rem }
+.rounded-lg { border-radius: .5rem }
 .rounded-full { border-radius: 9999px }
-```
+````
 
-会注意到，在主题配置中使用 `default` 属性创建了不带后缀的 `rounded` 类。这是许多（尽管不是全部）核心插件支持的 Tailwind CSS 中的通用约定。
+You will notice that the `rounded` class is created without the suffix in the theme configuration using the `default` attribute. This is a common convention in Tailwind CSS supported by many (though not all) of the core plugins.
 
-要了解有关自定义特定核心插件的更多信息，请访问该插件的文档。
+To learn more about customizing a specific core plugin, please visit the documentation for that plugin.
 
-## 自定义默认配置
+## Customizing the default configuration
 
-开箱即用，您的项目将自动从默认主题配置继承值。如果想自定义默认主题，则根据目标有几种不同的选择。
+Out of the box, your project will automatically inherit values from the default theme configuration. If you want to customize the default theme, there are several different options depending on the goal.
 
-### 覆盖默认配置
+### Override the default configuration
 
-要覆盖默认配置中的选项，请在 `designSystem` 中添加要覆盖的属性：
+To override the options in the default configuration, add the properties to be overridden to `designSystem` at
 
-```ts modern.config.ts
+```js modern.config.ts
 import { defineConfig } from '@modern-js/module-tools';
 
 const designSystem = {
@@ -959,17 +973,17 @@ export default defineConfig({
 });
 ```
 
-这将完全替换默认属性配置，因此在上面的示例中，不会生成默认的 `opacity utilities`。
+This will completely replace the default property configuration, so in the above example, the default `opacity utilities` will not be generated.
 
-您未提供的任何属性都将从默认主题继承，因此在上面的示例中，将保留颜色，间距，边框圆角，背景位置等内容的默认主题配置。
+Any properties you do not provide will be inherited from the default theme, so in the example above, the default theme configuration for color, spacing, border rounding, background position, etc. will be retained.
 
-### 扩展默认配置
+### Extending the default configuration
 
-如果您想保留主题选项的默认值，但又要添加新值，请在 `designSystem.extend` 属性下添加扩展的内容。
+If you want to keep the default values of the theme options but add new values, add the extensions under the `designSystem.extend` property.
 
-例如，如果您想添加一个额外的断点但保留现有的断点，则可以扩展 `screens` 属性：
+For example, if you want to add an additional breakpoint but keep the existing one, you can extend the `screens` property with.
 
-```ts modern.config.ts
+```js modern.config.ts
 import { defineConfig } from '@modern-js/module-tools';
 
 const designSystem = {
@@ -986,9 +1000,9 @@ export default defineConfig({
 });
 ```
 
-您当然可以覆盖默认主题的某些部分，并在同一配置中扩展默认主题的其他部分：
+You can certainly override some parts of the default theme and extend other parts of the default theme in the same configuration: the
 
-```ts modern.config.ts
+```js modern.config.ts
 import { defineConfig } from '@modern-js/module-tools';
 
 const designSystem = {
@@ -1012,13 +1026,13 @@ export default defineConfig({
 });
 ```
 
-### 引用其他值
+### Referencing other values
 
-如果需要在配置中引用另一个值，可以通过提供闭包函数而不是静态值来实现。函数将收到 `theme()` 函数作为参数，您可以使用该函数使用点表示法在配置中查找其他值。
+If you need to reference another value in the configuration, you can do so by providing a closure function instead of a static value. The function will receive the `theme()` function as an argument, and you can use this function to find other values in the configuration using a dot representation.
 
-例如，您可以在 `fill` 配置上通过引用 `theme('colors')` 为调色板中的每种颜色生成 `fill` utilities。
+For example, you can generate `fill` utilities for each color in the palette by referring to `theme('colors')` on the `fill` configuration.
 
-```ts modern.config.ts
+```js modern.config.ts
 import { defineConfig } from '@modern-js/module-tools';
 
 const designSystem = {
@@ -1033,13 +1047,13 @@ export default defineConfig({
 });
 ```
 
-`theme()`函数尝试从已经完全合并的配置对象中找到您要查找的值，因此它可以引用您自己的自定义设置以及默认主题值。它也可以递归工作，因此只要链末尾有一个静态值，它就可以解析您要查找的值。
+The `theme()` function tries to find the value you are looking for from an already fully merged configuration object, so it can reference your own custom settings as well as the default theme value. It also works recursively, so as long as there is a static value at the end of the chain, it can resolve the value you are looking for.
 
-**引用默认配置**
+**Reference to the default configuration**
 
-如果出于任何原因想要引用默认配置中的值，则可以从 `tailwindcss/defaultTheme` 导入它。一个有用的示例是，如果要将添加默认配置提供的字体中某一个字体：
+If for any reason you want to reference a value in the default configuration, you can import it from `tailwindcss/defaultTheme`. A useful example would be to add one of the fonts provided by the default configuration to.
 
-```ts modern.config.ts
+```js modern.config.ts
 import { defineConfig } from '@modern-js/module-tools';
 
 const defaultTheme = require('tailwindcss/defaultTheme');
@@ -1047,7 +1061,7 @@ const defaultTheme = require('tailwindcss/defaultTheme');
 const designSystem = {
   extend: {
     fontFamily: {
-      sans: ['Lato', ...defaultTheme.fontFamily.sans],
+      sans: ['Lato', ... .defaultTheme.fontFamily.sans],
     },
   },
 };
@@ -1057,9 +1071,9 @@ export default defineConfig({
 });
 ```
 
-### 禁用整个核心插件
+### Disabling the entire core plugin
 
-如果您不想为某个核心插件生成任何类，则最好在 `corePlugins` 配置中将该插件设置为 `false`，而不是在配置中为该属性提供一个空对象：
+If you don't want to generate any classes for a core plugin, it's better to set the plugin to `false` in the `corePlugins` configuration, rather than providing an empty object for the property in the configuration: ``
 
 ```js
 // Don't assign an empty object in your theme configuration
@@ -1071,18 +1085,18 @@ const designSystem = {
 // Do disable the plugin in your corePlugins configuration
 const designSyttem = {
   corePlugins: {
-    opacity: false,
+    opacity: { false,
   },
 };
 ```
 
-最终结果是相同的，但是由于许多核心插件未公开任何配置，因此无论如何只能使用 corePlugins 禁用它们，最好保持一致。
+The end result is the same, but since many core plugins don't expose any configuration, it's best to keep it consistent by only disabling them with corePlugins anyway.
 
-### 添加自己的key
+### Adding your own key
 
-在很多情况下，将自己的属性添加到配置对象可能会很有用。
+In many cases it may be useful to add your own properties to the configuration object.
 
-其中一个示例是添加新属性为多个核心插件之间复用。例如，您可以提取一个 `positions`对象，`backgroundPosition` 和 `objectPosition` 插件都可以引用该对象：
+One example is to add new properties for multiplexing between multiple core plugins. For example, you can extract a `positions` object that both the `backgroundPosition` and `objectPosition` plugins can refer to.
 
 ```js
 const designSystem = {
@@ -1102,9 +1116,9 @@ const designSystem = {
 };
 ```
 
-另一个示例是在自定义插件中添加新的属性以进行引用。例如，如果您为项目编写了渐变插件，则可以向该插件引用的主题对象添加渐变属性：
+Another example is to add a new property to a custom plugin for referencing. For example, if you write a gradient plugin for your project, you can add a gradient property to the theme object referenced by that plugin.
 
-```ts modern.config.ts
+```js modern.config.ts
 import { defineConfig } from '@modern-js/module-tools';
 
 const designSystem = {
@@ -1120,28 +1134,17 @@ export default defineConfig({
   buildConfig: {
     style: {
       postcss: {
-        plugins: [require('./plugins/gradients')],
-      }
-    }
+        plugins: [require('. /plugins/gradients')],
+      },
+    },
   },
 });
 ```
 
-## 配置引用
-
-除了 `screens`，`colors` 和 `spacing` 外，配置对象中的所有属性都映射到 `Tailwind CSS` 的核心插件上。由于许多插件负责仅接受静态值集（例如，例如`float`）的CSS属性，因此请注意，并非每个插件在主题对象中都有对应的属性。
-
-所有这些属性也可以在 `designSystem.extend` 属性下使用，以扩展默认主题。
-
-关于所有属性的作用，可以查看此 [链接](https://tailwindcss.com/docs/theme#configuration-reference)。
-
-## 额外的配置
-
-除了与 Tailwind CSS Theme 相同的配置以外，还有 Modern.js 提供的额外的配置。
+## Configuration references
 
-### supportStyledComponents
+All properties in the configuration object, except `screens`, `colors` and `spacing`, are mapped to the core plugins of `Tailwind CSS`. Since many plugins are responsible for CSS properties that accept only static sets of values (e.g., e.g., `float`), please note that not every plugin has a corresponding property in the theme object.
 
-- type: `boolean`
-- default: `false`
+All of these properties can also be used under the `designSystem.extend` property to extend the default theme.
 
-值 `true` 时，运行时在应用外层提供 `styled-components` `ThemeProvider` 组件，并且将通过 `designSystem` 生成的 `Theme Token` 对象注入。
+For more information about what all the properties do, check out this [link](https://tailwindcss.com/docs/theme#configuration-reference).

package/docs/en/api/config/plugins.md

@@ -0,0 +1,18 @@
+---
+sidebar_position: 4
+---
+
+# Plugins
+
+This chapter describes the configuration of the registered module-tools plugin.
+
+- type: `Array<ModuleToolsPlugin>`
+
+```js modern.config.ts
+import { ExamplePlugin } from '. /plugins/example';
+export default defineConfig({
+  plugins: [ExamplePlugin()],
+});
+```
+
+For more information on how to write plugins, check out the [[Plugin Writing Guide]](/en/plugins/guide/getting-started).

package/docs/en/api/{test.md → config/testing.md}

@@ -1,29 +1,38 @@
+---
+sidebar_position: 5
+---
+
 # Testing
 
+This chapter describes the test-related configuration
 :::tips
 You need to enable the unit testing feature with `pnpm run new` first.
 :::
 
-
 ## jest
-* Type: `Object | Function`
-* Default value: `{}`
 
-The configuration corresponding to [Jest](https://jestjs.io/docs/configuration), when of type ``Object``, can be configured with all the underlying configurations supported by Jest .
+- Type: `Object | Function`
+- Default value: `{}`
+
+The configuration corresponding to [Jest](https://jestjs.io/docs/configuration), when of type `Object`, can be configured with all the underlying configurations supported by Jest .
+
+```js modern.config.ts
+import { defineConfig } from '@modern-js/module-tools';
 
-```js title=modern.config.js
 export default defineConfig({
   testing: {
     jest: {
-      testTimeout: 10000
-    }
-  }
+      testTimeout: 10000,
+    },
+  },
 });
 ```
 
-When the value is of type ``Function``, the default configuration is passed in as the first parameter and a new Jest configuration object needs to be returned.
+When the value is of type `Function`, the default configuration is passed as the first parameter and a new Jest configuration object needs to be returned.
+
+```js modern.config.ts
+import { defineConfig } from '@modern-js/module-tools';
 
-```js title=modern.config.js
 export default defineConfig({
   testing: {
     jest: options => {
@@ -38,8 +47,8 @@ export default defineConfig({
 
 ## transformer
 
-- Type: `'babel-jest' | 'ts-jest'`
-- Default value: `babel-jest`
+- type: `'babel-jest' | 'ts-jest'`
+- Default value: `'babel-jest'`
 
 Configure the compilation tool for the source code when executing tests: [babel-jest](https://www.npmjs.com/package/babel-jest) or [ts-jest](https://github.com/kulshekhar/ts-jest). The default is `babel-jest`.
 

package/docs/en/api/index.md

@@ -1,3 +1,5 @@
 ---
-pageType: 'api'
+overview: true
+sidebar_label: Overview
 ---
+# Overview

package/docs/en/api/plugin-api/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Plugin API",
+  "collapsed": false
+}