unplugin-config

该工具可生成Web应用程序的配置文件，并允许对全局变量进行定制化，无需重新打包即可外部修改。该工具的特点包括:

特点

• ✨ 生成Web应用程序的配置文件。
• 🔨 允许对全局变量进行定制化。
• 🌈 内置支持dotenv，可以解析以指定前缀开头的环境变量。
• 🚀 支持与Vite、Webpack、Rollup等打包工具集成。
• 🎉 支持按需生成配置文件。
• 🌟 兼容TypeScript。

安装

npm i unplugin-config

// vite.config.ts
import ConfigPlugin from "unplugin-config/vite";

export default defineConfig({
  plugins: [
    ConfigPlugin({ /* options */ }),
  ],
});

Example: playground/

// rollup.config.js
import ConfigPlugin from "unplugin-config/rollup";

export default {
  plugins: [
    ConfigPlugin({ /* options */ }),
  ],
};

// webpack.config.js
module.exports = {
  /* ... */
  plugins: [
    require("unplugin-config/webpack")({ /* options */ })
  ]
};

// nuxt.config.js
export default {
  buildModules: [
    ["unplugin-config/nuxt", { /* options */ }],
  ],
};

This module works for both Nuxt 2 and Nuxt Vite

// vue.config.js
module.exports = {
  configureWebpack: {
    plugins: [
      require("unplugin-config/webpack")({ /* options */ }),
    ],
  },
};

// esbuild.config.js
import { build } from "esbuild";
import ConfigPlugin from "unplugin-config/esbuild";

build({
  plugins: [ConfigPlugin()],
});

配置

Options 对象包含以下属性：

应用程序选项 (appName 和 baseDir)

• appName (字符串, 可选): 应用程序的名称。
• baseDir (字符串, 可选): 输出的基本目录。

配置文件选项 (configFile)

• generate (布尔值, 可选): 启用或禁用生成配置文件。默认为 true。
• fileName (字符串, 可选): 全局配置文件的名称。默认为 "config.js"。
• outputDir (字符串, 可选): 配置文件生成的目录。默认为 "./dist"。

HTML 注入选项 (htmlInjection)

• enable (布尔值, 可选): 启用或禁用将配置注入到 HTML 文件中。默认为 true。
• templates (字符串数组, 可选): 需要转换的模板文件的数组。
• position (字符串, 可选): 将配置脚本注入到 HTML 文件的位置。可能的值为 "head"、"body"、"head-prepend" 或 "body-prepend"。默认为 "head-prepend"。
• decodeEntities（布尔型，可选）：是否对注入的HTML代码进行HTML实体编码的解码。如果设置为 true，则注入的HTML代码中的HTML实体将被解码。默认值为 false。

环境变量选项 (envVariables)

• prefix (字符串, 可选): 用于配置中的环境变量的前缀。
• files (字符串数组, 可选): 从中加载环境变量的配置文件数组。

示例

const configurationOptions = {
  appName: "MyApp",
  baseDir: "/",
  configFile: {
    generate: true,
    fileName: "_app.config.js",
    outputDir: "dist",
  },
  htmlInjection: {
    enable: true,
    templates: ["index.html"],
    position: "head",
  },
  envVariables: {
    prefix: "VITE_GLOB_",
    files: [".env.production", ".env"],
  },
};

案例

kirklin/celeris-admin

License

MIT License © 2022-PRESENT Kirk Lin