How should Vue projects be packaged by environment?

This time I will show you how the Vue project should be packaged according to the environment. What are the precautions for Vue project packaging according to the environment. The following is a practical case, let's take a look.

In project development, our projects are generally divided into development version, test version, Pre version, and Prod version. The default environments of Vue-cli are only dev and prod. In the past, every time I wanted to release a test version or Pre version, I had to modify the API address in the source code and then package it, which was very troublesome. It would be perfect if it could be packaged according to different environments. I have collected a lot of information on the Internet, and now I can package the program according to the environment. As for how to do it, let’s stay and see.

Step 1: Installationcross-env

##Run the following command in the project directory to install cross-env, My IDE is webstorm. It needs to be run directly in the Terminal window in the IDE. It is also possible to locate the project root directory through the CMD of Windows or the Terminal of Linux and run the following command.

npm i --save-dev cross-env

Step 2: Modify the parameters in each environment

Add test.env.js and pre.env.js in the config/ directory. Modify the content in prod.env.js. The modified content is as follows:

'use strict'
module.exports = {
 NODE_ENV: '"production"',
 EVN_CONFIG:'"prod"',
 API_ROOT:'"/apis/v1"'
}

Study and modify the contents of the test.env.js and pre.env.js files respectively. The modified content is as follows:

'use strict'
module.exports = {
 NODE_ENV: '"testing"',
 EVN_CONFIG:'"test"',
 API_ROOT:'"/test/apis/train"'
}
'use strict'
module.exports = {
 NODE_ENV: '"presentation"',
 EVN_CONFIG:'"pre"',
 API_ROOT:'"/pre/apis/train"'
}

Modify the content of the dev.env.js file. The modified content is as follows. The dev environment is configured with a service proxy, and the api before API_ROOT is the configured proxy address.

module.exports = merge(prodEnv, {
 NODE_ENV: '"development"',
 VN_CONFIG: '"dev"',
 API_ROOT: '"api/apis/v1"'
})

Step 3: Modify the project package.json file

Personalize the scripts content in the package.json file and add new ones The parameters in the packaging process of several defined environments are consistent with the previous adjustments.

"scripts": {
  "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
  "start": "npm run dev",
  "build": "node build/build.js",
  "build:test": "cross-env NODE_ENV=production env_config=test node build/build.js",
  "build:pre": "cross-env NODE_ENV=production env_config=pre node build/build.js",
  "build:prod": "cross-env NODE_ENV=production env_config=prod node build/build.js"
 },

Here, it is best to set NODE_ENV to production, because only one judgment of production is made in utils.js, and personal testing will not affect the API parameters of each environment. ##Step 4: Modify config/index.js

Modify the build parameters in the config/index.js file. The parameters here will be used in build/webpackage.prod.conf.js

build:{
  // Template for index.html
  // 添加test pre prod 三处环境的配制
  prodEnv: require('./prod.env'),
  preEnv: require('./pre.env'),
  testEnv: require('./test.env'),
  //下面为原本的内容，不需要做任何个性
  index:path.resolve(dirname,'../dist/index.html'),

Step 5: Use the build environment parameters in webpackage.prod.conf.js

to build/webpackage.prod.conf.js file Modify and adjust the way env constants are generated.

// 个性env常量的定义
// const env = require('../config/prod.env')
const env = config.build[process.env.env_config+'Env']

Step 6: Adjust build/build.js

Delete the assignment of process.env.NODE_ENV, modify the definition of spinner, and adjust The following content is as follows:

'use strict'
require('./check-versions')()
// 注释掉的代码
// process.env.NODE_ENV = 'production'
const ora = require('ora')
const rm = require('rimraf')
const path = require('path')
const chalk = require('chalk')
const webpack = require('webpack')
const config = require('../config')
const webpackConfig = require('./webpack.prod.conf')
// 修改spinner的定义
// const spinner = ora('building for production...')
var spinner = ora('building for ' + process.env.NODE_ENV + ' of ' + process.env.env_config+ ' mode...' )
spinner.start()
//更多的其它内容，不需要做任何调整的内容 ...

Supplement:

##How vue2+webpack is packaged by environment

This year I had the opportunity to work on a vue2 single-page application project. I went through two environments from development to launch. I run npm run build in both the test environment and the official environment. The variables of these two environments are currently different. It feels a little troublesome to change the variables every time when packaging. Later, I referred to my colleagues. In their projects, they ran different commands according to the environment and obtained different packages. For example, the test environment npm run test, the formal environment npm run build.

Need to be configured in the file config/prod.env.js

const target = process.env.npm_lifecycle_event;
　　if (target == 'test') {
　　//测试
　　var obj = {
　　NODE_ENV: '"production"',
　　//post用当前域名
　　API_ROOT: '""',
　　//数据字典
　　API_ROOT_DICT:'"http://test.gw.fdc.com.cn"',
　　}
}else {
　　//线上
　　var obj = {
　　NODE_ENV: '"production"',
　　//post用当前域名
　　API_ROOT: '""',
　　//数据字典
　　API_ROOT_DICT:'"http://gw.fdc.com.cn"',
　　}
}
module.exports = obj;

npm provides an npm_lifecycle_event variable to return the name of the currently running script, such as pretest, test, posttest, etc. Therefore, you can use this variable to write code for different npm scripts commands in the same script file.

I believe you have mastered the method after reading the case in this article. For more exciting information, please pay attention to other related articles on the php Chinese website!

Recommended reading:

How to use slots/scoped slots in Vue

##Detailed explanation of the use of slot sockets in vue components

The above is the detailed content of How should Vue projects be packaged by environment?. For more information, please follow other related articles on the PHP Chinese website!