使用微生成器

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

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

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

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

开发模块文档

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

TIP

在成功开启后,会提示需要手动在配置中增加如下类似的代码。

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

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

Storybook 调试

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

Tailwind CSS 支持

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

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