@unmagic/vms 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 刘彪
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,152 @@
+# Vue Mini SFC
+
+基于 @vue-mini/core 的 Vue3 单文件组件构建工具，用于将 Vue SFC 编译为微信小程序代码。
+
+## 📚 文档组织结构
+
+项目文档已按功能划分整理到 `docs/` 文件夹下：
+
+### 📁 docs/implemented - 已实现的功能
+
+- `CACHE_STATISTICS_README.md` - 缓存统计系统使用指南
+- `CURRENT_SLOT_SOLUTION.md` - 当前插槽转译方案
+- `EVENT_PARAM_NAME_UNIFICATION.md` - 事件参数命名统一化
+- `INLINE_EVENT_HANDLER_README.md` - 内联事件处理器文档说明
+- `INLINE_EVENT_HANDLER_IMPLEMENTATION_GUIDE.md` - 内联事件处理器实现指南
+- `INLINE_EVENT_HANDLER_TEST_CASES.md` - 内联事件处理器测试用例
+- `P0_OPTIMIZATION_COMPLETED.md` - P0优化实施记录
+- `TEMPLATE_TRANSFORM_OPTIMIZATION_SUMMARY.md` - 模板转换优化总结
+- `TEST_SUMMARY.md` - 内联事件处理器测试总结
+
+### 📁 docs/planned - 未实现/计划中的功能
+
+- `INLINE_EVENT_HANDLER_IMPROVEMENTS.md` - 内联事件处理器改进计划
+- `INLINE_EVENT_HANDLER_REFACTORING.md` - 内联事件处理器重构建议
+- `PERFORMANCE_OPTIMIZATION.md` - 编译速度优化分析报告
+- `SCOPED_SLOT_SOLUTION.md` - 作用域插槽转译方案
+- `TEMPLATE_TRANSFORM_OPTIMIZATION_PLAN.md` - 模板转换优化计划
+- `TRANSFORMER_DEPENDENCY_SOLUTION.md` - 转换器依赖关系解决方案
+
+### 📁 docs/architecture - 架构和设计文档
+
+- `ARCHITECTURE.md` - 架构设计文档
+- `LOCAL_VAR_CONFLICT_HANDLING.md` - 局部变量冲突处理方案
+
+## 功能特性
+
+- 将 Vue 3 单文件组件（SFC）编译为微信小程序代码
+- 支持模板中的函数表达式
+- 收集响应式变量和函数，并注入到 setup 函数的返回值中
+- 支持 class 和 style 的响应式绑定
+- 支持具名插槽和作用域插槽
+
+## 已知限制
+
+### WXS 环境兼容性
+
+VMS 生成的 WXS 代码运行在微信小程序的 WXS 环境中，该环境有以下限制：
+
+- **不支持 `?.` 可选链**：VMS 编译器会自动降级为条件表达式，无需手动处理
+- **不支持 `void 0`**：编译器自动替换为 `undefined`
+- **不支持 `$` 标识符**：编译器自动替换为 `_`
+- **不支持箭头函数、模板字符串**：编译器自动降级
+
+### 首次渲染与 undefined
+
+`@vue-mini/core` 框架在组件初始化时，部分响应式变量可能为 `undefined`。如果模板中使用了这些变量参与 WXS 计算（如 `:class`、`:style`、`v-if`），建议：
+
+- 在 `setup` 中为变量设置合理的初始值
+- 或在模板表达式中使用 `?.` 可选链（编译器会自动降级为安全的形式）
+
+```vue
+<!-- 推荐：使用可选链，编译后不会因 undefined 报错 -->
+<div :class="{ active: user?.isAdmin }">
+
+<!-- 不推荐：user 为 undefined 时 WXS 会抛出 TypeError -->
+<div :class="{ active: user.isAdmin }">
+```
+
+## 安装
+
+```bash
+npm install vue-mini-sfc
+```
+
+## 使用方式
+
+### 作为 CLI 工具使用
+
+```bash
+vms
+```
+
+### 配置
+
+工具支持多种配置文件格式：`vms.config.js`、`vms.config.ts` 或 `vms.config.json`。
+
+配置选项包括：
+
+```javascript
+module.exports = {
+  // 源代码目录，默认为 'example'
+  sourceDir: 'example',
+
+  // 输出目录，默认为 'dist'
+  outputDir: 'dist',
+
+  // 路径别名配置
+  alias: {
+    // 设置 @/ 路径对应的目录，默认为 './example'
+    // 如果你的源代码在 src 目录，可以设置为 './src'
+    '@': './example',
+  },
+}
+```
+
+### 项目结构示例
+
+```
+project/
+├── example/           # 源代码目录
+│   ├── app.json
+│   └── pages/
+├── dist/              # 编译输出目录
+└── vms.config.js      # 配置文件（可选）
+```
+
+## 开发
+
+```bash
+# 开发模式
+npm run dev
+
+# 构建
+npm run build
+
+# 代码格式化
+npm run lint
+
+# 链接全局命令，方便测试
+npm run link
+```
+
+在 example 目录中运行以下命令测试本地构建工具：
+
+```bash
+# 进入example目录
+cd example
+
+# 开发模式运行
+npm run dev
+
+# 构建模式运行
+npm run build
+```
+
+### VS Code 配置
+
+项目已配置 VS Code 在保存文件时自动进行 ESLint 格式化。推荐安装以下扩展：
+
+- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+- [Volar](https://marketplace.visualstudio.com/items?itemName=vue.volar)

package/bin/index.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+import { program } from 'commander'
+import { createRequire } from 'module'
+import { runVMS } from '../dist/index.js'
+const require = createRequire(import.meta.url)
+const pkg = require('../package.json')
+
+program.version(pkg.version).description('VMS小程序构建工具')
+
+// 构建命令
+program
+  .command('build')
+  .description('构建项目')
+  .option('--upload', '是否上传代码', false)
+  .action((options) => {
+    runVMS({ ...options, mode: 'production' })
+  })
+
+// 开发服务器命令
+program
+  .command('dev')
+  .description('启动开发服务器')
+  .action(() => {
+    runVMS({ mode: 'development', upload: false })
+  })
+
+program.parse()