Skip to content

代码文件自动生成

INFO

该功能基于 plop 实现,在扩展新的模式前,请先详细阅读 plop 官方文档。

开发过程中,避免不了手动去频繁创建页面、组件等文件,并且还要在文件里写一些必要的代码,是不是觉得很麻烦?现在你可以用更简洁的方式来处理这一切。

框架默认提供了 5 种模式,通过 pnpm run new 指令可以自行选择。

  • page 页面文件
  • component 组件文件
  • store pinia 全局状态文件
  • mock mock 文件
  • module 页面模块文件

除了框架提供的 5 种模式,你还可以自定义新的模式,其原理就是通过预设模板,按照特定规则创建文件或者文件夹。

预设模板文件存放在 /plop-templates/ 目录下,并在 /plopfile.js 文件里进行引用,你可以参考现有 5 种模式的目录结构进行创建新的模板。

page

page 模式下,只能在 /src/views/ 目录下选择指定的文件夹进行生成,生成的文件中,部分关键位置会被替换掉,例如 <page-header /> 中的 title 会按照你输入的中文名称替换,页面的 name 会根据当前文件目录和文件名自动生成,确保唯一。

component

component 模式可以选择生成的是公共组件还是局部组件,公共组件生成目录为 /src/components/ ,局部组件则在 /src/views/ 目录下选择指定的文件夹进行生成。

store

store 模式则会在 /src/store/modules/ 目录下生成一个空模板

mock

mock 模式则会在 /src/mock/ 目录下生成一个标准 CURD 的 mock 数据

module

module 模式是一个标准模块模板,会在指定目录下生成模块文件夹,并且包含列表页、编辑(详情)页,以及相关局部组件。

这块部分详细介绍请阅读《标准模块》。