Integrate your Visual Studio Code projects with Crowdin to optimize the localization process. The plugin allows uploading new source strings instantly to your Crowdin project, updating them back from Crowdin and downloading translations.
Features
A new component will be introduced in the Activity Bar called the Crowdin Explorer.
The plugin will scan each workspace for a Crowdin-specific configuration file and will build a tree with source files.
In the Crowdin Explorer you can upload those files to Crowdin, download them back from Crowdin and download translations.
And also track progress of translated and approved strings for each project and target language.
Configuration
To work with the plugin in the Visual Studio Code workspace, there should be a Crowdin configuration file called either crowdin.yml or crowdin.yaml.
Configuration file example:
"project_id": "projectId"
"api_token": "apiToken"
"base_path": "folder" // optional
"branch": "master" // optional
"base_url": "https://{organization-name}.crowdin.com" // optional (for Crowdin Enterprise only)
"files": [
{
"source": "/sources/**/*.xml",
"translation": "/translations/%two_letters_code%/%original_file_name%",
"update_option": "update_as_unapproved", // optional
"excluded_target_languages": ["uk", "fr"], // optional
"labels": ["android", "emails"], // optional
"dest": "/app/%file_name%.xml", // optional
"type": "android" // optional
},
{
"source": "multicolumn.csv",
"translation": "multicolumn.csv",
"scheme": "identifier,source_phrase,context,uk,ru,fr" // optional
}
]
You also can use environment variables in the configuration file Environment variables:
"project_id_env": "CROWDIN_PROJECT_ID"
"api_token_env": "CROWDIN_PERSONAL_TOKEN"
"base_path_env": "CROWDIN_BASE_PATH" // optional
"branch": "master" // optional
"base_url_env": "CROWDIN_BASE_URL" // optional (for Crowdin Enterprise only)
"files": [
{
"source": "/sources/**/*.xml",
"translation": "/translations/%two_letters_code%/%original_file_name%",
"update_option": "update_as_unapproved", // optional
"excluded_target_languages": ["uk", "fr"], // optional
"labels": ["android", "emails"], // optional
"dest": "/app/%file_name%.xml", // optional
"type": "android" // optional
}
]
The project ID can be found on your project settings page.
To generate a new API token in Crowdin, go to your Account Settings.
Setup
- Prepare a
crowdin.yml or crowdin.yaml configuration file and add it to the needed workspace in Visual Studio Code.
- Install the Crowdin plugin using one of the following methods:
open VS Code Extensions (Ctrl+Shift+X), search for Crowdin and click Install
or
launch VS Code Quick Open (Ctrl+P), paste the below command, and press Enter
ext install Crowdin.vscode-crowdin
- The Crowdin plugin scans each Visual Studio Code workspace to find a Crowdin configuration file (crowdin.yml or crowdin.yaml). It automatically builds the tree with source files in the Crowdin Explorer component available in your Activity Bar.
- Use upward and downward arrows in the Crowdin Explorer component to upload source files to Crowdin and download translations correspondingly.
Extension Settings
This extension contributes the following settings:
tms.autoRefresh: enable/disable auto refresh of the file tree after each change in the Crowdin configuration file
Known Issues
At the moment, the plugin does not support all possible properties in the configuration file (see Configuration file). All properties which are supported by this plugin are listed in the example above.
Seeking Assistance
If you find any problems or would like to suggest a feature, please read the How can I contribute section in our contributing guidelines.
Need help working with Crowdin Visual Studio Code Plugin or have any questions? Contact Customer Success Service.
Contributing
We are happy to accept contributions to the Crowdin Visual Studio Code Plugin. If you want to contribute, please read the Contributing guidelines.
License
The Crowdin Visual Studio Code Plugin is licensed under the MIT License.
See the LICENSE file distributed with this work for additional
information regarding copyright ownership.
Except as contained in the LICENSE file, the name(s) of the above copyright
holders shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written authorization.
