Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

docs(bridge): add notes about feature flags #1634

Merged
merged 3 commits into from
Nov 2, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
update section
  • Loading branch information
pi0 committed Nov 2, 2021
commit adcf65ba4f294396a53b5c52c959fbfb551141a2
54 changes: 35 additions & 19 deletions docs/content/1.getting-started/3.bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,32 +196,48 @@ export default defineNuxtConfig({

## Feature Flags

The following shows the default feature flags for Nuxt Bridge
You can optionally disable some features from bridge or opt-in to less stable ones. In normal circumstances, it is always best to stick with defaults!

You can check [bridge/src/module.ts](https://github.com/nuxt/framework/blob/main/packages/bridge/src/module.ts) for latest defaults.

```ts [nuxt.config.js|ts]
import { defineNuxtConfig } from '@nuxt/bridge'

export default defineNuxtConfig({
bridge: {
// Nitro engine
nitro: true,
// Use Vite as the bundler
vite: false,
// createApp support
app: true,
// Composition API support
capi: true,
// Transpile modules
transpile: true,
// <script setup> support
scriptSetup: true,
// APIs auto importing
autoImports: true,
// Detect module incompatibility
constraints: true,
// Use Nuxt 3's meta module
meta: null,

// -- Opt-in features --

// Use Vite as the bundler instead of Webpack 4
// vite: true,

// -- Default features --

// Use legacy server instead of Nitro
// nitro: false,

// Disable nuxt 3 compatible `nuxtApp` interface
// app: false,

// Disable composition API support
// capi: false,

// Do not transpile modules
// transpile: false,

// Disable <script setup> support
// scriptSetup: false,

// Disable composables auto importing
// autoImports: false,

// Do not warn about module incompatibilities
// constraints: false,

// Disable Nuxt 3 compatible useMeta
// meta: false,
},

vite: {
// Config for Vite
}
Expand Down