Project Translator

A VSCode extension: An easy-to-use tool for multi-language localization of projects.

Available Translations

The extension supports translation to these languages:

• 简体中文 (zh-cn)
• 繁體中文 (zh-tw)
• 日本語 (ja-jp)
• 한국어 (ko-kr)
• Français (fr-fr)
• Deutsch (de-de)
• Español (es-es)
• Português (pt-br)
• Русский (ru-ru)
• العربية (ar-sa)
• العربية (ar-ae)
• العربية (ar-eg)

Samples

Requesting Project Translation

If you want to contribute a translation or need a project to be translated:

1. Create an issue using the following template:

**Project**: [project_url]
**Target Language**: [target_lang]
**Description**: Brief description of why this translation would be valuable

2. Workflow:

sequenceDiagram
  Contributor->>Project Translator: Create translation issue
  Project Translator->>Community: Review issue
  Community-->>Contributor: Approve/Comment
  Contributor->>New Project: Start translation
  Contributor->>New Project: Submit to New Project
  Contributor->>Project Translator: Create Pull Request, modify README.Samples
  Project Translator-->>Project Translator: Review & Merge

3. After the PR is merged, the translation will be added to the Samples section.

Current translations in progress: View Issues

Features

• 📁 Folder-level Translation Support
  • Translate entire project folders to multiple languages
  • Maintain original folder structure and hierarchy
  • Support for recursive translation of subfolders
  • Automatic detection of translatable content
  • Batch processing for efficient large-scale translations
• 📄 File-level Translation Support
  • Translate individual files to multiple languages
  • Preserve original file structure and formatting
  • Support for both folder and file translation modes
• 💡 Smart Translation with AI
  • Automatically maintains code structure integrity
  • Only translates code comments, preserves code logic
  • Maintains JSON/XML and other data structure formats
  • Professional technical documentation translation quality
• ⚙️ Flexible Configuration
  • Configure source folder and multiple target folders
  • Support for custom file translation intervals
  • Set specific file types to ignore
  • Support for multiple AI model options
• 🚀 User-Friendly Operations
  • Real-time translation progress display
  • Support for pause/resume/stop translation
  • Automatic maintenance of target folder structure
  • Incremental translation to avoid duplicate work

Installation

1. Search for "Project Translator" in VS Code extension marketplace
2. Click install

Configuration

The extension supports the following configuration options:

{
  "projectTranslator.specifiedFolders": [
    {
      "sourceFolder": {
        "path": "Source folder path",
        "lang": "Source language code"
      },
      "targetFolders": [
        {
          "path": "Target folder path",
          "lang": "Target language code"
        }
      ]
    }
  ],
  "projectTranslator.specifiedFiles": [
    {
      "sourceFile": {
        "path": "Source file path",
        "lang": "Source language code"
      },
      "targetFiles": [
        {
          "path": "Target file path",
          "lang": "Target language code"
        }
      ]
    }
  ],
  "projectTranslator.currentVendor": "openai",
  "projectTranslator.vendors": [
    {
      "name": "openai",
      "apiEndpoint": "API endpoint URL",
      "apiKey": "API authentication key",
      "apiKeyEnvVarName": "Environment variable name for API key",
      "model": "Model name to use",
      "rpm": "Maximum requests per minute",
      "maxTokensPerSegment": 4096,
      "timeout": 30,
      "temperature": 0.0
    }
  ]
}

Key configuration details:

Usage

1. Open command palette (Ctrl+Shift+P / Cmd+Shift+P)
2. Type "Translate Project" and select the command
3. If source folder is not configured, a folder selection dialog will appear
4. Wait for translation to complete

During translation:

• Can pause/resume translation via status bar buttons
• Can stop translation process at any time
• Translation progress shown in notification area
• Detailed logs displayed in output panel

Development

Build System

This extension uses esbuild for fast bundling and development:

Available Scripts

• npm run build - Production build with minification
• npm run compile - Development build
• npm run watch - Watch mode for development
• npm test - Run tests

VS Code Tasks

• Build (Ctrl+Shift+P → "Tasks: Run Task" → "build") - Bundles extension for production
• Watch (Ctrl+Shift+P → "Tasks: Run Task" → "watch") - Development mode with auto-rebuild

Development Setup

1. Clone the repository
2. Run npm install to install dependencies
3. Press F5 to start debugging or run the "watch" task for development

The esbuild configuration:

• Bundles all TypeScript files into a single out/extension.js
• Excludes VS Code API (marked as external)

Advanced Features

Using Environment Variables for API Keys

Project Translator supports using environment variables for API keys, which is a more secure approach than storing API keys directly in configuration files:

1. Configure your vendor with an apiKeyEnvVarName property:

{
  "projectTranslator.vendors": [
    {
      "name": "openai",
      "apiEndpoint": "https://api.openai.com/v1",
      "apiKeyEnvVarName": "OPENAI_API_KEY",
      "model": "gpt-4"
    },
    {
      "name": "openrouter",
      "apiEndpoint": "https://openrouter.ai/api/v1",
      "apiKeyEnvVarName": "OPENROUTER_API_KEY",
      "model": "anthropic/claude-3-opus"
    }
  ]
}

2. Set the environment variable in your system:

   • On Windows: set OPENAI_API_KEY=your_api_key
   • On macOS/Linux: export OPENAI_API_KEY=your_api_key

3. When the extension runs, it will:

   • First check if apiKey is provided directly in the configuration
   • If not, it will look for the environment variable specified by apiKeyEnvVarName

This approach keeps your API keys out of configuration files and version control systems.

Skip Translation Based on Front Matter

Project Translator can skip translation of Markdown files based on their front matter metadata. This is useful for draft documents or files marked as not requiring translation.

To enable this feature, configure the projectTranslator.skipFrontMatterMarkers option:

{
  "projectTranslator.skipFrontMatterMarkers": {
    "enabled": true,
    "markers": [
      {
        "key": "draft",
        "value": "true"
      },
      {
        "key": "translate",
        "value": "false"
      }
    ]
  }
}

With this configuration, any Markdown file with front matter containing draft: true or translate: false will be skipped during translation and directly copied to the target location.

Example Markdown file that would be skipped:

---
draft: true
title: "Draft Document"
---

This document is a draft and should not be translated.

Design Documentation

• Generates source maps for development builds
• Minifies code for production builds
• Provides problem matcher integration for VS Code

Notes

• Ensure sufficient API usage quota
• Recommended to test with small projects first
• Use dedicated API keys and remove them after completion

License

License