11

1

---

unplugin-replace

🍣 一个通用的打包插件，基于 @rollup/plugin-replace 替换文件中的目标字符串。

安装

# npm
npm i -D unplugin-replace

# jsr
npx jsr add -D @unplugin/replace

Vite

// vite.config.ts
import Replace from 'unplugin-replace/vite'

export default defineConfig({
  plugins: [Replace()],
})

Rollup

// rollup.config.js
import Replace from 'unplugin-replace/rollup'

export default {
  plugins: [Replace()],
}

esbuild

// esbuild.config.js
import { build } from 'esbuild'

build({
  plugins: [require('unplugin-replace/esbuild')()],
})

Webpack

// webpack.config.js
module.exports = {
  /* ... */
  plugins: [require('unplugin-replace/webpack')()],
}

使用

选项

有关所有选项的信息，请参阅 docs。

该插件接受所有 @rollup/plugin-replace 选项，以及一些特定于该插件的额外选项。

options.values

• 类型: { [find: string]: Replacement } | ReplaceItem[]
• 默认值: []

type ReplaceItem = {
  /** 提供一个字符串或正则表达式来查找您要寻找的内容。 */
  find: string | RegExp

  /**
   * 可以是字符串或函数。
   * - 如果是字符串，它将替换与模式匹配的子字符串。支持多种特殊替换模式
   * - 如果是函数，它将在每次匹配时被调用，其返回值将被用作替换文本。
   */
  replacement: Replacement
}
type Replacement = string | ((id: string, match: RegExpExecArray) => string)

与 @rollup/plugin-replace 相比，find 选项支持正则表达式模式。

示例:

Replace({
  values: [
    {
      find: /apples/gi,
      replacement: 'oranges',
    },
    {
      find: 'process.env.NODE_ENV',
      replacement: '"production"',
    },
  ],
})

赞助商

许可证

MIT 许可证 © 2024-PRESENT 三咲智子