Skip to content

Translation Completeness Check

vueI18nCheckPlugin checks all locale JSON files against a reference locale and reports any missing or extra keys. Runs at buildStart and on every locale file save during development (HMR).

ts
// vite.config.ts
import { vueI18nCheckPlugin } from 'vue-i18n-kit/vite'

export default defineConfig({
  plugins: [
    vue(),
    vueI18nCheckPlugin({
      localesDir: 'src/locales',
      defaultLocale: 'en',
      failOnMissing: true,
    }),
  ],
})

Options

localesDir

string · default: 'src/locales'. Directory containing locale JSON files, relative to Vite project root.

defaultLocale

string · default: first file alphabetically. Locale used as the reference when comparing keys.

failOnMissing

boolean · default: false. When true, missing keys abort the build with an error.

Example output

[vue-i18n-kit] Incomplete translations detected (reference: "en"):
  Locale "ru":
    Missing keys (2):
      - buttons.cancel
      - profile.title
  Locale "de":
    Missing keys (1):
      - profile.title
    Extra keys (1):
      + legacy.old_key