使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商
版本历史
- 添加 loadJSON 插件v7.0.62025/11/1
- 更改为 syncJSON 插件并全面重写v7.0.02025/10/29
此页面的内容已使用 AI 翻译。
查看英文原文的最新版本如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接复制文档 Markdown 到剪贴板
使用 vue-i18n 和 Intlayer 的 Vue.js 国际化 (i18n)
目录
什么是 Intlayer?
Intlayer 是一个创新的开源国际化库,旨在解决传统 i18n 解决方案的不足。它为 Vue.js 和 Nuxt 应用提供了一种现代化的内容管理方法。
请参阅我们博客文章中的具体对比:vue-i18n vs. Intlayer。
为什么要将 Intlayer 与 vue-i18n 结合使用?
虽然 Intlayer 提供了一个出色的独立 i18n 解决方案(请参阅我们的Vue.js 集成指南),但你可能出于以下几个原因想将其与 vue-i18n 结合使用:
- 现有代码库:你已经有一个成熟的 vue-i18n 实现,并希望逐步迁移到 Intlayer 以获得更好的开发者体验。
- 遗留需求:你的项目需要兼容现有的 vue-i18n 插件或工作流程。
- 团队熟悉度:你的团队对 vue-i18n 很熟悉,但希望获得更好的内容管理。
- 使用 Intlayer 功能:你想使用 Intlayer 的内容声明、翻译自动化、翻译测试等功能。
为此,Intlayer 可以作为 vue-i18n 的适配器来实现,帮助你在 CLI 或 CI/CD 流水线中自动化 JSON 翻译,测试翻译等。
本指南将向您展示如何利用 Intlayer 优越的内容声明系统,同时保持与 vue-i18n 的兼容性。
使用 vue-i18n 设置 Intlayer 的分步指南
第一步:安装依赖
使用您喜欢的包管理器安装必要的包:
复制代码到剪贴板
npm install intlayer @intlayer/sync-json-plugin --save-devnpx intlayer init包说明:
- intlayer:内容声明和管理的核心库
- @intlayer/sync-json-plugin:用于将 Intlayer 内容声明同步到 vue-i18n JSON 格式的插件
第2步:实现 Intlayer 插件以封装 JSON
创建一个 Intlayer 配置文件以定义您支持的语言环境:
如果您还想导出用于 vue-i18n 的 JSON 字典,请添加 syncJSON 插件:
复制代码到剪贴板
import { Locales, type IntlayerConfig } from "intlayer";import { syncJSON } from "@intlayer/sync-json-plugin";const config: IntlayerConfig = { internationalization: { locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH], defaultLocale: Locales.ENGLISH, }, plugins: [ syncJSON({ format: "vue-i18n", source: ({ key, locale }) => `./src/locales/${locale}/${key}.json`, }), ],};export default config;syncJSON 插件会自动包装 JSON。它会读取和写入 JSON 文件,而不会改变内容结构。
如果你想让 JSON 与 intlayer 内容声明文件(.content 文件)共存,Intlayer 会按以下方式处理:
- 加载 JSON 和内容声明文件,并将它们转换为 intlayer 字典。
- 如果 JSON 和内容声明文件之间存在冲突,Intlayer 会合并所有字典。具体合并方式取决于插件的优先级以及内容声明文件的优先级(所有优先级均可配置)。
如果通过 CLI 翻译 JSON 或使用 CMS 进行更改,Intlayer 会使用新的翻译更新 JSON 文件。
要查看更多关于 syncJSON 插件的详细信息,请参阅 syncJSON 插件文档。
Git 配置
将生成的文件排除在版本控制之外:
复制代码到剪贴板
# 忽略 Intlayer 生成的文件.intlayer这些文件会在构建过程中自动重新生成,无需提交到您的代码仓库。
VS Code 扩展
为了提升开发者体验,请安装官方的 Intlayer VS Code 扩展: