概述
实现了一个基于 Node.js 的自动化脚本工具,能够基于现有模板快速生成新的管理页面模块,包括列表页、新增/编辑弹窗、API 文件和路由配置。
核心功能
1. 页面生成
列表页面生成:基于
deptManage.vue模板生成新的列表页面- 支持搜索表单(包含输入框、下拉选择等)
- 支持表格列自定义配置
- 支持操作列自定义(详情、编辑、删除)
- 支持序号列和导出按钮的显示控制
新增/编辑弹窗生成:基于
deptManageAddorUpdate.vue模板生成弹窗页面- 自动替换 API 调用
- 自动替换字段名称
2. API 文件自动生成
- 智能路径处理:
- 如果 API 目录已存在(如
sys-manage),在目录下创建{folderName}.js文件 - 如果 API 目录不存在,创建新目录和
index.js文件
- 如果 API 目录已存在(如
- API 函数生成:自动生成查询、新增、更新、删除、导出等标准 CRUD 操作
3. 路由自动配置
- 自动在
routers-component.js中添加新路由 - 智能定位插入位置(在 sys-manage 相关路由附近)
- 自动处理换行,避免多余空行
4. 自定义配置选项
表格配置
- 序号列:可选择显示/隐藏(默认显示)
- 导出按钮:可选择显示/隐藏(默认显示)
- 表格列:
- 支持自定义列数和列名
- 自动映射列名为 prop(如:名称→name,科室→dept)
- 支持使用模板默认列配置
操作列配置
- 支持选择:详情(detail)、编辑(edit)、删除(delete)
- 可多选,用逗号分隔
搜索输入框配置
- 支持添加自定义输入框到搜索表单
- 可配置 label、prop、placeholder
- 自动添加到 searchFilter 数据对象中
5. 智能优化功能
API 导入路径自动调整
- 根据 API 文件生成规则自动设置正确的导入路径
- 支持两种 API 文件结构:
@/api/sys-manage/testManage(目录存在时)@/api/testManage(目录不存在时)
自动修复功能
- 修复
from关键字缺失:自动检测并修复缺少from的导入语句 - 禁用首次 API 调用:自动注释
init()方法中的fetchTableData(),避免 API 未部署时的 404 错误 - 优化缩进:自动修复操作列和 searchFilter 字段的缩进问题
- 优化换行:路由插入时自动处理多余空行
技术实现
文件结构
scripts/
├── generate-manage-page.js # 主生成脚本
└── README.md # 使用说明文档
核心函数
generateListPage(config):生成列表页面
- 模板替换
- 操作列生成
- 表格列生成
- 搜索表单处理
- 缩进和格式优化
generateAddOrUpdatePage(config):生成新增/编辑弹窗
- 模板替换
- API 路径修复
generateApiFile(config):生成 API 文件
- 目录检查与创建
- API 函数模板生成
updateRouter(config):更新路由文件
- 路由插入位置查找
- 换行处理
模板替换机制
- 使用正则表达式进行精确替换
- 支持多种命名格式转换(camelCase、PascalCase、kebab-case)
- 自动转义特殊字符,确保正则匹配正确
使用流程
- 运行脚本:
npm run generate:page - 输入配置信息:
- 文件夹名称
- 页面标题
- 目标目录路径
- API 目录路径
- 搜索输入框配置(可选)
- 表格配置(序号列、导出按钮、自定义列)
- 操作列配置
- 确认生成:脚本自动生成所有文件并更新路由
生成的文件
视图文件:
src/views/{targetDirPath}/{folderName}/{fileName}.vue(列表页)src/views/{targetDirPath}/{folderName}/{fileName}AddorUpdate.vue(弹窗页)
API 文件:
src/api/{apiDirPath}/{folderName}.js(目录存在时)src/api/{apiDirPath}/index.js(目录不存在时)
路由更新:
src/router/modules/routers-component.js(自动添加新路由)
最佳实践
首次生成后:
- 检查生成的代码,根据实际需求调整
- API 部署后,取消注释
init()方法中的fetchTableData()调用 - 根据实际后端接口调整 API 路径和参数
自定义配置:
- 表格列建议使用有意义的列名,便于自动映射
- 操作列根据实际权限需求选择
- 搜索输入框根据实际业务需求添加
代码维护:
- 模板文件更新后,重新生成的文件会自动继承新特性
- 建议定期检查生成的代码,确保符合项目规范
技术亮点
- 智能路径处理:根据目录存在情况自动选择不同的文件结构
- 自动修复机制:生成后自动修复常见问题(from 关键字、缩进、换行等)
- 灵活的配置选项:支持多种自定义配置,满足不同业务需求
- 模板化设计:基于现有模板,确保生成代码的一致性
注意事项
- 首次生成时,
init()方法中的fetchTableData()会被自动注释,避免 API 未部署时的错误 - API 导入路径会根据文件生成规则自动调整,无需手动修改
- 路由插入位置会自动查找合适的位置,保持代码整洁
- 生成的代码需要根据实际业务需求进行微调