Vue 3 Snippets
一个为 Visual Studio Code 提供的 Vue 3 代码片段集合,支持 TypeScript、SCSS、Less 和 JSX/TSX 语法。
特性
提供常用 Vue 3 模式的代码片段,包括:
基础功能
<script setup> 组件结构
ref 响应式引用
reactive 响应式对象
computed 计算属性
watch 监听器
- 生命周期钩子(
onMounted 、onUpdated 、onUnmounted )
defineProps & defineEmits 组件通信
watchEffect 副作用监听
provide & inject 依赖注入
toRefs 响应式转换
语言支持
- ✅ JavaScript - 标准 Vue 3 语法
- ✅ TypeScript - 完整类型支持
- ✅ JSX/TSX - React 风格的模板语法
- ✅ SCSS - Sass 预处理器
- ✅ Less - Less 预处理器
使用方法
- 打开
.vue 、.js 、.ts 、.jsx 或 .tsx 文件
- 输入代码片段前缀(如
v3-setup )并按 Enter 或 Tab
可用代码片段
基础组件结构
前缀 |
描述 |
语言支持 |
v3-setup |
Vue 3 <script setup> 组件结构 |
JavaScript |
v3-setup-ts |
Vue 3 <script setup> 组件结构 |
TypeScript |
v3-setup-scss |
Vue 3 组件结构 |
JavaScript + SCSS |
v3-setup-less |
Vue 3 组件结构 |
JavaScript + Less |
v3-setup-ts-scss |
Vue 3 组件结构 |
TypeScript + SCSS |
响应式 API
前缀 |
描述 |
语言支持 |
v3-ref |
创建响应式引用 |
JavaScript |
v3-ref-ts |
创建带类型的响应式引用 |
TypeScript |
v3-reactive |
创建响应式对象 |
JavaScript |
v3-reactive-ts |
创建带接口的响应式对象 |
TypeScript |
v3-computed |
创建计算属性 |
JavaScript |
v3-computed-ts |
创建带类型的计算属性 |
TypeScript |
监听器
前缀 |
描述 |
语言支持 |
v3-watch |
监听响应式数据变化 |
JavaScript |
v3-watch-ts |
监听响应式数据变化 |
TypeScript |
v3-watchEffect |
立即执行并响应式重新运行函数 |
JavaScript |
组件通信
前缀 |
描述 |
语言支持 |
v3-props |
定义组件 props |
JavaScript |
v3-props-ts |
定义组件 props |
TypeScript |
v3-props-defaults-ts |
定义带默认值的组件 props |
TypeScript |
v3-emits |
定义组件事件 |
JavaScript |
v3-emits-ts |
定义组件事件 |
TypeScript |
依赖注入
前缀 |
描述 |
语言支持 |
v3-provide |
提供值给后代组件 |
JavaScript |
v3-provide-ts |
提供值给后代组件 |
TypeScript |
v3-inject |
注入祖先组件提供的值 |
JavaScript |
v3-inject-ts |
注入祖先组件提供的值 |
TypeScript |
生命周期钩子
前缀 |
描述 |
v3-onMounted |
组件挂载后执行 |
v3-onUpdated |
组件更新后执行 |
v3-onUnmounted |
组件卸载前执行 |
JSX/TSX 组件
前缀 |
描述 |
语言支持 |
v3-jsx |
Vue 3 JSX 组件结构 |
JavaScript |
v3-jsx-ts |
Vue 3 JSX 组件结构 |
TypeScript |
v3-tsx |
Vue 3 TSX 组件(带 props) |
TypeScript |
工具函数
前缀 |
描述 |
v3-toRefs |
将响应式对象转换为 refs 对象 |
代码示例
TypeScript 组件
<script setup lang="ts">
import { ref } from "vue";
const count = ref<number>(0);
</script>
<template>
<div>
<h1>Component</h1>
</div>
</template>
<style scoped></style>
SCSS 样式组件
<script setup>
import { ref } from "vue";
const count = ref(0);
</script>
<template>
<div>
<h1>Component</h1>
</div>
</template>
<style scoped lang="scss"></style>
JSX 组件
import { defineComponent } from "vue";
export default defineComponent({
name: "ComponentName",
setup() {
return (): JSX.Element => (
<div>
<h1>Hello JSX</h1>
</div>
);
},
});
安装方法
从 VS Code 扩展市场安装
- 打开 VS Code
- 按
Ctrl+Shift+X 打开扩展面板
- 搜索 "Vue 3 Snippets"
- 点击安装
手动安装
- 下载
.vsix 文件
- 在 VS Code 中按
Ctrl+Shift+P 打开命令面板
- 输入 "Extensions: Install from VSIX..."
- 选择下载的
.vsix 文件
开发测试
- 在 VS Code 中打开此
vue3-snippets 文件夹
- 按
F5 打开新的扩展开发主机窗口
- 在新窗口中创建
.vue 、.ts 、.tsx 或 .jsx 文件
- 输入代码片段前缀(如
v3-setup ),应该会看到代码片段建议
支持的文件类型
此扩展在以下文件类型中激活:
.vue - Vue 单文件组件
.js - JavaScript 文件
.ts - TypeScript 文件
.jsx - JSX 文件
.tsx - TSX 文件
更新日志
v0.0.1
- ✅ 初始版本发布
- ✅ 支持基础 Vue 3 Composition API 代码片段
- ✅ 新增 TypeScript 支持
- ✅ 新增 SCSS/Less 预处理器支持
- ✅ 新增 JSX/TSX 组件支持
- ✅ 完整的类型定义和接口支持
贡献指南
欢迎提交 Issue 和 Pull Request!
开发环境设置
# 克隆仓库
git clone <repository-url>
cd vue3-snippets
# 安装依赖
npm install
# 开发测试
code .
# 按 F5 启动扩展开发主机
添加新的代码片段
- 编辑
snippets/vue.json 文件
- 按照现有格式添加新的代码片段
- 更新 README.md 文档
- 测试新的代码片段
打包和发布
1. 安装 vsce
npm install -g vsce
2. 打包扩展
vsce package
3. 发布到市场
vsce publish
许可证
MIT License
反馈和支持
如果您遇到任何问题或有功能建议,请:
享受编码! 🚀
| |