Taro Mate
这是一个用于快速生成 Taro 页面和组件的 VS Code 插件。它能够自动检测项目配置,支持生成 React/Vue 模板,并自动处理路由注册。
✨ 主要功能
生成页面
- 支持在 主包 或 分包 中创建页面。
- 自动读取
app.config.ts 中的分包配置供用户选择。
- 自动注册路由:创建页面后,会自动将路径添加到
app.config.ts 对应的 pages 列表中。
- 支持 CSS Modules。
生成组件
- 快速生成组件模版。
- 强制组件命名规范为 大驼峰 (PascalCase)。
智能配置
- 自动识别当前项目的技术栈(React/Vue)、语言(TypeScript/JavaScript)、CSS 预处理器(Sass/Less/Stylus)以及是否启用 CSS Modules。
- 支持在生成时临时修改配置。
🚀 使用方法
1. 生成页面
- 在文件资源管理器中右键点击目标目录,选择 "Taro: 生成页面"(或者使用命令面板
Cmd+Shift+P 输入 Taro: 生成页面)。
- 输入页面名称(支持
kebab-case 或 camelCase,例如 user-detail 或 userDetail)。
- 选择创建位置:
- 插件会列出主包和
app.config.ts 中配置的所有分包。
- 选择 主包:页面将创建在
src/pages/ 下。
- 选择 分包:页面将创建在
src/<分包根目录>/pages/ 下。
- 插件会自动生成页面文件(
index.tsx, index.module.scss, index.config.ts 等),并在 app.config.ts 中自动注册路由。
2. 生成组件
- 在文件资源管理器中右键点击目标目录,选择 "Taro: 生成组件"。
- 输入组件名称。
- 注意:组件名称必须使用 大驼峰格式 (PascalCase),例如
MyCustomButton。
- 插件会生成组件文件(
index.tsx, index.module.scss 等)。
⚙️ 路由与分包支持
插件能够智能解析 src/app.config.ts 文件:
- 主包页面:自动插入到
pages 数组中。
- 分包页面:
- 自动识别
subPackages 配置。
- 支持没有
name 属性的分包(默认使用 root 作为标识)。
- 创建页面时,会自动将文件放置在分包下的
pages 目录中(例如 src/packageA/pages/demo/index),并将路由注册为 pages/demo/index(相对于分包根目录)。
📝 命名规范
- 页面:推荐使用短横线命名(
user-list)或小驼峰命名(userList)。
- 组件:强制使用大驼峰命名(
UserList),以符合 React/Taro 组件命名最佳实践。
🛠 开发与调试
如果你想本地调试本插件:
- 克隆源码。
- 运行
npm install 安装依赖。
- 按
F5 启动调试窗口。
- 在调试窗口中打开一个 Taro 项目进行测试。
| |