AFFiNE/packages/i18n
Qi db40cd35c6
feat: migrate workspace setting with new design to setting modal (#2900)
Co-authored-by: Alex Yang <himself65@outlook.com>
2023-06-28 14:45:33 +00:00
..
src feat: migrate workspace setting with new design to setting modal (#2900) 2023-06-28 14:45:33 +00:00
.gitignore build: perform TypeCheck for all packages (#2573) 2023-05-31 12:49:56 +00:00
build.mjs test: fix image preview (#2874) 2023-06-27 21:05:24 +08:00
package.json chore: bump typescript version (#2906) 2023-06-28 12:57:33 +00:00
README.md feat(i18n): static type on i18n (#2225) 2023-05-04 05:35:09 +00:00
tsconfig.json build: perform TypeCheck for all packages (#2573) 2023-05-31 12:49:56 +00:00
tsconfig.resources.json build: perform TypeCheck for all packages (#2573) 2023-05-31 12:49:56 +00:00

i18n

Usages

  • Update missing translations into the base resources, a.k.a the src/resources/en.json
  • Replace literal text with translation keys
import { useAFFiNEI18N } from '@affine/i18n/hooks';

// src/resources/en.json
// {
//     'Text': 'some text',
//     'Switch to language': 'Switch to {{language}}', // <- you can interpolation by curly brackets
// };

const App = () => {
  const t = useAFFiNEI18N();

  const changeLanguage = (language: string) => {
    i18n.changeLanguage(language);
  };

  return (
    <div>
      <div>{t('Text')}</div>

      <button onClick={() => changeLanguage('en')}>{t('Switch to language', { language: 'en' })}</button>
      <button onClick={() => changeLanguage('zh-Hans')}>{t('Switch to language', { language: 'zh-Hans' })}</button>
    </div>
  );
};

How the i18n workflow works?

  • When the src/resources/en.json(base language) updated and merged to the develop branch, will trigger the languages-sync action.
  • The languages-sync action will check the base language and add missing translations to the Tolgee platform.
  • This way, partners from the community can update the translations.

How to sync translations manually

  • Set token as environment variable
export TOLGEE_API_KEY=tgpak_XXXXXXX
  • Run the sync-languages:check to check all languages
  • Run the sync-languages script to add new keys to the Tolgee platform
  • Run the download-resources script to download the latest full-translation translation resources from the Tolgee platform

References