README.zh-CN.md

English | 简体中文

🚧 请注意，本中文文档并非实时更新，可能会有和英文版不对应的情况，仅供参考。如有歧义，请一切以英文版文档为主。

🧱 支持的框架

插件会根据当前项目的依赖自动检测框架。

Framework	Status	Trigger Packages
Vue	✅	vue-i18n, vuex-i18n, vue-i18next, nuxt-i18n
Vue SFC i18n	✅	@kazupon/vue-i18n-loader
React	✅	react-i18next, react-intl, next-i18next
Angular(ngx-translate)	✅	@ngx-translate/core
Flutter(flutter_i18n)	✅	flutter_i18n
Ember.js	✅	ember-intl
VSCode Extension	✅	@types/vscode, vscode
i18next	✅	i18next
i18nTag	✅	es2015-i18n-tag
Angular(native)	Vote Here
Rails	Vote Here

如果您希望插件支持上面未列出的框架，你可以发起一个 框架支持请求 或者直接PR。（如果可以请尽量使用英文，让更多人可以看到并参与进来，感谢！）

⚡ 主要功能

内联翻译显示

悬浮窗

统一管理所有翻译文案

一键机器翻译

支持多种文案格式

重构

从代码中提取文案

JSON 和 YAML 的内联翻译显示

整体

• 支持多目录工作区
• 支持远程开发 (Remote Development)
• 支持大多数流行框架
• 插件自身多语言支持 翻译列表

📜 支持的文案格式

文件格式	读	写	内联显示	备注
JSON	✅	✅	✅
YAML	✅	✅	✅	注释不会保留*
JSON5	✅	✅	❌	注释不会保留*
JavaScript	✅	❌	❌	强制只读模式
TypeScript	✅	❌	❌	强制只读模式

* 受限于 yaml.dumps(#196) 和 JSON5.stringify(#177), YAML 和 JSON5 的注释在任何写入操作后将会丢失。如果你希望保留注释，可以可以通过设置 i18n-ally.readonly 让插件在只读模式工作。

📂 目录结构

您可以将语言目录置为一下两种形式

  locales
  ├── en.json
  ├── de-DE.json
  ├── zh-CN.yml   # YAML 格式同样支持
  ├── zh-TW.ts    # 你也可以混合不同的格式
  ├── ...
  └── <contry-code>.json

或者

  locales
  ├── en
  |   ├── common.json
  |   ├── buttons.json
  |   ├── ...
  |   └── <filenames>.json
  ├── de-DE
  |   ├── common.json
  |   ├── buttons.json
  |   └── ...
  └── <contry-code>
      ├── common.json
      ├── buttons.json
      └── ...

⚙ 常用设置

下列所有的设置需要加上 "i18n-ally." 前缀

字段	默认值	描述
sourceLanguage	en	翻译源语言
displayLanguage	en	显示语言
localesPaths	自动	翻译文件夹路径 (相对于项目根目录)，你也可以使用Glob匹配模式。
sortedKeys	false	保存排序后的JSON/YAML
keystyle	自动	翻译路径格式, 可以是 flat({"a.b.c": "..."}) 或 nested({"a": {"b": {"c": "..."}}}).
readonly	false	只读模式
annotations	true	启用内联注释
keepFulfilled	false	始终用空字符串填充所有的键
enabledFrameworks	自动	指定要使用的框架支持。如果未设置任何值，插件将自动检测框架
indent	2	缩进空格数
tabStyle	space	使用空格或Tab进行缩进
promptTranslatingSource	false	每次翻译前询问翻译源语言

🎯 常见问题

插件没有作用 (侧边栏没有显示图标)

本插件支持许多不同的框架框架，请确保您正在使用的框架在支持列表中。

我可以看到插件的图标显示在侧边栏，但没有任何的翻译文案

1. 区域设置路径配置缺失，您可能需要通过下列任一方式手动配置翻译文件路径
   • 打开命令面板（Ctrl-Shift-P或⌘⇧P），选择 Vue i18n 助手: 手动设置语言目录 并按照指南操作。
   • 打开 VSCode 的设置文件并手动设置 vue-i18n-ally.localesPaths。
2. 源语言/显示语言设置。 默认语言环境设置为英语（en）。 如果您的项目不支持英语，则可能需要通过命令 Vue i18n 助手: 更改源语言 进行修改。
3. 检查你的 目录结构

👨‍💻 感谢

本插件最初来源于 think2011/vscode-vue-i18n，非常感谢 @think2011 的启发。

Vue SFC 的支持来自于 vue-i18n 的作者 kazupon 的 kazupon/vue-i18n-locale-message。感谢提供的帮助!

同时也十分感谢所有这些很棒的 贡献者 和看到这里的你。

最后，我希望特别感谢我的伴侣 @iiiiiiines 支持我并鼓励我做出这个项目。

☕ 请我喝杯咖啡

我在这个项目里投入了许多精力和时间，如果您觉得它有用，你也可以考虑请我喝杯咖啡！

通过 PayPal 或者 支付宝，干杯！！！ 🙌

📄 License

MIT License © 2019-2020 Anthony Fu