@tact-lang/tact-language-server

Tact Language Server

Developed by TON Studio, powered by the community.

Features • Installation • Community • Troubleshooting

This language server and an extension for VSCode-based editors provide support for the Tact programming language. Tact is a next-generation programming language for building secure, scalable, and maintainable smart contracts on TON blockchain.

In addition to Tact, the extension provides support for Fift assembly, TL-B, and TON Bag-of-Cells (BoC) files.

Features

• Semantic syntax highlighting
• Code completion with auto import, postfix completion, snippets, imports completion
• Go to definition, implementation, type definition
• Find all references, workspace symbol search, symbol renaming
• Advanced navigation like type-based search and code lenses that let you jump to where each message is sent and where it’s received
• Automatic import updates when renaming and moving files
• Types and documentation on hover
• TL-B definition for messages, structs and contracts on hover
• Beginner documentation for all keywords on hover
• Inlay hints for types, parameter names, receiver opcodes and more
• On-the-fly inspections with quick fixes
• Signature help inside calls, initOf and struct initialization
• Lenses with implementation/reference counts
• Gas estimates for assembly functions
• Build and test projects based on Blueprint and Tact template
• Integration with Tact compiler and Misti static analyzer
• Flexible toolchain management
• Formatting
• Fift Assembly:
  • Basic and semantic syntax highlighting
  • Go-to definitions
  • Inlay hints with gas consumption for instructions
  • Hover documentation for instructions
• TL-B:
  • Basic and semantic syntax highlighting
  • Go-to definitions
  • Completion for fields, parameters, and types
  • Go-to references for types
  • Document symbols with all declarations
• TON Bag-of-Cells (BoC):
  • Automatic BoC disassembly with syntax highlighting
  • Automatic updates on BoC changes

Quick start

The easiest way to get started with Tact is to use VS Code or editors based on it:

• Install the Tact language extension in VS Code or in VS Code-based editors
• That's it!

The extension automatically detects your Tact compiler installation. If you need to work with multiple Tact versions or custom-builds, check out the toolchain management guide.

Installation

VS Code / VSCodium / Cursor / Windsurf

• Get the latest .vsix file from releases from VS Code marketplace or from Open VSX Registry
• In VS Code:
  • Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
  • Type "Install from VSIX"
  • Select the downloaded .vsix file
  • Reload VS Code

Other Editors

Via NPM

• Install the language server via NPM:

  npm install -g @tact-lang/tact-language-server
  

  After installation, you can use tact-language-server executable to run the language server.

• Configure your editor to use the language server (see editor-specific instructions below).

[!NOTE] If for some reason your editor rejects tact-language-server executable, run where tact-language-server to find the path to the executable and then configure your editor to run node <path-to-js-file>.

Manually

• Get the latest archive from releases:
  • tact-language-server-*.tar.gz for Linux/macOS
  • tact-language-server-*.zip for Windows
• Extract it to a convenient location
• Configure your editor to use the language server (see editor-specific instructions below)

Building from Source

If you want to build the language server yourself:

git clone https://github.com/tact-lang/tact-language-server
cd tact-language-server
yarn install
yarn build

To obtain the .vsix package with the VS Code extension, additionally run:

yarn package

Then run either of those to install the extension from the .vsix package:

# VSCode, replace VERSION with the actual version from package.json
code --install-extension vscode-tact-VERSION.vsix

# VSCodium, replace VERSION with the actual version from package.json
codium --install-extension vscode-tact-VERSION.vsix

Editor Setup

Sublime Text

• Install LSP package:

  • Open Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
  • Select "Package Control: Install Package"
  • Search for and select "LSP"

• For syntax highlighting, install the Tact package via Package Control in a similar manner:

  • Open Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
  • Select "Package Control: Install Package"
  • Search for and select "Tact"

• Add the following configuration to your LSP settings (Preferences > Package Settings > LSP > Settings):

  {
      "clients": {
          "tact": {
              "enabled": true,
              // If you installed the language server via NPM, use the following command:
              "command": ["tact-language-server", "--stdio"],
              // If you installed the language server manually, use the following command:
              "command": ["node", "path/to/language-server/dist/server.js", "--stdio"],
              "selector": "source.tact",
          },
      },
      "inhibit_snippet_completions": true,
      "semantic_highlighting": true,
  }
  

• Add the following setting to your settings to enable highlighting of Tact code blocks in hover documentation ( Preferences > Settings):

  {
      // ...
      "mdpopups.sublime_user_lang_map": {
          "tact": [["tact"], ["Tact/package/Tact"]],
      },
  }
  

• Create a new file or open an existing file with the .tact extension to verify the setup

Neovim

Prerequisites:

• nvim-lspconfig
• Neovim 0.5.0 or newer

Setup steps:

• Add tact.lua to your lua/lspconfig/server_configurations directory with the following content:

  local util = require 'lspconfig.util'
  
  return {
    default_config = {
      -- If you installed the language server via NPM, use the following command:
      cmd = { 'tact-language-server', '--stdio' },
      -- If you installed the language server manually, use the following command:
      cmd = { 'node', '/absolute/path/to/language-server/dist/server.js', '--stdio' },
      filetypes = { 'tact' },
      root_dir = util.root_pattern('package.json', '.git'),
    },
    docs = {
      description = [[
        Tact Language Server
        https://github.com/tact-lang/tact-language-server
      ]],
      default_config = {
        root_dir = [[root_pattern("package.json", ".git")]],
      },
    },
  }
  

• Add the following to your init.lua:

  require'lspconfig'.tact.setup {}
  

Vim

Prerequisites:

• Vim 8 or newer
• Async LSP Client for Vim: vim-lsp
• Plugin for Tact: tact.vim

Recommended, but not required:

• Auto-configurations for many language servers: vim-lsp-settings

Setup steps:

• Install the tact.vim if it hasn't already been installed. Use a non-built-in plugin manager to simplify the update process.

• Install the vim-lsp plugin if it isn't already installed. For that, use vim-plug or the built-in package manager of Vim 8+, see :help packages.

• If it wasn't installed before, you should set up basic keybindings with the language client. Add the following to your ~/.vimrc (or ~/_vimrc if you're on Windows):

  function! s:on_lsp_buffer_enabled() abort
      setlocal omnifunc=lsp#complete
      setlocal signcolumn=yes
      if exists('+tagfunc') | setlocal tagfunc=lsp#tagfunc | endif
      nmap <buffer> gd <plug>(lsp-definition)
      nmap <buffer> gs <plug>(lsp-document-symbol-search)
      nmap <buffer> gS <plug>(lsp-workspace-symbol-search)
      nmap <buffer> gr <plug>(lsp-references)
      nmap <buffer> gi <plug>(lsp-implementation)
      nmap <buffer> gt <plug>(lsp-type-definition)
      nmap <buffer> <leader>rn <plug>(lsp-rename)
      nmap <buffer> [g <plug>(lsp-previous-diagnostic)
      nmap <buffer> ]g <plug>(lsp-next-diagnostic)
      nmap <buffer> K <plug>(lsp-hover)
      nnoremap <buffer> <expr><c-f> lsp#scroll(+4)
      nnoremap <buffer> <expr><c-d> lsp#scroll(-4)
  
      let g:lsp_format_sync_timeout = 1000
      autocmd! BufWritePre *.rs,*.go call execute('LspDocumentFormatSync')
  
      " Refer to the doc to add more commands:
      " https://github.com/prabirshrestha/vim-lsp#supported-commands
  endfunction
  
  augroup lsp_install
      au!
      " call s:on_lsp_buffer_enabled only for languages that have the server registered.
      autocmd User lsp_buffer_enabled call s:on_lsp_buffer_enabled()
  augroup END
  

• Add the following to your ~/.vimrc (or ~/_vimrc if you're on Windows):

  if executable('node')
    au User lsp_setup call lsp#register_server({
          \ 'name': 'tact',
          # If you installed the language server via NPM, use the following command:
          \ 'cmd': {server_info->['tact-language-server', '--stdio']},
          # If you installed the language server manually, use the following command:
          \ 'cmd': {server_info->['node', '/absolute/path/to/language-server/dist/server.js', '--stdio']},
          \ 'allowlist': ['tact'],
          \ })
  endif
  

Helix

• Add the following configuration to your ~/.config/helix/languages.toml:

  [[language]]
  name = "tact"
  language-servers = ["tact-language-server"]
  
  [language-server.tact-language-server]
  
  # If you installed the language server via NPM, use the following command:
  command = "tact-language-server"
  args = ["--stdio"]
  # If you installed the language server manually, use the following command:
  command = "node"
  args = ["/absolute/path/to/language-server/dist/server.js", "--stdio"]
  

• Replace path/to/language-server with the actual path where you cloned the repository

• Restart Helix for changes to take effect

Community

• @tactlang on Telegram - Main community chat and discussion group.
• @tactlang_ru on Telegram (Russian)
• @tact_kitchen on Telegram - Channel with updates from the team.
• @tact_language on X/Twitter
• tact-lang organization on GitHub
• @ton_studio on Telegram
• @thetonstudio on X/Twitter

Troubleshooting

See TROUBLESHOOTING.md.

License

MIT