VSCode怎么快速生成Vue3的script setup模板代码片段

浅枫大大_3201

浅枫大大_3201

2026-04-04

620人浏览

原创

在 vscode 中定义 vue3-setup 代码片段需手动创建或编辑用户级 snippets/vue.json 文件,填入标准 json 格式片段,前缀为 vue3-setup,内容含 script setup(ts)、template 和 style;注意语言模式设为 vue、光标位置正确、启用 volar 插件。

vscode怎么快速生成vue3的script setup模板代码片段

怎么在 VSCode 里定义一个 vue3-setup 代码片段

VSCode 原生不带 Vue3 的 setup 模板,得自己配 snippets。关键不是装插件,而是改用户级或工作区级的 vue.json 片段文件。

路径一般是:~/Library/Application Support/Code/User/snippets/vue.json(macOS)、%APPDATA%\Code\User\snippets\vue.json(Windows)或 ~/.config/Code/User/snippets/vue.json(Linux)。如果 vue.json 不存在,就新建一个空 JSON 文件。

内容直接写成标准 JSON 格式,注意不能有 trailing comma,否则 VSCode 会静默忽略整个文件:

{
  "Vue3 Script Setup": {
    "prefix": "vue3-setup",
    "body": [
      "<script setup lang='\"ts\"'>",
      "import { ref, reactive, onMounted } from 'vue'",
      "",
      "const props = defineProps<{",
      "  msg?: string",
      "}>()",
      "",
      "const emit = defineEmits<{",
      "  (e: 'update:modelValue', value: string): void",
      "}>()",
      "",
      "const count = ref(0)",
      "const state = reactive({",
      "  name: ''",
      "})",
      "",
      "onMounted(() => {",
      "  console.log('mounted')",
      "})",
      "</script>",
      "",
      "<template>",
      "  <div>{{ msg }}</div>",
      "</template>",
      "",
      "<style scoped>",
      "</style>"
    ],
    "description": "Vue3 script setup template with TS and common APIs"
  }
}

为什么用 lang="ts" 而不是默认 JS

现在新项目基本都开 TS,如果片段里写 lang="js",后续还得手动删改,反而拖慢节奏。直接按 TS 写,类型提示、defineProps 和 defineEmits 的泛型写法也更规范。

如果你真用纯 JS,把 lang="ts" 改成 lang="js",同时删掉所有泛型(比如 defineProps() → defineProps({ ... })),但要注意:JS 下 defineProps 不支持解构,也不能用类型断言,容易误写。

vue3-ant-design-vue-component-skill
vue3-ant-design-vue-component-skill

封装基于 Vue 3 + Ant Design Vue 的通用业务组件,提供标准化模板与最佳实践。

下载
  • defineProps 在 JS 中必须传对象字面量,不能是变量或函数调用
  • defineEmits 在 JS 中只接受字符串数组,不支持事件签名对象写法
  • Volar 插件对 JS 的类型推导弱很多,props.msg 可能报 undefined 风险

输入 vue3-setup 后没触发?常见卡点

不是所有 .vue 文件都会自动激活这个片段——VSCode 默认只在 script 标签内识别 vue 片段,但光标必须落在 <script setup></script> 标签内部(哪怕标签还没写),或者在空白 <script></script> 标签里且语言模式设为 vue。

检查这几处:

  • 右下角语言模式是不是 Vue(不是 HTML 或 JavaScript);如果不是,点一下切换
  • 确保光标在 <script> 开始标签之后、<code>></script> 之前,或在已有 <script setup></script> 标签内部
  • 片段前缀 vue3-setup 输入后要按 Tab 或回车,不能只输完就停住
  • 如果用了 Volar,确认它已启用(禁用 Vetur);Volar 才真正支持 setup 片段上下文

想加 Composition API 常用函数但又怕模板太重?

别一股脑全塞进去。模板越长,每次触发后要删的也越多,反而降低效率。建议按最小必要原则保留:

  • 必留:ref、reactive、onMounted —— 80% 场景够用
  • 按需加:computed、watch、useRouter 等,单独另建片段如 vue3-computed
  • 避免预设 axios 或 pinia 相关代码 —— 不是每个组件都用,且导入路径因项目而异

真实协作中,团队共用片段时,最易被忽略的是 defineProps 和 defineEmits 的泛型写法是否和项目 tsconfig.json 兼容。比如开了 strict: true 但没配 skipLibCheck: true,可能报 Cannot find name 'defineProps' —— 这时候不是片段错了,是 Volar 的 TS 服务没加载好,重启窗口或重装 Volar 更快。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode vue3

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2035

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2922

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

996

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

3299

7

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1618

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2424

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

5904

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

5189

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

6914

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程