ESLint Integration

The module includes an ESLint plugin that warns when using useRuntimeConfig() instead of the type-safe useSafeRuntimeConfig().

With @nuxt/eslint (Automatic)

If you use @nuxt/eslint, the rule is auto-registered. No configuration needed.

npx nuxi module add @nuxt/eslint

The rule works immediately.

Manual Setup

Add to your eslint.config.mjs:

Using Recommended Config

import { configs } from 'nuxt-safe-runtime-config/eslint'

export default [
  configs.recommended,
  // ... your other configs
]

Manual Configuration

import plugin from 'nuxt-safe-runtime-config/eslint'

export default [
  {
    plugins: { 'safe-runtime-config': plugin },
    rules: { 'safe-runtime-config/prefer-safe-runtime-config': 'warn' },
  },
]

Rule: prefer-safe-runtime-config

Warns when using useRuntimeConfig() and suggests useSafeRuntimeConfig().

Incorrect

const config = useRuntimeConfig()

Correct

const config = useSafeRuntimeConfig()

Auto-fix

The rule supports auto-fix. Run:

eslint --fix .

All useRuntimeConfig() calls are replaced with useSafeRuntimeConfig().

Rule Options

rules: {
  'safe-runtime-config/prefer-safe-runtime-config': ['warn', {
    // No options currently
  }]
}

Severity

• 'warn' (recommended) - shows warning, doesn't fail CI
• 'error' - fails lint, blocks CI
• 'off' - disables the rule