Messagevisor

Missing translations module

The Missing translations module turns Messagevisor's built-in missing-translation diagnostics into a small handler API for application logging, analytics, or developer tooling.

Installation

Command
$ npm install @messagevisor/module-missing-translations

Usage

your-app/messagevisor.js
import { createMessagevisor } from "@messagevisor/sdk";
import { createMissingTranslationsModule } from "@messagevisor/module-missing-translations";
const m = createMessagevisor({
  datafile,
  modules: [
    createMissingTranslationsModule({
      handler({ messageKey, locale, revision }) {
        console.warn("Missing translation", { messageKey, locale, revision });
      },
    }),
  ],
});

The module listens for the SDK's missing_translation diagnostic. It does not change translation fallback behavior.

Handler payload

The handler receives:

FieldDescription
messageKeyMessage key whose translation could not be resolved
localeLocale active when the missing translation was reported, or null
revisionDatafile revision for the locale, when available
sourceDiagnostic source such as translation or formatMessage
diagnosticOriginal MessagevisorDiagnostic object emitted by the SDK

revision is read through the SDK module API. If the locale has no loaded datafile, the module omits revision rather than interrupting translation evaluation.

Deduping

By default, the handler runs every time a missing translation is reported.

your-app/messagevisor.js
createMissingTranslationsModule({
  handler(payload) {
    analytics.track("missing_translation", payload);
  },
});

Enable dedupe when you only want one call per message key, locale, revision, and source for the lifetime of the module instance:

your-app/messagevisor.js
createMissingTranslationsModule({
  dedupe: true,
  handler(payload) {
    analytics.track("missing_translation", payload);
  },
});

Custom name

The default module name is missing-translations. You can override it when registering multiple diagnostics-related modules:

your-app/messagevisor.js
createMissingTranslationsModule({
  name: "missing-copy-reporter",
  handler(payload) {
    reportMissingTranslation(payload);
  },
});