使用微生成器#

Modern.js Module 提供了微生成器工具，它可以为当前项目：

• 新增目录和文件
• 修改 package.json
• 执行命令

因此通过这些能力，微生成器可以为项目开启额外的特性功能。

可以通过 modern new 启动微生成器。目前 Modern.js Module 支持的微生成器功能有：

开发模块文档#

当我们想要为模块编写文档的时候，可以启用模块文档功能。会在项目目录下创建 docs 目录以及相关文件，在 package.json 中新增 "@modern-js/plugin-rspress" 依赖。 使用 modern dev 和 modern build --platform 来调试和构建你的文档站点。

import { moduleTools, defineConfig } from '@modern-js/module-tools';
import { modulePluginDoc } from '@modern-js/plugin-rspress';

export default defineConfig({
  plugins: [moduleTools(), modulePluginDoc()],
});

Test 测试#

当我们想要对一些模块进行测试的时候，可以启用测试功能。启动该功能后，会在项目目录下创建 tests 目录以及相关文件，在 package.json 中新增 "@modern-js/plugin-testing" 依赖。使用 modern test 来测试你的模块。

import { moduleTools, defineConfig } from '@modern-js/module-tools';
import { testingPlugin } from '@modern-js/plugin-testing';

export default defineConfig({
  plugins: [moduleTools(), testingPlugin()],
});

Storybook 调试#

当我们想要对组件或者普通模块进行调试的时候，可以启用 Storybook 调试功能。启动该功能后，会在项目目录下创建 stories 目录以及 .storybook 目录，在 package.json 中新增 "@modern-js/storybook" 依赖。使用 storybook dev 和 storybook build 来调试和构建。

Tailwind CSS 支持#

Tailwind CSS 是一个以 Utility Class 为基础的 CSS 框架和设计系统，可以快速地为组件添加常用样式，同时支持主题样式的灵活扩展。

如果你想要在项目使用 Tailwind CSS，可以参考 「使用 Tailwind CSS」。

Modern.js Runtime API 支持#

Modern.js 提供了 Runtime API 能力，这些 API 只能在 Modern.js 的应用项目环境中使用。如果你需要开发一个 Modern.js 应用环境中使用的组件，那么你可以开启该特性，微生成器会增加 "@modern-js/runtime"依赖。

另外，Storybook 调试工具也会通过检测项目的依赖确定项目是否需要使用 Runtime API，并且提供与 Modern.js 应用项目一样的 Runtime API 运行环境。

import { moduleTools, defineConfig } from '@modern-js/module-tools';
import runtime from '@modern-js/runtime/cli';

export default defineConfig({
  plugins: [moduleTools(), runtime()],
});