feat: add WXML formatting support

Author: LastLeaf

src/formatting.rs

@@ -0,0 +1,48 @@
+use glass_easel_template_compiler::stringify::{Stringifier, StringifyOptions};
+use lsp_types::{DocumentFormattingParams, TextEdit};
+
+use crate::ServerContext;
+
+pub(crate) async fn formatting(
+    ctx: ServerContext,
+    params: DocumentFormattingParams,
+) -> anyhow::Result<Vec<TextEdit>> {
+    let ret = ctx
+        .clone()
+        .project_thread_task(
+            &params.text_document.uri,
+            move |project, abs_path| -> anyhow::Result<Vec<TextEdit>> {
+                let ret = match abs_path.extension().and_then(|x| x.to_str()) {
+                    Some("wxml") => {
+                        let template = project.get_wxml_tree(&abs_path)?;
+                        let options = StringifyOptions {
+                            tab_size: params.options.tab_size,
+                            use_tab_character: !params.options.insert_spaces,
+                            ..Default::default()
+                        };
+                        let mut out = String::new();
+                        Stringifier::new(&mut out, "", "", options)
+                            .run(template)?;
+                        let text_edit = TextEdit {
+                            range: lsp_types::Range {
+                                start: lsp_types::Position {
+                                    line: 0,
+                                    character: 0,
+                                },
+                                end: lsp_types::Position {
+                                    line: u32::MAX,
+                                    character: u32::MAX,
+                                },
+                            },
+                            new_text: out,
+                        };
+                        vec![text_edit]
+                    }
+                    _ => vec![],
+                };
+                Ok(ret)
+            },
+        )
+        .await??;
+    Ok(ret)
+}

src/lib.rs

@@ -8,6 +8,7 @@ mod completion;
 mod context;
 mod file;
 mod folding;
+mod formatting;
 mod hover;
 mod logger;
 mod reference;
@@ -76,6 +77,8 @@ fn server_capabilities() -> lsp_types::ServerCapabilities {
                 },
             ),
         ),
+        document_formatting_provider: Some(lsp_types::OneOf::Left(true)),
+        // document_range_formatting_provider: Some(lsp_types::OneOf::Left(true)),
         workspace: Some(lsp_types::WorkspaceServerCapabilities {
             workspace_folders: Some(lsp_types::WorkspaceFoldersServerCapabilities {
                 supported: Some(true),
@@ -121,6 +124,7 @@ async fn handle_request(
     handler!("textDocument/completion", completion::completion);
     handler!("textDocument/documentColor", color::color);
     handler!("textDocument/colorPresentation", color::color_presentation);
+    handler!("textDocument/formatting", formatting::formatting);
 
     // method not found
     log::warn!("Missing LSP request handler for {:?}", method);

vscode-extension/src/middleware.ts

@@ -21,14 +21,29 @@ const doCssValidation = async (uri: vscode.Uri, ls: LanguageService) => {
   return ls.doValidation(doc as any, sheet)
 }
 
+const doFormatting = async (
+  uri: vscode.Uri,
+  range: vscode.Range | undefined,
+  options: vscode.FormattingOptions,
+  ls: LanguageService,
+) => {
+  const doc = await vscode.workspace.openTextDocument(uri)
+  return ls.format(doc as any, range, options) as unknown as vscode.TextEdit[]
+}
+
+const selectCssLanguageService = (): LanguageService | null => {
+  const mode = getWxssDiagnostics()
+  if (mode === 'CSS') return cssLangService
+  if (mode === 'LESS') return lessLangService
+  if (mode === 'SCSS') return scssLangService
+  return null
+}
+
 const middleware: Middleware = {
   handleDiagnostics(uri, diagnostics, next) {
     if (path.extname(uri.path) === '.wxss') {
-      const mode = getWxssDiagnostics()
-      if (mode === 'CSS' || mode === 'LESS' || mode === 'SCSS') {
-        let ls: LanguageService = cssLangService
-        if (mode === 'LESS') ls = lessLangService
-        else if (mode === 'SCSS') ls = scssLangService
+      const ls = selectCssLanguageService()
+      if (ls) {
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         doCssValidation(uri, ls)
           // eslint-disable-next-line promise/no-callback-in-promise
@@ -44,6 +59,24 @@ const middleware: Middleware = {
     }
     next(uri, diagnostics)
   },
+
+  provideDocumentFormattingEdits(document, options, token, next) {
+    if (path.extname(document.uri.path) === '.wxss') {
+      const ls = selectCssLanguageService()
+      if (ls) {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        const ret = doFormatting(document.uri, undefined, options, ls)
+          // eslint-disable-next-line promise/no-callback-in-promise
+          .catch(() => {
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            vscode.window.showErrorMessage('Failed to format CSS')
+            return []
+          })
+        return ret
+      }
+    }
+    return next(document, options, token)
+  },
 }
 
 export default middleware