Crowdin Visual Studio Code Plugin

Integrate your Visual Studio Code projects with Crowdin to optimize the localization process. Plugin allows uploading new source strings instantly to your Crowdin project and downloading translations.

Get it from the VS Code Marketplace →

Features

New component will be introduced in Activity Bar called Crowdin Explorer. Plugin will scan each workspace for Crowdin specific configuration file and will build tree with source files. In Crowdin Explorer you can upload those files into Crowdin and download translations.

Configuration

To work with plugin in the Visual Studio Code workspace, there should be 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 (not needed for non-enterprise usage)

"files": [
  {
    "source": "/sources/**/*.xml",
    "translation": "/translations/%two_letters_code%/%original_file_name%"
  }
]

You also can use environment variables in configuration file Environmet 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 (not needed for non-enterprise usage)

"files": [
  {
    "source": "/sources/**/*.xml",
    "translation": "/translations/%two_letters_code%/%original_file_name%"
  }
]

Project ID can be found in your project settings page.

To generate a new API token in Crowdin, go to your Account Settings.

Setup

1. Prepare crowdin.yml or crowdin.yaml configuration file and add it to the needed workspace in Visual Studio Code.
2. Install 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
     

3. Crowdin plugin scans each Visual Studio Code workspace to find Crowdin configuration file (crowdin.yml or crowdin.yaml). It automatically builds the tree with source files in Crowdin Explorer component available on your Activity Bar.
4. Use upward and downward arrows in 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 files tree after each change in Crowdin configuration file

Known Issues

At the moment plugin is not support all possible properties in configuration file (see Configuration file). All properties which are supported by this plugin are listed in the example above.

Contribution

We are happy to accept contributions to the Crowdin Visual Studio Code Plugin. To contribute please do the following:

1. Fork the repository on GitHub.
2. Decide which code you want to submit. Commit your changes and push to the new branch.
3. Ensure that your code adheres to standard conventions, as used in the rest of the library.
4. Ensure that there are unit tests for your code.
5. Submit a pull request with your patch on Github.

Seeking Assistance

If you find any problems or would like to suggest a feature, please feel free to file an issue on Github at Issues Page.

Need help working with Crowdin Visual Studio Code Plugin or have any questions? Contact Customer Success Service.

License

Copyright © 2020 Crowdin

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.