tact-lang / tact-sublime Goto Github PK

See: https://github.com/digitalcora/sublime-text-gleam/blob/main/.github/workflows/ci.yml

That runs the special headless Sublime Text build made for running tests on syntax highlighting. Those tests share the common ground with tests of tree-sitter-tact.

Plan:

• Convert tree-sitter-tact capture names to Sublime's
• Run tests locally
• Add a CI for Github

Useful links:

• https://www.sublimetext.com/docs/syntax.html#testing
• https://github.com/SublimeText/PackageDev/wiki/Syntax-Tests
• https://forum.sublimetext.com/t/quickly-adding-syntax-tests-using-keyboard-shortcuts/66382
• SublimeText/PackageDev#383
• https://github.com/SublimeText/UnitTesting?tab=readme-ov-file
• https://github.com/SublimeText/syntax-test-action

See: https://github.com/tact-lang/tact/blob/main/CHANGELOG.md

Useful links:

• https://github.com/kkos/oniguruma/blob/master/doc/RE
• https://docs.sublimetext.io/guide/extensibility/syntaxdefs.html
• https://github.com/shikijs/textmate-grammars-themes

1. Type-related things are colored the same as keywords, which shouldn't be happening
2. Some operators are not highlighted properly (+, *, -, %)

[Sublime]:

[VSCode]:

That one: tact-extracted-ls

Simple example: https://github.com/savva425/func_plugin_sublimetext3

Other useful links:

• https://www.sublimetext.com/docs/api_reference.html
• https://docs.sublimetext.io/reference/python_api.html
• https://docs.tact-lang.org/ref

Sublime Text 3+ can use the .tmLanguage format, which is a fancy xml, essentially.
Sublime Text 4+ uses a newer, .sublime-syntax format, which is a fancy yaml.

While both use Oniguruma RegExp engine and TextMate-like captures, their approaches slightly differ, with the former being almost 1-to-1 representation of the tact.tmLanguage.json but in the xml form.

Therefore, all that's needed here is to:

• Setup the conversion from json form to xml or vice-versa — for example, this VSCode plugin can be used to convert from the .tmLanguage.json JSON (for tact-vscode, tact-docs, Nujan & others) to .tmLanguage PLIST/XML (for Sublime)
• Re-organize the current highlighting structure (of json file) to make it more suitable for tact-docs

This repo shall become public before approaching this issue, but after completing those:

• #1
• #2
• #3
• #4
• #6
• #9

Useful links:

• https://packagecontrol.io/docs/submitting_a_package
• https://raw.githubusercontent.com/wbond/package_control/master/example-repository.json

• an animated gif showcasing the plugin
• short text about the most interesting features
• link to this repo
• how to install it
• author credit

To be resolved by #15:

• Bitwise NOT ~
• New augmented assignment operators: |=, &=, ^=
• Underscores _ as unused variable identifiers
• Local type inference for let statements
• nativeThrowWhen renamed to nativeThrowIf

Other things:

• Create a new release

• Add a banner image like seen in tact.vim
• Add images or gifs showcasing various features of the package (at least two images for showcasing syntax highlighting)
• Update descriptions

• Capture Reserve... and Send... constants from the core as constants, not as entity.name.type. Try to capture self.storageReserve as a constant too, which requires a change of highlighting identifiers standing after const keyword.
• Mark identifiers starting with __gen and __tact as invalid to somewhat prohibit users from using them.
• Fix if...else, try...catch and do...until highlighting -- that's needed for docs and won't affect regular users.
• Put additional restrictions on init, receive, external and bounced to have an open parenthesis ( right after it

Add tests for each of those points.

See examples: https://github.com/sublimehq/Packages