首页 > 解决方案 > 使用 web-ext 进行不同的开发和构建配置

问题描述

我正在使用浏览器扩展项目,并希望background.js在开发期间和构建期间使用不同的 URL。我想这样做,而不必记住在开发和构建之间更改代码。对于服务器项目,我只需使用 dotenv/环境变量,但这不适用于有效运行客户端的扩展。

background.js我有一个fetch使用这个api_base_url(我们也开发 API);

...
const api_base_url = 'http://127.0.0.1:8000/v1/'
...

在我构建(web-ext build)之前,我必须手动将其设置为;

...
const api_base_url = 'http://a.domain.com/v1/'
...

理想情况下,它会是这样的;

...
const api_base_url = ENV['API_BASE_URL']
...

我会有一个.env本地开发者;

API_BASE_URL='http://127.0.0.1:8000/v1/'

.env.production(或.env.build)的;

API_BASE_URL='http://a.domain.com/v1/'

这也是manifest.json我需要将不同 URL 列入白名单的问题,permissions例如

"permissions": [
    "storage",
    "tabs",
    "https://a.domain.com/v1/*",
    "http://127.0.0.1:8000/v1/*"
  ]

这不是每个用户的运行时选项,因此browser.storage也不options.js是我们想要的。

标签: firefox-addon-webextensionsweb-ext

解决方案


我已经想通了,但基本的答案是添加 webpack 并用于dotenv-webpack入口文件,如. 这些插件会将出现的字符串替换为from 的值。background.jscopy-webpack-pluginmanifest.jsonprocess.env.YOUR_VARIABLE_NAMEprocess.env.YOUR_VARIABLE_NAME

这确实发生了,我花了几次尝试才理解它。

// .env
API_BASE_URL='http://127.0.0.1:8000/v1/'

// ./background.js
const api_base_url = process.env.API_BASE_URL

// manifest.json
"permissions": [
  "tabs",
  "process.env.API_BASE_URL*"
],

// webpack => ./dist/main.js
const api_base_url = 'http://127.0.0.1:8000/v1/'

// webpack => ./dist/manifest.json
"permissions": [
  "tabs",
  "http://127.0.0.1:8000/v1/*"
],

这是 webpack 配置;

// ./webpack.config.js
const CopyPlugin = require('copy-webpack-plugin')
const DotenvPlugin = require('dotenv-webpack')
module.exports = (env) => {
  const dotenvPath = __dirname + '/.env.' + env

  const replaceWithProcessEnv = (content) => {
    for (var key in require('dotenv').config({ path: dotenvPath }).parsed) {
      content = content.replace(new RegExp('process.env.' + key, 'g'), process.env[key])
    }
    return content
  }

  return {
    plugins: [
      new DotenvPlugin(
        {
          path: dotenvPath,
          safe: true
        }
      ),
      new CopyPlugin(
        [
          {
            from: 'src/manifest.json',
            transform(content) {
              return replaceWithProcessEnv(content.toString())
            }
          }
        ]
      )
    ]
  }
}

我在这里做了一个完整的工作示例; https://github.com/paulmwatson/web-ext-environments


推荐阅读