Vue 开发者的外挂工具:配置一个 JSON,自动造出一整套页面!

🧰 引言:你是不是也这样?

作为一名前端开发者,你有没有经历过下面这些场景?

"又来一个新模块?好,先去 copy 个模板,改改名字......再写点基本结构......"
"这个组件结构每次都差不多,能不能别让我手敲了?"
"团队里每个人写的 Vue 文件格式都不一样,review 起来头大......"

如果你点头了,那这篇博客就是为你准备的!

今天我要分享的是我自己开发的一个 CLI 工具 ------ catalog_file_generator,它能让你:

  • ✅ 通过一个配置文件,一键生成 Vue 页面和组件;
  • ✅ 支持多种模板类型(Vue2、Vue3、script setup);
  • ✅ 自动创建多层级目录结构;
  • ✅ 统一项目风格,提升团队协作效率;

一句话总结:它是一个"造房子"的工具,你只管画设计图,它帮你盖楼。


🔨 它到底能干啥?

场景一:批量创建模块?一行命令搞定!

你想创建 abcd 这几个模块,每个模块下都有 index.vueedit.vue,甚至还有子目录 components

传统做法是:新建目录 ➜ 拷贝模板 ➜ 改名 ➜ 修改内容 ➜ 循环重复......

catalog_file_generator 的话,只需要一个配置文件:

css 复制代码
json
深色版本
{
  "a": {
    "index.vue": { "content": "a列表", "template": "v2" },
    "edit.vue": { "content": "a编辑", "template": "v2" }
  },
  "b": {
    "index.vue": { "content": "b列表", "template": "v2" },
    "edit.vue": { "content": "b编辑", "template": "v2" }
  },
  "c": {
    "index.vue": { "content": "c列表", "template": "v2" },
    "edit.vue": { "content": "c编辑", "template": "v2" },
    "info.vue": { "content": "c详情", "template": "v2" }
  },
  "d": {
    "components": {
      "tool.vue": { "content": "d工具组件", "template": "v2" }
    },
    "index.vue": { "content": "d列表", "template": "v2" }
  }
}

然后执行命令:

arduino 复制代码
cf-cli generate -c config.json -o src/views

Boom!目录结构瞬间就建好了!


场景二:统一代码风格?模板说了算!

团队协作中,最怕的就是风格不统一。有人喜欢用 <script setup>,有人偏爱 Vue2 的 Options API。

怎么办?用 catalog_file_generator,直接在配置里指定模板路径:

css 复制代码
json
深色版本
{
  "user": {
    "index.vue": {
      "content": "用户列表",
      "template": "/templates/vue3sTemp.vue"
    }
  }
}

所有生成的文件都使用同一个模板,风格一致,review 不头疼。


场景三:快速搭建 MVP?几分钟搞定几十个页面!

创业、内部孵化、临时需求......时间紧任务重?

用这个工具,几分钟就能搭出几十个页面结构,把精力留给真正重要的功能逻辑。


🚀 怎么安装和使用?

安装方式:

复制代码
npm install -g catalog_file_generator

安装完成后,输入:

bash 复制代码
cf-cli --help

你会看到如下命令:

vbnet 复制代码
Usage: cf-cli [options] [command]

Commands:
  module     交互式生成模块(支持不同文件选择不同模板 + 输入中文内容)
  generate   根据配置文件生成模块结构(支持 .js/.json)

Options:
  -V, --version  输出版本号
  -h, --help     显示帮助信息

🛠️ 命令详解

1. 交互式创建模块:cf-cli module

适用于临时新增模块,比如用户管理、订单页等。

示例命令:

sql 复制代码
cf-cli module -n user,order --files index,edit,detail -o src/views

参数说明:

参数 含义
-n, --name 模块名,多个用逗号分隔
--files 要生成的文件名列表,默认是 index
-o, --output 输出目录,默认是 ./dist

执行后会进入交互流程:

  1. 选择模板类型:Vue2 / Vue3 / script setup / 自定义路径;
  2. 输入中文描述 :自动替换模板中的占位符(如 #name#content);

2. 配置文件生成结构:cf-cli generate

适合一次性批量生成多个模块。

示例命令:

arduino 复制代码
cf-cli generate -c config.json -o src/modules

参数说明:

参数 含义
-c, --config 配置文件路径(支持 .json.js
-o, --output 输出目录,默认是 ./dist

📦 支持的模板类型一览

类型 示例 说明
内置模板 "v2" 使用工具自带的 Vue2 模板
绝对路径 "/templates/vue3sTemp.vue" 相对于项目根目录查找
相对路径 "../custom-templates/form.vue" 相对于当前模块目录查找

🧪 小试牛刀:试试看!

示例输出结构:

运行完命令后,会在 src/modules/ 下生成如下结构:

css 复制代码
深色版本
src/modules/
├── user/
│   ├── index.vue
│   ├── edit.vue
│   └── detail.vue
└── order/
    ├── index.vue
    ├── edit.vue
    └── detail.vue

每个 .vue 文件都会根据你选择的模板和内容自动填充内容,无需手动编写。


⚙️ 如何封装到自己的项目脚本中?

你可以封装一个 Node.js 脚本来调用这个 CLI,方便集成到你的项目中。

创建 scripts/cf-page.js

javascript 复制代码
#!/usr/bin/env node

const { spawn } = require('child_process');
const chalk = require('chalk');
const path = require('path');
const [name] = process.argv.slice(2);

if (!name) {
  console.error(chalk.red('❌ 请提供模块名称,例如:npm run cf:page UserPage'));
  process.exit(1);
}

const cliEntry = path.resolve(__dirname, '../node_modules/catalog_file_generator/cli.js');

const args = [
  'module',
  '-n', name,
  '--files', 'index',
  '-o', 'src/components'
];

const child = spawn('node', [cliEntry, ...args], { stdio: 'inherit' });

child.on('error', (err) => {
  console.error(chalk.red(`❌ 子进程启动失败:${err.message}`));
  process.exit(1);
});

child.on('close', (code) => {
  if (code === 0) {
    console.log(chalk.green(`✅ 模块【${name}】创建成功!`));
  } else {
    console.error(chalk.red(`❌ 创建失败,退出码:${code}`));
  }
});

package.json 中添加脚本:

json 复制代码
"scripts": {
  "cf:page": "node scripts/cf-page.js"
}

使用方式:

arduino 复制代码
npm run cf:page UserPage

🌟 总结:为什么你应该试试它?

功能 亮点
🧩 支持交互式创建模块 每个文件都能选模板、填内容
📄 支持配置文件驱动 一次生成多个模块,结构清晰可复用
🎨 多种模板类型可选 支持 Vue2/Vue3,也可自定义路径
📂 支持嵌套结构生成 灵活控制目录层级
🌈 带颜色的日志提示 提升用户体验,便于排查问题

🎉 结语:别让工具牵着你走,要让它为你服务!

catalog_file_generator 不只是一个脚手架工具,它更像是一位"代码建筑师",你只需要告诉它你要什么结构,剩下的交给它就行。

下次当你又要手写第 10 个 Vue 文件的时候,不妨试试这个工具,让你从重复劳动中解放出来,去做更有价值的事!


📌 GitHub 仓库链接?

👉 我已经打包发布到了 npm,你可以直接使用 npm install -g catalog_file_generator 安装。

📌 想扩展功能?

👉 欢迎 fork、PR、提 issue,我们一起打造更强大的前端代码生成器!


🎯 最后送大家一句话:

"程序员的价值不是写多少行代码,而是让代码尽可能少地写。"

用工具解放双手,才是真正的"高效编程"。


觉得有帮助的话,记得点个赞、收藏、转发哦~

💬 欢迎留言交流你日常开发中遇到的重复性工作,我们可以一起想办法自动化解决!

相关推荐
前端小趴菜051 小时前
React - createPortal
前端·vue.js·react.js
晓13131 小时前
JavaScript加强篇——第四章 日期对象与DOM节点(基础)
开发语言·前端·javascript
倔强青铜三2 小时前
苦练Python第18天:Python异常处理锦囊
人工智能·python·面试
倔强青铜三2 小时前
苦练Python第17天:你必须掌握的Python内置函数
人工智能·python·面试
烛阴2 小时前
JavaScript函数参数完全指南:从基础到高级技巧,一网打尽!
前端·javascript
军军君012 小时前
基于Springboot+UniApp+Ai实现模拟面试小工具四:后端项目基础框架搭建下
spring boot·spring·面试·elementui·typescript·uni-app·mybatis
chao_7893 小时前
frame 与新窗口切换操作【selenium 】
前端·javascript·css·selenium·测试工具·自动化·html
天蓝色的鱼鱼3 小时前
从零实现浏览器摄像头控制与视频录制:基于原生 JavaScript 的完整指南
前端·javascript
三原4 小时前
7000块帮朋友做了2个小程序加一个后台管理系统,值不值?
前端·vue.js·微信小程序
白仑色4 小时前
完整 Spring Boot + Vue 登录系统
vue.js·spring boot·后端