@ribrewguy/nuxt-openfeature

@ribrewguy/nuxt-openfeature

Nuxt 4 OpenFeature module extracted from the application repo.

📖 Documentation: https://ribrewguy.github.io/nuxt-openfeature/

Install

pnpm add @ribrewguy/nuxt-openfeature

Usage

export default defineNuxtConfig({
  modules: ['@ribrewguy/nuxt-openfeature'],
  openFeature: {
    providers: [
      {
        type: 'flagsmith',
        options: {
          apiUrl: process.env.FLAGSMITH_URL,
          environmentKey: process.env.FLAGSMITH_ENVIRONMENT_KEY
        },
        providerOptions: {
          useFlagsmithDefaults: false
        }
      }
    ],
    publicFlags: {
      'beneficiaries-enabled': true
    }
  }
})

Release

• Create a release changeset: pnpm changeset
• Merge to main so changesets.yml opens/updates the release PR
• Merge the release PR — changesets.yml automatically tags vX.Y.Z and publishes to npm with provenance
• Ensure npm Trusted Publisher is configured for this repository pointing at .github/workflows/changesets.yml
• One-time maintainer setup details: REPOSITORY_SETUP.md

Commands

pnpm install                                                      # root deps
pnpm install --ignore-workspace --frozen-lockfile --dir docs       # docs deps (separate project)
pnpm prepare
pnpm dev
pnpm docs:dev
pnpm lint
pnpm docs:lint
pnpm typecheck
pnpm docs:typecheck
pnpm test
pnpm build
pnpm docs:build
pnpm changeset
pnpm version-packages
pnpm pack

Documentation

• Live site: https://ribrewguy.github.io/nuxt-openfeature/
• Source: docs/
• Local docs dev server: pnpm docs:dev
• Hosting: GitHub Pages, deployed automatically from main by .github/workflows/docs-pages.yml
• No third-party platform secrets required
• docs/ is a standalone pnpm project (not in the root workspace), so its dependencies are installed separately. See docs/README.md for details.

Git Hooks (Husky)

• pre-commit: runs pnpm secrets:scan, pnpm lint, and pnpm typecheck
• pre-push: runs pnpm secrets:scan:full and pnpm test