Tact Language Server

Developed by TON Studio, powered by the community.

[Features] • [Installation] • [Community] • [Troubleshooting]

[Features]: #features
[Installation]: #installation
[Community]: #community
[Troubleshooting]: #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

[Semantic syntax highlighting]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/highlighting.md
[Code completion]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/completion.md
[auto import]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/completion.md#auto-import
[postfix completion]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/completion.md#postfix-completion
[imports completion]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/completion.md#imports-completion
[definition]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/navigation.md#go-to-definition
[type definition]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/navigation.md#go-to-type-definition
[for types]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/inlay-hints.md#type-hints
[parameter names]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/inlay-hints.md#parameter-hints
[more]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/inlay-hints.md#additional-hints
[inspections]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/inspections.md
[Lenses]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/code-lenses.md
[Gas estimates]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/gas-calculation.md
[Blueprint]: https://docs.ton.org/v3/documentation/smart-contracts/getting-started/javascript
[Tact template]: https://github.com/tact-lang/tact-template
[Tact compiler]: https://github.com/tact-lang/tact
[Misti]: https://nowarp.io/tools/misti/
[type-based search]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/type-based-search.md
[toolchain management]: https://github.com/tact-lang/tact-language-server/blob/master/docs/manual/features/toolchain-management.md

Quick start

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

1. Install the Tact language extension
in VS Code
or in VS Code-based editors
2. 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.

!editor.png

Installation

$3

1. Get the latest .vsix file from releases from
VS Code marketplace
or from Open VSX Registry
2. 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

$3

#### Via NPM

1. Install the language server via NPM:

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

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

2. 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 .

#### Manually

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

$3

If you want to build the language server yourself:

`shell
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:

`shell
yarn package
`

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

`shell


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

$3

1. Install LSP package:

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

2. 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"

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

`jsonc
{
"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,
}
`

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

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

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

$3

Prerequisites:

- nvim-lspconfig
- Neovim 0.5.0 or newer

Setup steps:

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

`lua
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")]],
},
},
}
`

2. Add the following to your init.lua:

`lua
require'lspconfig'.tact.setup {}
`

$3

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:

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

2. 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):

`vim
function! s:on_lsp_buffer_enabled() abort
setlocal omnifunc=lsp#complete
setlocal signcolumn=yes
if exists('+tagfunc') | setlocal tagfunc=lsp#tagfunc | endif
nmap gd (lsp-definition)
nmap gs (lsp-document-symbol-search)
nmap gS (lsp-workspace-symbol-search)
nmap gr (lsp-references)
nmap gi (lsp-implementation)
nmap gt (lsp-type-definition)
nmap rn (lsp-rename)
nmap [g (lsp-previous-diagnostic)
nmap ]g (lsp-next-diagnostic)
nmap K (lsp-hover)
nnoremap lsp#scroll(+4)
nnoremap 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
`

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

`vim
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
`

$3

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

`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"]
`

2. Replace path/to/language-server with the actual path where you cloned the repository
3. 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