Creator Transify

Easier to view translations and add translations to the transify platform

Feature

• Hover the cursor over the transify key to prompt for the translation content.
• Upload JSON to transify platform
• View translations for selected projects and languages
• Add a key to the selected project

Config

Before the extension able to work, you need add a transify.json to .vscode folder in the root directory of the workspace. eg:

.
└── creator-fe
    └── .vscode
        └── transify.json

transify.json

{
  "token": "your token on transify platform",
  "projectId": "xxx",
  "languages": ["en", "id", "vi", "th", "ph", "ms-my", "pt-BR", "zh-Hant", "zh-Hans", "default"],
  "bizList": [
    {
      "label": "creator-xxx",
      "resourceId": "xxx"
    },
    {
      "label": "Rudy",
      "resourceId": "xxx"
    }
  ],
  "transifyKeyRegexp": "\\w+" // transify key rule
}

token

Please generate your token on Transify Api

projectId

projectId is the number following the projects in the url of the transify platform.

languages

Languages you need. Some resources have defalt language, please add it if needed.

bizList

We'll show the labels in each item of the bizList in the picker.

transifyKeyRegexp

Transify key rule. this property is optional, default value is /^[\w-]+([.*|_+][\w-]+)+$/i. The following keys will be matched

• rudy_key_1
• rudy_key.1
• rudy.key.1
• rudy.key_1

Usage

Hover cursor to view translation

Before you can view translation, you need to load translation for specified projects and languages by cmd+shift+L. Just to be clear that you only need to load once if you haven't switched projects or updated any translations.

Upload json to transify

cmd+shift+U hotkey only works on .json files, so open a json file then exce it. some keys that already exist on transify platform will be ignored.

Just in case you can't remember the command, there are two shortcut buttons on editor/title that you can use. L is for load translation and U is for upload json

Upload json to Google Sheet

cmd+shift+J hotkey only works on .json files, so open a json file then exce it. You need select project and enter the spreadsheet_id, the key-values in json file will be append to Google Sheet.

Please note the following two points

• Add a config named credentials.json in .vscode to offer you service account credentials.
• Share the Google Sheet to you service account,it's usually of this type service-account-name@project-id.iam.gserviceaccount.com

Add key and view translations

By default, the extension use this first item of bizList and the first item of languages declared in the .vscode/transify.json.

search

• Enter something in the transify key input box if you want search by key.
• Enter something in the transify content input box if you want search by content.
• Both key and conent are filledin, the key will be used first.

then click the search button.

The result returned is all the keys or translation content that contain the input value

Commands

• Load translations
• Upload json to transify

Hotkey

• cmd+shift+L - load translations
• cmd+shift+U - upload json to translation
• cmd+shift+J - upload json to Google Sheet

Minimum version

"engines": {
  "vscode": "^1.60.0"
},

doc

https://confluence.shopee.io/display/SPV/07+VSCode+Transify+Extension