i18n-ally

You can automatically detect and configure your locale directories using the config_locales_auto command. The extension searches for directories matching common naming patterns such as locales, locale, i18n, lang, langs, language, languages, or messages.

It automatically ignores common non-source directories like node_modules, dist, build, test, and others to avoid false positives. If directories are found, they are automatically registered as locale paths in the configuration.

When using Lingui with Next.js, you can configure i18n-ally by creating a lingui.config.js file. This configuration defines the supported locales, the source locale, and the catalog paths where your translation messages are stored. You can use <rootDir> as a placeholder to reference the project root.

module.exports = {
  locales: ["en", "cs"],
  sourceLocale: "en",
  catalogs: [
    {
      path: "<rootDir>/locale/{locale}/messages",
      include: ["<rootDir>/"],
      exclude: ["**/node_modules/**"],
    },
  ],
}

When using Vue with vue-i18n, you can configure Webpack to handle i18n blocks within Single File Components (SFCs) by using @kazupon/vue-i18n-loader. This is achieved by targeting the i18n module rule with a resource query for blockType=i18n.

module.exports = {
  chainWebpack: (config) => {
    config.module
      .rule('i18n')
      .resourceQuery(/blockType=i18n/)
      .type('javascript/auto')
      .use('i18n')
      .loader('@kazupon/vue-i18n-loader')
      .end()
  },
  devServer: {
    disableHostCheck: true,
  },
}

The DetectHardStrings function scans the active document for hardcoded strings that are not part of the i18n framework. It identifies strings based on the extraction frameworks supported by the document's languageId.

Results are automatically filtered against the following configuration settings:

• Config.extractIgnored: A list of specific text strings to ignore.
• Config.extractIgnoredByFiles: A mapping of file paths to lists of strings to ignore within those specific files.

If no extraction frameworks are supported for the current language, a warning message is displayed (if warn is set to true).

The getEnabledFrameworks(dependencies: PackageDependencies, root: string) function determines which frameworks should be active based on the detected project dependencies and the project root.

It evaluates framework detection logic which can be based on:

• Function-based detection
• Array inclusion
• Logic gates: none, any, and every requirements.

Note: If a framework is marked as a monopoly, it will be the only enabled framework. If only the general framework is detected, no frameworks are returned.

Use getEnabledFrameworksByIds(ids: string[], root: string) to force-enable a specific set of frameworks.

• If an ID is provided that does not match a known framework, a warning is logged via Log.warn.
• If a CustomFramework is requested, the load(root) method is automatically called for it.

The FulfillAllMissingKeys function identifies all missing translation keys across all Global.visibleLocales for the current file and prepares them to be written as empty strings.

• prompt: If true (default), a modal confirmation dialog will appear.
• extraKeys: An optional array of strings (string[]) representing additional keys to include in the fulfillment process even if they aren't currently detected in the loader.

The Translator class acts as a registry and entry point for various translation engines. You can use the translate method by providing a TranslateOptions object along with a specific engine key to select which provider to use.

Available engine keys include:

• google (GoogleTranslateEngine)
• google-cn (GoogleTranslateCnEngine)
• deepl (DeepLTranslateEngine)
• libretranslate (LibreTranslateEngine)
• baidu (BaiduTranslate)
• openai (OpenAITranslateEngine)