Quick Locale AI

Stop copy-pasting localization files. Start syncing.

This is the official VS Code companion extension for the Quick Locale Ai Confluence App. It provides real-time, hot-reload synchronization of your i18n localization files directly from Confluence to your local development environment.

🚀 The Problem We Solve

In modern software development, managing UI text is a constant back-and-forth between Project Owners (who write the content in Confluence) and Developers (who implement it in the code). This manual process is slow, error-prone, and a major drain on developer resources.

Quick Locale Ai eliminates this bottleneck. Your PO manages all locales in a simple Confluence table, and this extension ensures every change is instantly reflected in your project's codebase.

✨ Core Features

• 🔌 Real-Time Hot Reload: Utilizes WebSockets to automatically update and reload your local locale files the moment a change is made in the Confluence comment table. No manual pulling or app reloading required.
• ✍️ Read-Only by Design: Prevents accidental direct edits to the managed locale files, ensuring Confluence remains the single source of truth and avoiding synchronization conflicts.
• 🔗 Simple Project Linking: A straightforward configuration process to link your local project workspace to your Quick Locale Ai instance.
• 🔔 Status Bar Notifications: Get instant feedback on connection status and synchronization events right in your VS Code status bar.
• 🔄 Manual Resync Command: A command to manually trigger a full resynchronization if you ever need to ensure your local files are perfectly aligned with the server.

⚙️ How It Works

1. A Project Owner edits the localization table in a Confluence comment.
2. The Quick Locale Ai Confluence App processes the change and broadcasts an update via a secure WebSocket channel.
3. The VS Code extension, listening on this channel, receives the update.
4. It automatically modifies, adds, or deletes keys/files in your local project's locale directory.
5. Your development server's hot-reload feature picks up the file changes, and you see the new text in your app instantly.

📋 Prerequisites

Before installing this extension, you must have the Quick Locale Ai app installed and configured in your team's Confluence instance.

📦 Installation

1. Open Visual Studio Code.
2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
3. Search for Quick Locale Ai.
4. Click Install.
5. Reload VS Code if prompted.

🛠️ Configuration

To connect the extension to your project:

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
2. Run the command: Quick Locale Ai: Initialize Project.
3. This will create a quicklocale.json configuration file in your project's root directory.
4. This configuration file links your codebase to the correct project in Confluence. You will need to populate it with the details from your Quick Locale Ai dashboard.

Here is an example of what your quicklocale.json should look like:

{
  "key": "<YOUR-KEY>",
  "locale_directory": "public/locales",
  "locales": ["en", "ar", "zh", "es", "ja"]
}