Language server

@transglot/lsp is a Language Server Protocol server. Any editor with an LSP client can start it and get the same features, configured once per editor.

FeaturesCopy Anchor Link

• Missing translations as diagnostics. In a JSON source file that one of your sources rules names, every key with no translation in a target locale is flagged: "cart.title" is missing a translation in: fr, de.
• Hover. Hovering a key shows its translation in every target locale.
• CodeLens. A summary line above each key, such as fr: Bonjour · de: Hallo · es: Hola.
• Extract to transglot key. On a string literal in a .js, .jsx, .ts or .tsx file, the code action Extract to transglot key adds the string to your messages file under a generated key, replaces the literal with an i18n call such as t('key'), and offers Push key to transglot to upload the messages file.

Diagnostics, hover and CodeLens work on the JSON formats: json_flat, json_nested, laravel_json and flutter_arb. The server downloads each target locale from the project, so it shows what the project holds rather than your local target files.

RequirementsCopy Anchor Link

• Node.js 20 or later.
• A deploy token with the pull ability, plus push to upload extracted keys. See Deploy tokens.
• A transglot.json in the workspace root. The server reads its sources rules to know which files are source files. See Configuration file.

Version 0.1.0 of the server cannot read a transglot.json whose rules use metadata, unity_csv or unreal_po. It then logs transglot: could not load transglot.json and shows no diagnostics.

InstallCopy Anchor Link

npm install -g @transglot/lsp

This puts a transglot-lsp command on your PATH. It speaks LSP over stdio.

SettingsCopy Anchor Link

The server reads its settings from the initializationOptions your editor sends when it starts the server. They are read once, at start.

Keep the token out of files you commit. The examples below read it from the TRANSGLOT_TOKEN environment variable where the editor allows it.

Set up your editorCopy Anchor Link

NeovimCopy Anchor Link

Neovim 0.11 and later configure language servers with vim.lsp.config:

vim.lsp.config('transglot', {
  cmd = { 'transglot-lsp' },
  filetypes = { 'json', 'javascript', 'javascriptreact', 'typescript', 'typescriptreact' },
  root_markers = { 'transglot.json', '.git' },
  init_options = {
    serverUrl = 'https://api.transglot.ai',
    token = os.getenv('TRANSGLOT_TOKEN'),
    messagesFile = 'src/messages/en.json',
    i18nFunction = 't',
    format = 'json_flat',
  },
})
vim.lsp.enable('transglot')

Use your usual LSP keymaps: hover with K, code actions with gra, diagnostics in the location list.

JetBrains IDEsCopy Anchor Link

IntelliJ IDEA, WebStorm, PhpStorm and the other JetBrains IDEs (2023.2 and later) run external language servers through the free LSP4IJ plugin.

{
  "serverUrl": "https://api.transglot.ai",
  "token": "tgl_xxx",
  "messagesFile": "src/messages/en.json",
  "i18nFunction": "t",
  "format": "json_flat"
}

If the IDE cannot find transglot-lsp, use the full path that which transglot-lsp prints as the command.

HelixCopy Anchor Link

[language-server.transglot]
command = "transglot-lsp"

[language-server.transglot.config]
serverUrl = "https://api.transglot.ai"
token = "tgl_xxx"
messagesFile = "src/messages/en.json"

[[language]]
name = "json"
language-servers = ["vscode-json-language-server", "transglot"]

[[language]]
name = "typescript"
language-servers = ["typescript-language-server", "transglot"]

Keep each language's existing servers in its language-servers list and add transglot.

Sublime TextCopy Anchor Link

With the LSP package installed, open Preferences → Package Settings → LSP → Settings and add a client:

{
  "clients": {
    "transglot": {
      "enabled": true,
      "command": ["transglot-lsp"],
      "selector": "source.json | source.js | source.jsx | source.ts | source.tsx",
      "initializationOptions": {
        "serverUrl": "https://api.transglot.ai",
        "token": "tgl_xxx",
        "messagesFile": "src/messages/en.json"
      }
    }
  }
}

Other editorsCopy Anchor Link

Any LSP client that can start a stdio server works: run transglot-lsp and pass the settings as initialization options.

CommandsCopy Anchor Link

The server registers transglot.pushKey, which pushes messagesFile to the project. Extract to transglot key offers it as Push key to transglot after it writes a key, and when it succeeds the editor shows how many keys were created.

TroubleshootingCopy Anchor Link

Messages from the server appear in your editor's LSP log: