🚀 AMIX 开发插件 (AMIX SNIPPET)
专为前端开发者打造的高效代码生成与 API 管理工具。
通过可视化的命令面板,一键生成标准化的模块、页面、组件、路由及请求代码,同时提供强大的 API 场景化管理能力,大幅减少重复劳动,让开发更专注业务逻辑。
✨ 核心功能概览
本插件基于思维导图规划,主要包含两大核心模块:新建场景 与 API 应用场景。
1️⃣ 新建场景 (Scaffolding)
快速构建项目基础结构,支持多种复杂业务场景的模板生成:
基础页面生成
- 📝 新建列表页 (DataTable)
- 📝 新建表单页 (DetailInfo)
- 📝 新建流程审批页 (XxxProcessor)
- 📝 新建目录树 (TreeDetail): 支持层级结构数据处理
- 📝 新建多页签 (Tabs)
- 📝 新建步骤条 (Steps)
高级文件与逻辑构建
- 📂 新建列表+新增弹框 (DataTable+openModal)
- 📂 左右联动列表: 处理级联选择逻辑
- 📂 上下联动列表: 处理级联选择逻辑
- 📂 多信息块
2️⃣ API 应用场景 (API Management)
对后端接口进行封装、管理与可视化调用,覆盖从请求到展示的全流程:
🔌 基础网络请求
- 上下文操作: 打开命名空间、Tab 页、二次确认框、刷新当前页
- 请求方法封装:
Get 请求
Post 请求
Download 下载
- 反馈机制: 成功提示、失败提示、警告提示
🧩 组件绑定与交互
- 列表类: 列表组件、可编辑列表组件、信息流组件
- 表单类: 表单组件、自定义校验组件
🛠️ 列表高级配置
- 操作列配置: 新增、修改、删除、批量删除
- 显示控制: 设置行内按钮、列固定、列隐藏、列排序
- 分页与状态: 设置分页大小、是否显示序号、是否支持多选
- 数据校验: 字段必填校验、默认值设置、不可变值锁定
📥 导入导出与扩展
- 文件操作: Excel 导入/导出、JSON 数据交互
- 自定义扩展: 自定义渲染函数、调用外部 API
📦 安装方式
方法一:VS Code 市场安装 (推荐)
- 打开 VS Code,点击左侧扩展图标 (或按
Ctrl+Shift+X)。
- 搜索
AMIX 或 AMIX-SNPPIET。
- 点击 Install 安装。
方法二:手动安装 (.vsix)
如果你下载了 .vsix 安装包:
- 打开 VS Code。
- 按
Ctrl+Shift+P (Mac: Cmd+Shift+P) 打开命令面板。
- 输入
Extensions: Install from VSIX... 并回车。
- 选择下载的
.vsix 文件即可。
🎯 快速开始
第一步:打开命令面板
在任意项目中,按下快捷键:
- Windows/Linux:
Ctrl + Alt + P
- Mac:
Cmd + Alt + P
第二步:输入指令
输入 AMIX 查看所有可用命令,或直接输入具体功能关键词,例如:
AMIX: 新建列表
AMIX: 创建 Get 请求
AMIX: 设置列表分页
第三步:选择与生成
- 选择对应的功能命令。
- 根据提示输入文件名或选择目标目录。
- 插件将自动在当前工作区生成标准化的代码文件。
📁 项目结构说明
为了插件正常运行,请确保以下文件结构完整(特别是 images 和 templates 文件夹):
amix-snippet/
├── images/
│ └── AmixBuilder.png # ⚠️ 核心图标,切勿改名或删除
├── templates/ # 模板文件库 (由构建脚本自动复制)
│ ├── module/
│ ├── pages/
│ ├── components/
│ └── ...
├── dist/ # 编译后的代码 (运行 npm run package 生成)
├── src/
│ ├── extension.ts # 入口文件
│ └── ...
├── package.json # 插件配置
└── README.md # 本说明文档
| |