feat(documentation): add tact as language of code blocks for better highlighting in Helix/Neovim (#139)

Author: i582

server/src/documentation/documentation.ts

@@ -5,7 +5,7 @@ import {Node as SyntaxNode} from "web-tree-sitter"
 import {trimPrefix} from "@server/utils/strings"
 
 const CODE_FENCE = "```"
-const DOC_TMPL = `${CODE_FENCE}\n{signature}\n${CODE_FENCE}\n{documentation}\n`
+const DOC_TMPL = `${CODE_FENCE}tact\n{signature}\n${CODE_FENCE}\n{documentation}\n`
 
 /**
  * Returns the documentation for the given symbol in Markdown format, or null

server/src/e2e/suite/testcases/documentation/basic.test

@@ -7,7 +7,7 @@ fun foo() {
     let <caret>value = 10;
 }
 ------------------------------------------------------------------------
-```
+```tact
 let value: Int = 10
 ```
 
@@ -20,7 +20,7 @@ fun foo() {
     let <caret>value: Int = 10;
 }
 ------------------------------------------------------------------------
-```
+```tact
 let value: Int = 10
 ```
 
@@ -34,7 +34,7 @@ fun foo() {
     foreach (<caret>key, value in map) {}
 }
 ------------------------------------------------------------------------
-```
+```tact
 let key: Int
 ```
 
@@ -48,7 +48,7 @@ fun foo() {
     foreach (key, <caret>value in map) {}
 }
 ------------------------------------------------------------------------
-```
+```tact
 let value: Int
 ```
 
@@ -61,7 +61,7 @@ fun foo() {
     try {} catch (<caret>error) {}
 }
 ------------------------------------------------------------------------
-```
+```tact
 catch(error)
 ```
 
@@ -74,7 +74,7 @@ fun foo(<caret>param: Int) {
 
 }
 ------------------------------------------------------------------------
-```
+```tact
 param: Int
 ```
 
@@ -89,7 +89,7 @@ fun foo() {
     <caret>FOO;
 }
 ------------------------------------------------------------------------
-```
+```tact
 const FOO: Int = 100
 ```
 
@@ -106,7 +106,7 @@ contract Foo {
     }
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 const FOO: Int = 100
 ```
@@ -120,7 +120,7 @@ contract Foo {
     const FOO: <caret>Int = 100;
 }
 ------------------------------------------------------------------------
-```
+```tact
 primitive Int
 ```
 
@@ -133,7 +133,7 @@ Top level file comment
 contract <caret>Foo {
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 ```
 And this is documentation comment
@@ -147,7 +147,7 @@ Line separator in comment
 contract <caret>Foo {
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 ```
 Some comment. And other!

server/src/e2e/suite/testcases/documentation/contracts.test

@@ -7,7 +7,7 @@ contract <caret>Foo {
     value: Int;
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 ```
 Some cool contract
@@ -23,7 +23,7 @@ contract <caret>Foo with Other {
     value: Int;
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo with Other
 ```
 Some cool contract
@@ -36,7 +36,7 @@ contract Foo {
     get fun <caret>foo() {}
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 get fun foo()
 ```
@@ -52,7 +52,7 @@ contract Foo {
     fun <caret>foo() {}
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 fun foo()
 ```
@@ -71,7 +71,7 @@ contract Foo {
     }
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 field: Int
 ```
@@ -89,7 +89,7 @@ contract Foo {
     }
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 field: Int = 0
 ```
@@ -107,7 +107,7 @@ contract Foo {
     }
 }
 ------------------------------------------------------------------------
-```
+```tact
 contract Foo
 const FOO: Int = 0
 ```
@@ -127,7 +127,7 @@ contract Foo with WithFoo {
     }
 }
 ------------------------------------------------------------------------
-```
+```tact
 trait WithFoo
 const FOO: Int = 0
 ```

server/src/e2e/suite/testcases/documentation/functions.test

@@ -9,17 +9,17 @@ native <caret>test3();
 
 native <caret>test4();
 ------------------------------------------------------------------------
-```
+```tact
 fun test1()
 ```
-```
+```tact
 extends fun test2()
 ```
-```
+```tact
 @name(__foo)
 native test3()
 ```
-```
+```tact
 native test4()
 ```
 
@@ -31,7 +31,7 @@ primitive Int;
 
 fun <caret>test(name: String, age: Int) {}
 ------------------------------------------------------------------------
-```
+```tact
 fun test(name: String, age: Int)
 ```
 
@@ -43,7 +43,7 @@ primitive Int;
 
 fun <caret>test(name: String): String {}
 ------------------------------------------------------------------------
-```
+```tact
 fun test(name: String): String
 ```
 
@@ -53,11 +53,11 @@ Asm function documentation
 asm fun <caret>test() { ONE TWO THREE }
 asm(self other) fun <caret>test() { b{00} PUSHSLICE }
 ------------------------------------------------------------------------
-```
+```tact
 asm fun test() { ONE TWO THREE }
 ```
 Gas: `~36`
-```
+```tact
 asm(self other) fun test() { b{00} PUSHSLICE }
 ```
 Gas: `~22`
@@ -67,7 +67,7 @@ Asm function documentation with one line body
 ========================================================================
 asm fun <caret>test() { ONE }
 ------------------------------------------------------------------------
-```
+```tact
 asm fun test() { ONE }
 ```
 Gas: `18`
@@ -79,7 +79,7 @@ asm fun <caret>test() {
     ONE
 }
 ------------------------------------------------------------------------
-```
+```tact
 asm fun test()
 ```
 Gas: `18`
@@ -92,7 +92,7 @@ fun <caret>test() {
     test();
 }
 ------------------------------------------------------------------------
-```
+```tact
 fun test()
 ```
 This is one line comment
@@ -105,7 +105,7 @@ fun <caret>test() {
     test();
 }
 ------------------------------------------------------------------------
-```
+```tact
 fun test()
 ```
 This is one line comment
@@ -138,7 +138,7 @@ Function documentation with complex /// doc comment
 ///
 asm fun <caret>getOriginalFwdFee(fwdFee: Int, isMasterchain: Bool): Int { GETORIGINALFWDFEE }
 ------------------------------------------------------------------------
-```
+```tact
 asm fun getOriginalFwdFee(fwdFee: Int, isMasterchain: Bool): Int { GETORIGINALFWDFEE }
 ```
 

server/src/e2e/suite/testcases/documentation/structs.test

@@ -7,7 +7,7 @@ struct <caret>Foo {
     value: Int;
 }
 ------------------------------------------------------------------------
-```
+```tact
 struct Foo {
     name: String;
     value: Int;
@@ -24,7 +24,7 @@ message <caret>Foo {
     value: Int;
 }
 ------------------------------------------------------------------------
-```
+```tact
 message Foo {
     name: String;
     value: Int;
@@ -41,7 +41,7 @@ message(0x178d4519) <caret>Foo {
     value: Int;
 }
 ------------------------------------------------------------------------
-```
+```tact
 message(0x178d4519) Foo {
     name: String;
     value: Int;
@@ -62,7 +62,7 @@ fun foo() {
     let f = Foo { <caret>field: 10 };
 }
 ------------------------------------------------------------------------
-```
+```tact
 struct Foo
 field: Int
 ```
@@ -81,7 +81,7 @@ fun foo() {
     f.<caret>field;
 }
 ------------------------------------------------------------------------
-```
+```tact
 struct Foo
 field: Int
 ```
@@ -100,7 +100,7 @@ fun foo() {
     f.<caret>field;
 }
 ------------------------------------------------------------------------
-```
+```tact
 message Foo
 field: Int
 ```
@@ -119,7 +119,7 @@ fun foo() {
     f.<caret>field;
 }
 ------------------------------------------------------------------------
-```
+```tact
 struct Foo
 field: Int = 0
 ```
@@ -137,7 +137,7 @@ fun foo() {
     let f = Foo { <caret>field: 10 };
 }
 ------------------------------------------------------------------------
-```
+```tact
 struct Foo
 field: Int as uint8
 ```
@@ -155,7 +155,7 @@ fun foo() {
     let f = Foo { <caret>field: 10 };
 }
 ------------------------------------------------------------------------
-```
+```tact
 struct Foo
 field: Slice as remaining
 ```
@@ -173,7 +173,7 @@ fun foo() {
     let f = Foo { <caret>field: 10 };
 }
 ------------------------------------------------------------------------
-```
+```tact
 struct Foo
 field: map<Int as uint8, Int>
 ```

server/src/e2e/suite/testcases/documentation/traits.test

@@ -7,7 +7,7 @@ trait <caret>Foo {
     value: Int;
 }
 ------------------------------------------------------------------------
-```
+```tact
 trait Foo
 ```
 Some cool trait
@@ -23,7 +23,7 @@ trait <caret>Foo with Other {
     value: Int;
 }
 ------------------------------------------------------------------------
-```
+```tact
 trait Foo with Other
 ```
 Some cool trait
@@ -37,7 +37,7 @@ trait Foo {
     <caret>field: Int;
 }
 ------------------------------------------------------------------------
-```
+```tact
 trait Foo
 field: Int
 ```