Doppler Nuxt 模块

由 💚 Hiyield制作

将您的 Doppler 密钥集成到您的 Nuxt 构建中，以在一个地方安全、同步地管理您的所有环境变量和密钥 🔒

功能

🚀 极简设置
🔐 安全

快速设置

将 nuxt-doppler 依赖项添加到您的项目中

# Using pnpm
pnpm add -D nuxt-doppler

# Using yarn
yarn add --dev nuxt-doppler

# Using npm
npm install --save-dev nuxt-doppler

将 nuxt-doppler 添加到 nuxt.config.ts 的 modules 部分

export default defineNuxtConfig({
  modules: ['nuxt-doppler']
})

配置 doppler 模块

export default defineNuxtConfig({
  modules: ['nuxt-doppler'],

  doppler: {
    // your Doppler service token
    serviceToken: process.env.DOPPLER_SERVICE_TOKEN,
    // your Doppler project name
    project: 'your-doppler-project',
    // your Doppler config name
    config: process.env.NODE_ENV === 'production' ? 'production' : 'development',
  }
})

添加到您的 nuxt.config.ts 中的 runtimeConfig。 runtimeConfig 中的任何键都将映射到您的 Doppler 密钥。在此处阅读有关 runtime config 的信息。

NUXT_PUBLIC_YOUR_VAR => runtimeConfig.public.yourVar.

export default defineNuxtConfig({
  runtimeConfig: {
    public: {
      yourVar: ''
    }
  },

  modules: ['nuxt-doppler'],

  doppler: {
    // your Doppler service token
    serviceToken: process.env.DOPPLER_SERVICE_TOKEN,
    // your Doppler project name
    project: 'your-doppler-project',
    // your Doppler config name
    config: process.env.NODE_ENV === 'production' ? 'production' : 'development',
  }
})

就是这样！您的密钥现在可以在 Nuxt 中使用了！✨

配置

`serviceToken`

string - 必需

这是您的 Doppler service token，用于 doppler 项目/配置。生成您的密钥。建议您使用环境变量来存储它。此环境变量仅在您的 nuxt 应用程序的构建过程中是必需的。它不应在运行时过程中。

`project`

string - 必需

这是您想要从中访问密钥的 doppler project 的名称。

`config`

string - 必需

这是您想要从中访问密钥的 doppler project 中的 doppler config 的名称。 Doppler 具有 project => config 层级结构。您可以在一个项目中拥有多个 config。这允许您为不同的环境设置不同的密钥。

通常，您会为本地开发 / 暂存 / 生产环境设置不同的 config。您可以使用任何方法来获取正确的 config 字符串，但是使用 process.env.NODE_ENV 是一种简单的方法，因为 Nuxt 会在生产构建中自动将其设置为 production。

doppler: {
  //...
  config: process.env.NODE_ENV === 'production' ? 'production' : 'development'
}

另一种方法是在您的构建过程中设置一个 ENV 环境变量。如果您有多个类似生产的环境，这将非常有用。

ENV=staging npm run build

doppler: {
  //...
  config: process.env.ENV
}

`enabled`

boolean - 默认值： true

只是启用/禁用模块。如果您想在特定环境中禁用模块，这将非常有用。默认为 true。

`only`

string[] - 可选

这是一个从 Doppler API 获取 Doppler 密钥的字符串数组。如果设置了此项，则只会获取这些密钥并将其映射到 runtimeConfig 对象。如果未设置此项，则将获取所有密钥，但只会映射可以映射到 runtimeConfig 对象的密钥。

`exclude`

string[] - 可选

这是一个 Doppler 密钥的字符串数组，用于排除映射到 runtimeConfig 对象。如果您只想使用某些 Doppler 密钥并像往常一样从 env vars 获取其余密钥，这将非常有用。

`debug`

boolean - 默认值： false

这将启用 debug 模式。这将记录从 Doppler API 获取的 Doppler 密钥。这对于调试很有用。

进一步阅读

此模块的工作方式是使用 Doppler API 和提供的 serviceToken 来获取给定 Doppler project/config 的密钥。然后，它会深度循环遍历您的 runtimeConfig 对象，并将任何获取的 Dopper 密钥映射到 runtime config 对象，将其设置为纯字符串。这与 Nuxt 在内部对您的 process env vars 所做的相同。

这一切都发生在构建时，这意味着您无需在运行时公开任何 env vars。

因为这一切都发生在构建时，所以您的构建过程/ci 将需要访问 Doppler serviceToken。建议您在构建时通过环境变量公开此服务令牌。例如，可以使用 github actions 中的 Action secrets 来完成此操作。这意味着您只需要在构建管道中公开和维护这一个密钥，其他一切都由 Doppler 管理。

runtimeConfig 在 Nuxt 中的工作方式是，nuxt 首先会查找与 runtimeConfig 键匹配的环境变量。如果找到，它将使用该变量。如果找不到，它将使用 runtimeConfig 对象中的默认值。

此模块在 Nuxt 完成此操作后运行。因此，它将优先于您设置的任何环境变量。

开发

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release