vite中如何根据不同环境配置打包规则?一个if语句即可搞定!

简介: 【8月更文挑战第1天】vite中如何根据不同环境配置打包规则

通过上一章节,我们知道了vite的默认配置文件是vite.config.js,最基础的配置文件是这样的:

export default {
  // 配置选项
};

也可以通过 --config 命令行选项指定一个配置文件:    vite --config my-config.js

vite运行在node环境,为什么vite.config.js可以书写成esmodule的形式?

vite在读取这个vite.config.js的时候会率先node去解析文件语法, 如果发现你是esmodule规范会直接将你的esmodule规范进行替换变成commonjs规范

配置语法提示

我们在撰写配置时,默认是没有可用配置提示的,这对我们很不友好!(下图的提示并不是vite的可选配置提示,是插件对js的通用提示)

  • webstorm有很好的语法补全功能,vscode没有
  • 如果使用vscode或者其他的编辑器, 则需要做一些特殊处理

我们可以通过一些特殊配置,获得代码补全功能。

defineConfig

加上defineConfig,会惊奇的发现,配置项居然有代码提示了,真香!

jsdoc 注释法

jsDoc是一个用于JavaScript的API文档生成器,官网:https://jsdoc.zcopy.site/

将配置写在viteConfig内并导出,然后再其上面写如下注释:

/** @type import("vite").UserConfig  */

环境模式配置

我们使用webpack时,基于不同的环境,可以设置不同的配置文件,如:webpack.dev.config、webpack.prod.config、webpack.base.config。

如果需要使用vite来基于不同环境设置不同配置,只需要导出这样一个函数:

export default defineConfig(({ command, mode, ssrBuild }) => {
  if (command === 'serve') {
    return {
      // dev 独有配置
    }
  } else {
    // command === 'build'
    return {
      // build 独有配置
    }
  }
})
  • 在开发环境下 command 的值为 serve
  • 生产环境下为 command 的值为 build

多配置集成的一种实现方式

同webapack配置一样,我们也可以定义多个配置文件,然后再vite.config.js中引入使用

import { defineConfig } from "vite";
import viteBaseConfig from "./vite.base.config";
import viteDevConfig from "./vite.dev.config";
import viteProdConfig from "./vite.prod.config";
export default defineConfig(({ command, mode, ssrBuild }) => {
  if (command === "serve") {
    return {
      // dev 独有配置
      ...viteBaseConfig,
      ...viteProdConfig
    };
  } else {
    // command === 'build'
    return {
      // build 独有配置
      ...viteBaseConfig,
      ...viteDevConfig
    };
  }
});

vite.base.config.js代码如下,其余类似。

import { defineConfig } from "vite";
export default defineConfig( {
  
});

当然,我们可以使用策略模式让代码变得更加高级

import { defineConfig } from "vite";
import viteBaseConfig from "./vite.base.config";
import viteDevConfig from "./vite.dev.config";
import viteProdConfig from "./vite.prod.config";
const envResolver = {
  // build: () => ({...viteBaseConfig,... viteProdConfig}) 这种方式也可以
  // Object.assign中的{}是为了防止viteBaseConfig被修改。
  build: () => Object.assign({}, viteBaseConfig, viteProdConfig),
  serve: () => Object.assign({}, viteBaseConfig, viteDevConfig),
};
export default defineConfig(({ command, mode, ssrBuild }) => {
  return envResolver[command]();
});

Object.assign()

Object.assign() 方法将所有可枚举属性从一个或多个源对象复制到目标对象,返回修改后的对象。

注意:该方法会修改源对象!

const target = { a: 1, b: 2 };
const source = { b: 4, c: 5 };
const returnedTarget = Object.assign(target, source);
console.log(target);
// expected output: Object { a: 1, b: 4, c: 5 }
console.log(returnedTarget === target);
// expected output: true

环境模式测试

我们在vite.config.js中根据不同环境写下提示信息

import { defineConfig } from "vite";
import viteBaseConfig from "./vite.base.config";
import viteDevConfig from "./vite.dev.config";
import viteProdConfig from "./vite.prod.config";
const envResolver = {
  build: () => {
    console.log("生产模式");
    Object.assign({}, viteBaseConfig, viteProdConfig)
  },
  serve: () => {
    console.log("开发模式");
    Object.assign({}, viteBaseConfig, viteDevConfig)
  },
};
export default defineConfig(({ command, mode, ssrBuild }) => {
  return envResolver[command]();
});

package.json中增加"build": "vite build"

"scripts":jsx {
    "test": "echo \"Error: no test specified\" && exit 1",
    "dev": "vite",
    "build": "vite build"
  },

命令行执行 npm run dev


命令行执行 npm run build

相关文章
|
JavaScript
vue3-在自定义hooks使用useRouter 报错问题
vue3-在自定义hooks使用useRouter 报错问题
2430 0
|
小程序
小程序踩坑:Setting data field "xxxx" to undefined is invalid.
小程序踩坑:Setting data field "xxxx" to undefined is invalid.
648 0
|
Linux 网络安全 Python
linux centos上安装python3.11.x详细完整教程
这篇文章提供了在CentOS系统上安装Python 3.11.x版本的详细步骤,包括下载、解压、安装依赖、编译配置、解决常见错误以及版本验证。
10909 3
linux centos上安装python3.11.x详细完整教程
|
数据可视化 JavaScript 前端开发
Plotly 的主要特点
Plotly 的主要特点
398 1
|
前端开发 测试技术 API
vite项目怎么build打包成不同环境的代码?从而适配不同环境api接口
vite项目怎么build打包成不同环境的代码?从而适配不同环境api接口
827 0
|
API
Vite 中环境变量的配置方法
【10月更文挑战第10天】 Vite 中环境变量的配置方法
1491 2
|
JavaScript 前端开发 API
vue3 v-md-editor markdown编辑器(VMdEditor)和预览组件(VMdPreview )的使用
本文介绍了如何在Vue 3项目中使用v-md-editor组件库来创建markdown编辑器和预览组件。文章提供了安装步骤、如何在main.js中进行全局配置、以及如何在页面中使用VMdEditor和VMdPreview组件的示例代码。此外,还提供了一个完整示例的链接,包括编辑器和预览组件的使用效果和代码。
vue3 v-md-editor markdown编辑器(VMdEditor)和预览组件(VMdPreview )的使用
|
JavaScript
vue3,使用watch监听props中的数据
【10月更文挑战第3天】
3988 2
|
移动开发 资源调度 JavaScript
Vue移动端网页(H5)预览pdf文件(pdfh5和vue-pdf)
这篇文章介绍了在Vue移动端网页中使用`pdfh5`和`vue-pdf`两个插件来实现PDF文件的预览,包括滚动查看、缩放、添加水印、分页加载、跳转指定页数等功能。
9895 1
Vue移动端网页(H5)预览pdf文件(pdfh5和vue-pdf)