feat(tolk): add experimental Tolk formatter (#43)

Fixes #44

Author: i582

package.json

@@ -493,6 +493,21 @@
                         "description": "Automatically open decompiled Fift assembly when opening BoC files"
                     }
                 }
+            },
+            {
+                "title": "Formatter",
+                "properties": {
+                    "ton.tolk.formatter.useFormatter": {
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Use experimental Tolk formatter"
+                    },
+                    "ton.tolk.formatter.sortImports": {
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Sort imports on format"
+                    }
+                }
             }
         ],
         "customEditors": [
@@ -530,6 +545,7 @@
         "@ton/core": "0.60.1",
         "@ton/crypto": "^3.3.0",
         "glob": "^11.0.1",
+        "tolkfmt-test-dev": "0.0.12",
         "ton-assembly-test-dev": "0.0.16",
         "vscode-languageclient": "^8.0.2",
         "vscode-languageserver": "^8.0.2",

server/src/languages/tolk/format/format.ts

@@ -0,0 +1,46 @@
+import {Range} from "vscode-languageserver-textdocument"
+import * as lsp from "vscode-languageserver"
+import {findTolkFile} from "@server/files"
+import {format} from "tolkfmt-test-dev/dist/src"
+import {createTolkParser} from "@server/parser"
+
+export async function formatTolkFile(
+    uri: string,
+    range: Range | undefined,
+    options: {
+        readonly useFormatter: boolean
+        readonly sortImports: boolean
+    },
+): Promise<lsp.TextEdit[] | null> {
+    if (!options.useFormatter) return null
+
+    const file = await findTolkFile(uri)
+
+    const formatted = await format(file.content, {
+        parser: createTolkParser(),
+        range,
+        sortImports: options.sortImports,
+    })
+
+    if (formatted === file.content) {
+        // already formatted
+        return null
+    }
+
+    const lines = file.content.split("\n")
+    return [
+        {
+            range: {
+                start: {
+                    line: 0,
+                    character: 0,
+                },
+                end: {
+                    line: lines.length,
+                    character: (lines.at(-1) ?? "").length,
+                },
+            },
+            newText: formatted,
+        },
+    ]
+}

server/src/server.ts

@@ -118,6 +118,7 @@ import {
 } from "@server/languages/func/rename/file-renaming"
 import {IndexingRootKind} from "@server/indexing/indexing"
 import {FuncIndexingRoot} from "@server/languages/func/indexing-root"
+import {formatTolkFile} from "@server/languages/tolk/format/format"
 
 /**
  * Whenever LS is initialized.
@@ -1021,6 +1022,34 @@ connection.onInitialize(async (initParams: lsp.InitializeParams): Promise<lsp.In
         return [...provideTolkWorkspaceSymbols(), ...provideFuncWorkspaceSymbols()]
     })
 
+    connection.onRequest(
+        lsp.DocumentFormattingRequest.type,
+        async (params: lsp.DocumentFormattingParams): Promise<lsp.TextEdit[] | null> => {
+            const uri = params.textDocument.uri
+            const settings = await getDocumentSettings(uri)
+
+            if (isTolkFile(uri)) {
+                return formatTolkFile(uri, undefined, settings.tolk.formatter)
+            }
+
+            return null
+        },
+    )
+
+    connection.onRequest(
+        lsp.DocumentRangeFormattingRequest.type,
+        async (params: lsp.DocumentRangeFormattingParams): Promise<lsp.TextEdit[] | null> => {
+            const uri = params.textDocument.uri
+            const settings = await getDocumentSettings(uri)
+
+            if (isTolkFile(uri)) {
+                return formatTolkFile(uri, params.range, settings.tolk.formatter)
+            }
+
+            return null
+        },
+    )
+
     // Custom LSP requests
 
     connection.onRequest(
@@ -1045,6 +1074,7 @@ connection.onInitialize(async (initParams: lsp.InitializeParams): Promise<lsp.In
         capabilities: {
             textDocumentSync: lsp.TextDocumentSyncKind.Incremental,
             documentFormattingProvider: true,
+            documentRangeFormattingProvider: true,
             documentSymbolProvider: true,
             workspaceSymbolProvider: true,
             definitionProvider: true,

server/src/settings/settings.ts

@@ -44,6 +44,10 @@ export interface TolkSettings {
         readonly typeAware: boolean
         readonly addImports: boolean
     }
+    readonly formatter: {
+        readonly useFormatter: boolean
+        readonly sortImports: boolean
+    }
 }
 
 export interface FuncSettings {
@@ -93,6 +97,10 @@ const tolkDefaultSettings: TolkSettings = {
         typeAware: true,
         addImports: true,
     },
+    formatter: {
+        useFormatter: true,
+        sortImports: true,
+    },
 }
 
 const defaultSettings: ServerSettings = {
@@ -159,6 +167,14 @@ function mergeSettings(vsSettings: Partial<ServerSettings>): ServerSettings {
                     vsSettings.tolk?.completion.addImports ??
                     defaultSettings.tolk.completion.addImports,
             },
+            formatter: {
+                useFormatter:
+                    vsSettings.tolk?.formatter.useFormatter ??
+                    defaultSettings.tolk.formatter.useFormatter,
+                sortImports:
+                    vsSettings.tolk?.formatter.sortImports ??
+                    defaultSettings.tolk.formatter.sortImports,
+            },
         },
         func: {
             hints: {

yarn.lock

@@ -7502,6 +7502,19 @@ __metadata:
   languageName: node
   linkType: hard
 
+"tolkfmt-test-dev@npm:0.0.12":
+  version: 0.0.12
+  resolution: "tolkfmt-test-dev@npm:0.0.12"
+  dependencies:
+    cac: "npm:^6.7.14"
+    glob: "npm:^10.3.10"
+    web-tree-sitter: "npm:^0.25.6"
+  bin:
+    tolkfmt: bin/tolkfmt
+  checksum: 10c0/3cba34d27ad6bdea60e3d39576d5c7386ed28406e98219f0a01dc59270d8f76d105a1ece90fdaa4f22f5f0dc178af14da92748f7424fa96de415161891fb5113
+  languageName: node
+  linkType: hard
+
 "ton-assembly-test-dev@npm:0.0.16":
   version: 0.0.16
   resolution: "ton-assembly-test-dev@npm:0.0.16"
@@ -8006,6 +8019,7 @@ __metadata:
     jest: "npm:^29.7.0"
     mocha: "npm:^10.3.0"
     prettier: "npm:3.4.2"
+    tolkfmt-test-dev: "npm:0.0.12"
     ton-assembly-test-dev: "npm:0.0.16"
     tree-sitter-cli: "npm:^0.25.0"
     ts-jest: "npm:^29.2.6"
@@ -8058,10 +8072,10 @@ __metadata:
   languageName: node
   linkType: hard
 
-"web-tree-sitter@npm:^0.25.0":
-  version: 0.25.1
-  resolution: "web-tree-sitter@npm:0.25.1"
-  checksum: 10c0/0b94c7488d8196d9c9019e50903088705b4f659ae182153461d9819e6eec921941c4866dace43e698f09e800ac4de3cfc19ca85caa1dee52db54135213412ded
+"web-tree-sitter@npm:^0.25.0, web-tree-sitter@npm:^0.25.6":
+  version: 0.25.7
+  resolution: "web-tree-sitter@npm:0.25.7"
+  checksum: 10c0/75799ec043455364c1f24a8d4a1bb94b22cbf655b109fdc72038d661a6224ee99f313e44625758dec59a5192aab4ba53315745c3cc86ca4c524e74a247b4d964
   languageName: node
   linkType: hard