Skip to content

fix: polish README.md #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 5, 2025
Merged

fix: polish README.md #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21e59c5
fix: polish README.md
anton-trunov Mar 5, 2025
f694267
chore: auto-generate vimdoc via panvimdoc
github-actions[bot] Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
<img src=".github/BANNER.png" alt="Tact.Vim"/>
</center>

🚀 Adds syntax highlighting, grammar completion and miscellaneous support for the [Tact programming language](https://tact-lang.org/) to Vim 8+ and Neovim.
🚀 Adds syntax highlighting, grammar completion, and miscellaneous support for the [Tact programming language](https://tact-lang.org/) to Vim 8+ and Neovim.

⚡ Tact is a new programming language for TON blockchain that is focused on efficiency and simplicity. It is designed to be easy to learn and use, and to be a good fit for smart contracts, because it is a statically typed language with a simple syntax and a powerful type system.
⚡ Tact is a new programming language for TON blockchain focused on efficiency and simplicity. It is designed to be easy to learn and use and to be a good fit for smart contracts because it is a statically typed language with a simple syntax and a powerful type system.

## Features

Expand All @@ -16,10 +16,10 @@
- [Compiler integration support](#usage)
- [Abbreviations](#abbreviations) in INSERT mode
- [Auto-completion](#completion) (omnifunc/completefunc) support of static (global) and extension (methods on types) functions from stdlib, and all of the basic grammar \
(use `ctrl-x ctrl-o` to trigger it or setup shortcuts as you wish)
- Basic linting, which automatically triggers on omnicompletion. Don't forget to close your braces {}, parenthesis () and names, or use keyword completion instead ;)
(use `ctrl-x ctrl-o` to trigger it or set shortcuts as you wish)
- Basic linting, which automatically triggers on omnicompletion. Don't forget to close your braces {}, parenthesis (), and names, or use keyword completion instead ;)

See the highlighting showcase below (uses `One Dark` color scheme).\
See the highlighting showcase below (uses the `One Dark` color scheme).\
Note, that you can [disable highlighting of identifiers](#highlighting), if you want to :)

<img src=".github/SHOWCASE.png" alt="Highlighting showcase" width="50%" style="display:inline;" />
Expand All @@ -33,19 +33,19 @@ Note, that you can [disable highlighting of identifiers](#highlighting), if you
<details>
<summary><em>Click to see</em></summary>

Assuming you don't have any configuration in the `.vimrc` file, it's nicer to setup some sane defaults first before using this (or any other) plugin. Also, the following mini-guide will use the built-in package management for Vim 8+ and won't introduce anything fancy.
Assuming you don't have any configuration in the `.vimrc` file, setting up some sane defaults is nicer before using this (or any other) plugin. Also, the following mini-guide will use the built-in package management for Vim 8+ and won't introduce anything fancy.

Steps:
1. Get yourself a Vim of version 8+ installed and make sure to have git installed and present on your path as well
2. Create a `~/.vimrc` file (or `~/_vimrc` if you're on Windows)
3. Without such file there were sourced defaults by the Vim authors, but once it's created, we have to put them back explicitly by adding those lines in and saving changes <kbd>:w</kbd>:
3. Without such a file, there were sourced defaults by the Vim authors, but once it's created, we have to put them back explicitly by adding those lines in and saving changes <kbd>:w</kbd>:

```vim
unlet! skip_defaults_vim
source $VIMRUNTIME/defaults.vim
```

4. While we're here, let's add some `tact.vim`-specific stuff in as well. This time save and quit as we no longer need to add anything (<kbd>:wq</kbd>):
4. While here, let's add some `tact. vim'- specific stuff. This time save and quit as we no longer need to add anything (<kbd>:wq</kbd>):

```vim
let g:tact_style_guide = 1 " Enabling default indentation style
Expand All @@ -54,7 +54,7 @@ let g:tact_style_guide = 1 " Enabling default indentation style
inoremap <silent> <c-space> <c-x><c-o> " Open completion menu on ctrl-space
```

Note: on macOS the `<c-space>` is already bound in the system, so unless the terminal intercepts it you'll have to use a different keybinding.
Note: on macOS, the `<c-space>` is already bound in the system, so unless the terminal intercepts it, you'll have to use a different keybinding.

5. It's also nice to source in the extended defaults provided by the [tpope/vim-sensible](https://github.com/tpope/vim-sensible). To do so, let's use the built-in package manager:

Expand Down Expand Up @@ -86,7 +86,7 @@ git clone 'https://github.com/tact-lang/tact.vim.git' $HOME\vimfiles\pack\tact-l
vim -u NONE -c 'helptags $HOME\vimfiles\pack\tact-lang\start\tact\doc' -c q
```

7. Start the Vim in the [valid Tact project](https://docs.tact-lang.org/) to be able to use `:Tact` command for easy compilation or simply provide any `.tact` file otherwise. Happy coding 🚀
7. Start the Vim in the [valid Tact project](https://docs.tact-lang.org/) to use the `:Tact` command for easy compilation or otherwise provide any `.tact` file. Happy coding 🚀

</details>

Expand All @@ -95,7 +95,7 @@ vim -u NONE -c 'helptags $HOME\vimfiles\pack\tact-lang\start\tact\doc' -c q
<details>
<summary>Click to see</summary>

This is the recommended installation method if you use at least Vim 8 and you don't use another package manager.
It is the recommended installation method if you use at least Vim 8 and you don't use another package manager.
More about Vim's built-in package manager: [`:help packages`](https://vimhelp.org/repeat.txt.html#packages).

For Linux/macOS:
Expand Down Expand Up @@ -199,9 +199,9 @@ Get an official one here: [tact-language-server](https://github.com/tact-lang/ta

### Completion

By default this plugin sets an `omnifunc` option to provide auto-completions by triggering <kbd>CTRL-x</kbd><kbd>CTRL-o</kbd> in INSERT mode. However, if you're using an LSP client for Tact language, it may overwrite this option and disable the completion and basic linting capabilities provided by this plugin alongside of it.
By default this plugin sets an `omnifunc` option to provide auto-completions by triggering <kbd>CTRL-x</kbd><kbd>CTRL-o</kbd> in INSERT mode. However, if you're using an LSP client for Tact language, it may overwrite this option and turn off the completion and basic linting capabilities provided by this plugin alongside it.

In order to prevent that behaviour you may want to bind completion features of this plugin to a `competefunc` option (which is quite conveniently triggered by <kbd>CTRL-x</kbd><kbd>CTRL-u</kbd> in INSERT mode). Add the following to your `~/.vimrc` (or `~/_vimrc` on Windows) if you'd like to prefer and bind `completefunc` over `omnifunc`:
To prevent that behavior, you may want to bind the completion features of this plugin to a `competefunc` option (which is quite conveniently triggered by <kbd>CTRL-x</kbd><kbd>CTRL-u</kbd> in INSERT mode). Add the following to your `~/.vimrc` (or `~/_vimrc` on Windows) if you'd like to prefer and bind `completefunc` over `omnifunc`:

```vim
" CTRL-x CTRL-u instead of CTRL-x CTRL-o
Expand Down Expand Up @@ -236,7 +236,7 @@ require('lazy').setup({

### Indentation

Add the following to your `~/.vimrc` (or `~/_vimrc` on Windows) to enable preferred indentation style for Tact:
Add the following to your `~/.vimrc` (or `~/_vimrc` on Windows) to enable the preferred indentation style for Tact:

```vim
let g:tact_style_guide = 1
Expand Down Expand Up @@ -270,7 +270,7 @@ require('lazy').setup({

### Highlighting

If you want to disable highlighting of identifiers: variables and constants (but not structures), add the following option:
If you want to turn off highlighting of identifiers: variables, and constants (but not structures), add the following option:

```vim
let g:tact_blank_identifiers = 1
Expand Down Expand Up @@ -302,7 +302,7 @@ require('lazy').setup({

</details>

To disable highlighting of structures (names of traits, messages, contracts and structs), add the following:
To turn off highlighting of structures (names of traits, messages, contracts, and structs), add the following:

```vim
let g:tact_blank_structures = 1
Expand Down Expand Up @@ -336,11 +336,11 @@ require('lazy').setup({

### Formatting

Basic code formatting can be done by a series of Vim motions: `gg=G` (plus <kbd>Ctrl-o</kbd> twice to return to the original cursor position), or by invoking a `:TactFmt` command, which does all that for you *without* messing up with your cursor. Use both with caution, as Vim-native indentation handling is known to be prone to errors.
A series of Vim motions can do basic code formatting: `gg=G` (plus <kbd>Ctrl-o</kbd> twice to return to the original cursor position) or by invoking a `:TactFmt` command, which does all that for you *without* messing up with your cursor. Use both with caution, as Vim-native indentation handling is known to be prone to errors.

### Folding

To enable code-folding add the following snippet. This one might have an impact on editing performance, proceed with
To enable code-folding, add the following snippet. This one might have an impact on editing performance; proceed with
caution:

```vim
Expand All @@ -357,14 +357,14 @@ Make a `~/.config/nvim/after/ftplugin` directory (`~/AppData/Local/nvim/after/ft

```lua
vim.opt.foldmethod = "syntax"
vim.opt.foldenable = false -- disables automatic folding on file opening
vim.opt.foldenable = false -- turn off automatic folding on file opening
```

</details>

### Abbreviations

To trigger an abbreviation, type it in followed by punctuation such as a space or comma, and it would get expanded into a code snippet. It's advised to use space for this as it usually produces best results.
To trigger an abbreviation, type it in followed by punctuation such as a space or comma, and it will expand into a code snippet. It's advised to use space for this, as it usually produces the best results.

These abbreviations (and auto-completions of their names) are available right away:

Expand All @@ -378,7 +378,7 @@ These abbreviations (and auto-completions of their names) are available right aw
1. `a_me` — expands to the message declaration
1. `a_se` — expands to send(SendParameters{...}) call

**Keep in mind** that abbreviations are always there and you can always type them in, even if they're not shown by omnicompletion when deemed not suitable for the current completion context.
**Keep in mind** that abbreviations are always there, and you can always type them in, even if they're not shown by omnicompletion when deemed unsuitable for the current completion context.

To avoid expansion in INSERT mode, type Ctrl-V after the last character of the abbreviation (on Windows, type Ctrl-Q instead of Ctrl-V).

Expand Down Expand Up @@ -416,7 +416,7 @@ require('lazy').setup({

### Linting

Simply run `:Tact` command to try to compile using Tacts' compiler and look for errors. See [Usage section](#usage) for more info on the command.
Simply run the `:Tact` command to try compiling using Tacts' compiler and look for errors. See the [Usage section](#usage) for more info on the command.

### Miscellaneous

Expand All @@ -436,18 +436,18 @@ vim.keymap.set('i', '<c-space>', '<c-x><c-o>', { noremap = true, silent = true})

</details>

Note, that on macOS there's a default system-wide keyboard shortcut for <kbd>Ctrl</kbd><kbd>Space</kbd> (`^space`). You may want to change it to be <kbd>Cmd</kbd><kbd>Space</kbd> instead or use the different binding in Vim.
Note that on macOS, there's a default system-wide keyboard shortcut for <kbd>Ctrl</kbd><kbd>Space</kbd> (`^space`). You may want to change it to <kbd>Cmd</kbd><kbd>Space</kbd> instead or use the different binding in Vim.

At times when omnicompletion (<kbd>CTRL-x</kbd><kbd>CTRL-o</kbd>) can't complete much it fallbacks to keyword completion (<kbd>CTRL-x</kbd><kbd>CTRL-n</kbd>). But that's not always the case, so if omnicompletion doesn't show anything, try keyword one!

## Usage

For your convenience there's a `:Tact` command available whenever you open any `.tact` files. It tries to run the `build` script from your `package.json` project file, which, as shown in [this official example here](https://docs.tact-lang.org/start#getting-started-from-scratch), should invoke a Tact compiler. You're expected to have a Node.js of the current LTS (or later) version installed on your system, alongside of `npm` for the `:Tact` command to work.
For your convenience, a `:Tact` command is available whenever you open any `.tact` files. It tries to run the `build` script from your `package.json` project file, which, as shown in [this official example here](https://docs.tact-lang.org/start#getting-started-from-scratch), should invoke a Tact compiler. You're expected to have a Node.js of the current LTS (or later) version installed on your system, alongside `npm` for the `:Tact` command to work.

It's generally recommended to go over the [example](https://docs.tact-lang.org/start#getting-started-from-scratch), as it shows how to get started with Tact.
Alternatively, use the [official project template](https://github.com/tact-lang/tact-template): either copy or create a new repository based off of it.
It's generally recommended that you go over the [example](https://docs.tact-lang.org/start#getting-started-from-scratch), which shows how to get started with Tact.
Alternatively, use the [official project template](https://github.com/tact-lang/tact-template ): either copy it or create a new repository based on it.

Wish you good luck and fun exploring Tact! ⚡
We wish you good luck and fun exploring Tact! ⚡

## Useful Tact links

Expand Down
Loading