⚠️ Vue CLI 处于维护模式!

对于新项目,现在建议使用 create-vue 来搭建基于 Vite 的项目。同时参考 Vue 3 工具指南 获取最新的推荐。

插件 API

版本

类型: string

加载插件的 @vue/cli-service 版本的版本字符串。

assertVersion

  • 参数

    • {integer | string} range - @vue/cli-service 需要满足的 semver 范围
  • 用法

    虽然 api.version 通常很有用,但有时只需声明你的版本。此 API 提供了一种简单的方法来实现这一点。

    如果提供的版本满足,则不会发生任何操作。否则,将抛出错误。

    注意:在大多数情况下,建议使用 package.json 中的 peerDependencies 字段

getCwd

  • 用法:返回当前工作目录

resolve

  • 参数

    • {string} path - 从项目根目录开始的相对路径
  • 返回值

    • {string} - 解析后的绝对路径
  • 用法:解析当前项目的路径

hasPlugin

  • 参数

    • {string} id - 插件 ID,可以省略 (@vue/|vue-|@scope/vue)-cli-plugin- 前缀
  • 返回值

    • {boolean}
  • 用法:检查项目是否具有给定 ID 的插件

registerCommand

  • 参数

    • {string} name
    • {object} [opts]
    {
      description: string,
      usage: string,
      options: { [string]: string }
    }
    
    • {function} fn
    (args: { [string]: string }, rawArgs: string[]) => ?Promise
    
  • 用法:注册一个命令,该命令将作为 vue-cli-service [name] 可用。

chainWebpack

  • 参数

    • {function} fn
  • 用法:注册一个函数,该函数将接收一个可链式 webpack 配置。此函数是惰性的,直到调用 resolveWebpackConfig 才会被调用。

configureWebpack

  • 参数

    • {object | function} fn
  • 用法:注册一个 webpack 配置对象,该对象将被合并到配置中,或者注册一个接收原始 webpack 配置的函数。该函数可以修改配置本身,也可以返回一个将被合并到 webpack 配置中的对象。

configureDevServer

  • 参数

    • {object | function} fn
  • 用法:注册一个开发服务器配置函数。它将接收开发服务器的 express app 实例。

resolveWebpackConfig

  • 参数

    • {ChainableWebpackConfig} [chainableConfig]
  • 返回值

    • {object} - 原始 webpack 配置
  • 用法:解析最终的原始 webpack 配置,该配置将被传递给 webpack。

resolveChainableWebpackConfig

  • 返回值

    • {ChainableWebpackConfig}
  • 用法:解析一个中间可链式 webpack 配置实例,可以在生成最终原始 webpack 配置之前进一步调整它。你可以多次调用此函数来生成基本 webpack 配置的不同分支。

参见 https://github.com/mozilla-neutrino/webpack-chain

genCacheConfig

  • 参数

    • id
    • partialIdentifier
    • configFiles
  • 返回值

    • {object}
    {
      cacheDirectory: string,
      cacheIdentifier: string }
    
  • 用法:从多个变量生成缓存标识符。