【亲测免费】 unplugin-vue2-script-setup 技术文档

安装指南

要使Vue 2项目支持<script setup>特性，您需要执行以下步骤：

首先，在您的项目中安装必要的依赖项：

npm install -D unplugin-vue2-script-setup @vue/composition-api

这会安装unplugin-vue2-script-setup插件以及Vue 2对Composition API的支持。

接下来，确保在应用的入口文件导入并使用@vue/composition-api：

import Vue from 'vue'
import VueCompositionAPI from '@vue/composition-api'

Vue.use(VueCompositionAPI)

项目使用说明

对不同构建工具的集成

Vite

编辑vite.config.ts，添加unplugin-vue2-script-setup到插件列表中：

import { defineConfig } from 'vite'
import { createVuePlugin as Vue2 } from 'vite-plugin-vue2'
import ScriptSetup from 'unplugin-vue2-script-setup/vite'

export default defineConfig({
  plugins: [
    Vue2(),
    ScriptSetup({ /* 可选配置 */ }),
  ],
})

Vue CLI

修改vue.config.js以包含unplugin-vue2-script-setup配置：

const ScriptSetup = require('unplugin-vue2-script-setup/webpack').default

module.exports = {
  configureWebpack: {
    plugins: [
      ScriptSetup({ /* 可选配置 */ }),
    ],
  },
  // 若使用TypeScript，还需调整对应配置...
}

Nuxt.js

对于Nuxt.js，如果您使用的是Nuxt Bridge，则无需额外配置，因为该桥接已内置了对这些新特性的支持。

示例与实践

项目提供了例如playground/和examples/vue-cli等示例目录，您可以参照这些示例快速了解如何在实际项目中应用。

API使用文档

此插件主要通过其配置选项进行定制，尽管其主要目标是透明地启用<script setup>语法，但某些高级使用可能涉及特定选项的设置，如refSugarTransform（实验性），可以通过如下方式开启：

ScriptSetup({
  reactivityTransform: true
})

并更新tsconfig.json以便支持对应的TypeScript特性：

{
  "compilerOptions": {
    "types": ["unplugin-vue2-script-setup/types", "unplugin-vue2-script-setup/ref-macros"]
  }
}

类型系统与IDE支持

推荐使用VS Code配合Volar插件以获得最佳的编辑体验。确保安装@vue/runtime-dom以支持Vue 2，并根据Volar的指示配置您的tsconfig.json以启用正确的类型信息和兼容性模式。

结语

虽然随着Vue 2.7的发布，原生支持了Composition API与<script setup>，使得对这个插件的需求减少，但对于仍在使用早期Vue 2版本的项目，或是希望维持向后兼容性的同时采用更现代的编码风格，unplugin-vue2-script-setup依然是一项宝贵的工具。遵循上述指南，您可以轻松地在Vue 2项目中引入这项提升开发效率的新特性。