tact-lang / tact.vim Goto Github PK

And sourcing it from the "legacy" vim script, see: https://vimhelp.org/usr_52.txt.html#52.5

1. Set makeprg to match builds with and without Blueprint
2. Set errormsg to match error messages coming from those builds.
3. Fill quickfix list with messages from the compiler (and provide better tools/mappings for using this list), see: https://github.com/vim/vim/blob/v8.2.5172/runtime/doc/quickfix.txt

Additionally, consider using @tact-lang/compiler or its CLI for:

1. Inference and suggestions
2. Error handling
3. Builds

Moreover, try introducing an auto-generation or basic help with tact.config.json. Suggest using JSON Schema.

Only search for =, but not until ; to prevent mishandling where the expression in the right side of the let statement spans multiple lines.

Additionally and in the future, consider updating all regexes to use \m by default, such that it can't be overriden in user settings:

• https://vimdoc.sourceforge.net/htmldoc/pattern.html#/magic
• https://vim.fandom.com/wiki/Simplifying_regular_expressions_using_magic_and_no-magic

Problems with current RegExp-based parsing

• it's too brittle
• it's incomplete and won't be able to compete with proper parsing algorithms (although it manages to provide better completions than current VSCode plugin somehow :)
• it's rather slow, with delays for completion starting somewhere at 1,000 LoC of Tact or even earlier, which is certainly possible for large-enough contracts

Proposed solution

The idea is to quickly iterate on the new LL+Pratt parser in this plugin not to disturb the main compiler's workflow. It may come without handling comments or very nice error messages, but it will be robust and capable of doing a lot already. And it would be easier to maintain compared to the RegExp one.

Futhermore, it's main aim is to provide a sufficient groundwork to implementing a production-grade one for the Tact compiler and the language server. Until then and beyond that, we'll continue to hone the compiler APIs as they are, of course.

Addtionally, it's worth mentioning that it's already possible to use the extracted language server alongside this plugin and that'll still be possible in the future even when the new parser arrives there as well.

Goals to hit

• Error-resilience: parser should be able to work with broken code, which is primary state of the code in editors :)
• Incremental parsing: only new things have to get parsed, not the whole tree every single time
• Good-enough error reporting: the main thing for editors is fast and up-to-date error-reporting, not the accuracy of them. Although that will be worked on later in the compiler.

P.S.: Easier to start with moving the symbol indexing out of the auto-completion. And using some standard, like LSIF or SCIP (yay!) — https://github.com/sourcegraph/scip. Also, debounce and do updates of that index in the background.

For users to be able to specify dev/nightly/main for the latest updates and stable/release (or a particular Tact version tag). Then, update all the plugin configurations in the README.md and in docs, when they arrive in #7.

Otherwise, everyone's going to get the dev Tact syntax, which is ahead of the released ones, because I plan on keeping all the editor integrations of my creation (this one, soon-to-be-made Sublime Text package, and possibly others) and tree-sitter-tact in sync with the main branch of Tact compiler.

UPD: Consider adding a message on start-up if the flag let g:tact_prefer_legacy is not set — "Tact.vim was drastically updated and integrated with an LSP. Please, refer to instructions in README.md on https://github.com/tact-lang/tact.vim"

See: tact-lang/tact-vscode#31

In general, this would include wrapping ton-org/sandbox with some auto-generated tests and providing a nice set of in-editor panels and/or commands to quickly run and check values.

Depends on:

• #10
• #11

See:

• panvimdoc https://github.com/kdheepak/panvimdoc
• https://github.com/kdheepak/panvimdoc/blob/main/panvimdoc.sh
• ci https://github.com/folke/lazy.nvim/blob/main/.github/workflows/ci.yml
• basic example https://github.com/folke/ts-comments.nvim

Note, that this may require having a DOCS.md for documentation and README.md for presentation (and fancy gifs, #16)

A basic test would be to install everything, including Tact and tact.vim and run some command(s) on a sample contract to make sure we have reproducible installation instructions for Linux/Windows/macOS.

And maybe some other tests for plugin functionality would be be great to have.

Depends on #7.

See how they did it:

• https://github.com/tpope/vim-scriptease
• https://github.com/tpope/vim-rails
• https://github.com/vim-ruby/vim-ruby
• https://github.com/fatih/vim-go

This can also try to use tact doc (once it arrives) to add additional documentation for existing things or tact language-server for hover window (integrate with vim-lsp plugin).

Which sometimes causes seemingly unrelated bugs, where contract functions are misrecognized as global functions. And this is causes issues in autocompletion.

Related issue:

• tact-lang/tact-vscode#25

It would be nice for the docs to be self-contained

It's a big overwhelming to read even when you know all the ins and outs.

Omnicompletion seemingly fails (E486: Pattern not found) without showing my error messages ('Prohibited get modifier for the native function on line X' and such).

Debug this fully and make custom error messages show at all times and not only when running echo tact#Complete(0,0)!

See:

• https://www.reddit.com/r/vim/comments/14l8egx/i_stopped_struggling_with_getting_omnifunc_to/
• fatih/vim-go#2279

Related issues:

• tact-lang/tact-vscode#24
• tact-lang/tree-sitter-tact#4

This may help with inference, and thus would remove most of the dirty regex work.

UPD: It should be really done in LSP, then re-used here alongside with the current options (which may then be called "legacy")

Hi there,

Would you please update README and show instruction for setup it up in Nvim,
specifically by modern package manager like Lazyvim.

Thank you in advance.

Related issues:

• tact-lang/tact-vscode#26
• tact-lang/tree-sitter-tact#5

Related issues:

• tact-lang/tact-vscode#27
• tact-lang/tree-sitter-tact#6

Or with a pop-up window, see:

• https://vimhelp.org/popup.txt.html
• https://vi.stackexchange.com/questions/24462/what-are-the-new-popup-windows-in-vim-8-2
• https://github.com/prabirshrestha/vim-lsp/blob/f7ccf006df1aefd327c0e2c55cc8632a2db577c1/autoload/lsp/ui/vim/output.vim

highlighting quickfix errors inline and adding signs:

• https://www.reddit.com/r/vim/comments/2vw4ts/quickfix_buffer_error_highlighting/
• https://github.com/bfrg/vim-qf-diagnostics
• https://vi.stackexchange.com/questions/25035/highlight-results-of-grep-while-in-quickfix-window
• https://github.com/jceb/vim-hier
• https://github.com/MarcWeber/vim-addon-signs
• https://github.com/dhruvasagar/vim-markify

In order to make completion comprehensive and users more aware of standard library capabilities.

Depends on tact-lang/tact-docs#75

See: https://github.com/tact-lang/tact/blob/main/CHANGELOG.md
Upstream checklist: tact-lang/tact#280

To do:

• Auto-import all from @stdlib/ownable when @stdlib/stoppable is imported
• Support escape sequences for strings (highlight them differently)
• Implicit init function
• Support trailing commas in all comma-separated lists
• Add new functions: (log and log2, concat method on StringBuilder, toString method/extension function for Address type, isEmpty and del extension functions for maps),
• The pow2 power function with base 2
• The try and try-catch statements
• Bitwise XOR ^
• Reserve mode constants (and new lib @stdlib/reserve): ReserveExact, ReserveAllExcept, ReserveAtMost, ReserveAddOriginalBalance, ReserveInvertSign, ReserveBounceIfActionFail.
• Add missing dumpStack() function
• Struct & Message field punning
• ??? tact-lang/tact#79