前言

Vue-Cli 允许我们在项目根目录创建.env.[mode]文件来设置一些打包编译的启动参数，通过执行脚本的时候加mode参数，指定不同环境需要加载的配置文件

形如： .env.prod

  1. NODE_ENV='production'
  2. VUE_APP_PATH='./'
  3. VUE_APP_RUNTIME='prod'

问题

怎么在 .env.prod 文件中添加注释呢？

分析

这要看vue是怎么解析 .env.prod 文件的

通过启动脚本参数 --mode prod，一路找到了处理 .env.prod 文件的逻辑，让我们一块看下

path：node_modules\@vue\cli-service\lib\Service.js

  1. const dotenv = require('dotenv');
  3. // ...
  5. loadEnv (mode) {
  6.     const logger = debug('vue:env')
  7.     const basePath = path.resolve(this.context, `.env${mode ? `.${mode}` : ``}`)
  8.     const localPath = `${basePath}.local`
  10.     const load = envPath => {
  11.       try {
  12.         const env = dotenv.config({ path: envPath, debug: process.env.DEBUG })
  13.         dotenvExpand(env)
  14.         logger(envPath, env)
  15.       } catch (err) {
  16.         // only ignore error if file is not found
  17.         if (err.toString().indexOf('ENOENT') < 0) {
  18.           error(err)
  19.         }
  20.       }
  21.     }
  23.     load(localPath)
  24.     load(basePath)
  26.     // by default, NODE_ENV and BABEL_ENV are set to "development" unless mode
  27.     // is production or test. However the value in .env files will take higher
  28.     // priority.
  29.     if (mode) {
  30.       // always set NODE_ENV during tests
  31.       // as that is necessary for tests to not be affected by each other
  32.       const shouldForceDefaultEnv = (
  33.         process.env.VUE_CLI_TEST &&
  34.         !process.env.VUE_CLI_TEST_TESTING_ENV
  35.       )
  36.       const defaultNodeEnv = (mode === 'production' || mode === 'test')
  37.         ? mode
  38.         : 'development'
  39.       if (shouldForceDefaultEnv || process.env.NODE_ENV == null) {
  40.         process.env.NODE_ENV = defaultNodeEnv
  41.       }
  42.       if (shouldForceDefaultEnv || process.env.BABEL_ENV == null) {
  43.         process.env.BABEL_ENV = defaultNodeEnv
  44.       }
  45.     }
  46.   }

从上面的代码，可以得知，vue使用dotenv解析.env.prod 文件，并将环境变量从 .env[mode] 文件中加载到 process.env 环境变量中

解决（dotenv）

dotenv插件已经被 Vue-Cli 集成了

GitHub地址

README.md 中有这么一段话：

  • “# marks the beginning of a comment (unless when the value is wrapped in quotes)”

这就是我们要找的，在.env.[mode] 文件中，可以使用 # 进行注释

使用测试

  1. path: .env.prod 参数配置
  1. NODE_ENV='production'
  2. # VUE_APP_PATH='/pc/'
  3. VUE_APP_PATH='./'
  4. VUE_APP_RUNTIME='prod'
  1. package.json 文件脚本命令配置--mode参数
  1. "scripts": {
  2.     "build": "vue-cli-service build --mode prod",
  3.   },
  1. 执行 npm run build 命令，输出如下：
  1. NODE_ENV=== production
  2. VUE_APP_PATH=== ./

本文到此为止，要想了解更多dotenv请自行探索，感谢观看😉