@likec4/language-server 1.30.0 → 1.32.0

package/dist/formatting/LikeC4Formatter.d.ts

@@ -1,9 +1,25 @@
-import { type AstNode } from 'langium';
-import { AbstractFormatter } from 'langium/lsp';
+import { type AstNode, type LangiumDocument } from 'langium';
+import { AbstractFormatter, FormattingRegion } from 'langium/lsp';
+import type { FormattingOptions as LSFormattingOptions, Range, TextEdit } from 'vscode-languageserver-types';
+import type { LikeC4Services } from '../module';
+type QuoteStyle = 'single' | 'double' | 'ignore' | 'auto';
+interface LikeC4FormatterOptions {
+    quoteStyle: QuoteStyle;
+}
+type ExtendedFormattingCommandType = 'normalizeQuotes';
+interface ExtendedFormattingCommand {
+    type: ExtendedFormattingCommandType;
+    region: FormattingRegion;
+}
 export declare class LikeC4Formatter extends AbstractFormatter {
+    protected options: LikeC4FormatterOptions;
+    extendedFormattingCommands: ExtendedFormattingCommand[];
+    constructor(services: LikeC4Services);
+    protected doDocumentFormat(document: LangiumDocument, options: LSFormattingOptions, range?: Range): TextEdit[];
     protected format(node: AstNode): void;
     protected formatTags(node: AstNode): void;
     protected formatDeploymentRelation(node: AstNode): void;
+    protected formatExtendDeployment(node: AstNode): void;
     protected formatRelation(node: AstNode): void;
     protected removeIndentFromTopLevelStatements(node: AstNode): void;
     protected indentContentInBraces(node: AstNode): void;
@@ -15,7 +31,9 @@ export declare class LikeC4Formatter extends AbstractFormatter {
     protected formatAutolayoutProperty(node: AstNode): void;
     protected formatMetadataProperty(node: AstNode): void;
     protected formatElementDeclaration(node: AstNode): void;
+    protected formatExtendElement(node: AstNode): void;
     protected formatGlobals(node: AstNode): void;
+    protected formatImports(node: AstNode): void;
     protected formatSpecificationRule(node: AstNode): void;
     protected formatWithPredicate(node: AstNode): void;
     protected formatDeploymentNodeDeclaration(node: AstNode): void;
@@ -31,4 +49,10 @@ export declare class LikeC4Formatter extends AbstractFormatter {
     protected formatRelationExpression(node: AstNode): void;
     private findPredicateExpressionRoot;
     private on;
+    private doExtendedFormatting;
+    protected normalizeQuotes(node: AstNode): void;
+    private quotesNormalizerFactory;
+    private getAutoQuoteStyle;
+    private onConfigurationUpdate;
 }
+export {};

package/dist/formatting/LikeC4Formatter.js

@@ -1,4 +1,7 @@
-import { GrammarUtils } from "langium";
+import { nonexhaustive } from "@likec4/core";
+import {
+  GrammarUtils
+} from "langium";
 import { AbstractFormatter, Formatting } from "langium/lsp";
 import { filter, isTruthy } from "remeda";
 import * as ast from "../generated/ast.js";
@@ -11,17 +14,37 @@ const FormattingOptions = {
   noIndent: Formatting.noIndent()
 };
 export class LikeC4Formatter extends AbstractFormatter {
+  options = {
+    quoteStyle: "auto"
+  };
+  extendedFormattingCommands = [];
+  constructor(services) {
+    super();
+    services.shared.workspace.ConfigurationProvider.onConfigurationSectionUpdate(
+      (update) => this.onConfigurationUpdate(update.configuration.formatting)
+    );
+  }
+  doDocumentFormat(document, options, range) {
+    this.extendedFormattingCommands = [];
+    const edits = super.doDocumentFormat(document, options, range);
+    this.doExtendedFormatting(edits);
+    return edits;
+  }
   format(node) {
     this.removeIndentFromTopLevelStatements(node);
     this.indentContentInBraces(node);
+    this.normalizeQuotes(node);
+    this.formatImports(node);
     this.formatSpecificationRule(node);
     this.formatGlobals(node);
     this.formatElementDeclaration(node);
+    this.formatExtendElement(node);
     this.formatRelation(node);
     this.formatMetadataProperty(node);
     this.formatDeploymentNodeDeclaration(node);
     this.formatDeployedInstance(node);
     this.formatDeploymentRelation(node);
+    this.formatExtendDeployment(node);
     this.formatView(node);
     this.formatViewRuleGroup(node);
     this.formatViewRuleGlobalStyle(node);
@@ -41,7 +64,8 @@ export class LikeC4Formatter extends AbstractFormatter {
   }
   formatTags(node) {
     this.on(node, ast.isTags, (n, f) => {
-      f.cst(GrammarUtils.findNodesForProperty(n.$cstNode, "values").slice(1)).prepend(FormattingOptions.oneSpace);
+      const tags = GrammarUtils.findNodesForProperty(n.$cstNode, "values").filter((x) => x).slice(1);
+      f.cst(tags).prepend(FormattingOptions.oneSpace);
       f.keywords(",").prepend(FormattingOptions.noSpace).append(FormattingOptions.oneSpace);
     });
   }
@@ -58,6 +82,11 @@ export class LikeC4Formatter extends AbstractFormatter {
       f.properties("title", "technology").prepend(FormattingOptions.oneSpace);
     });
   }
+  formatExtendDeployment(node) {
+    this.on(node, ast.isExtendDeployment, (n, f) => {
+      f.keywords("extend").append(FormattingOptions.oneSpace);
+    });
+  }
   formatRelation(node) {
     this.on(
       node,
@@ -76,8 +105,7 @@ export class LikeC4Formatter extends AbstractFormatter {
     );
     this.on(node, ast.isDynamicViewStep, (n, f) => {
       f.keywords("->", "<-").surround(FormattingOptions.oneSpace);
-      const kind = f.property("kind");
-      kind.nodes[0]?.text.startsWith(".") && kind.surround(FormattingOptions.oneSpace);
+      f.property("dotKind").prepend(FormattingOptions.oneSpace).append(FormattingOptions.oneSpace);
       f.keywords("]->").prepend(FormattingOptions.noSpace).append(FormattingOptions.oneSpace);
       f.keywords("-[").prepend(FormattingOptions.oneSpace).append(FormattingOptions.noSpace);
       f.properties("title").prepend(FormattingOptions.oneSpace);
@@ -90,7 +118,7 @@ export class LikeC4Formatter extends AbstractFormatter {
     }
   }
   indentContentInBraces(node) {
-    if (ast.isLikeC4Lib(node) || ast.isSpecificationRule(node) || ast.isSpecificationElementKind(node) || ast.isSpecificationRelationshipKind(node) || ast.isSpecificationDeploymentNodeKind(node) || ast.isGlobals(node) || ast.isGlobalStyle(node) || ast.isGlobalStyleGroup(node) || ast.isGlobalPredicateGroup(node) || ast.isGlobalDynamicPredicateGroup(node) || ast.isGlobalStyleGroup(node) || ast.isModel(node) || ast.isElementBody(node) || ast.isExtendElementBody(node) || ast.isRelationBody(node) || ast.isRelationStyleProperty(node) || ast.isMetadataBody(node) || ast.isModelViews(node) || ast.isElementViewBody(node) || ast.isDynamicViewBody(node) || ast.isDeploymentViewBody(node) || ast.isViewRuleStyle(node) || ast.isViewRuleGroup(node) || ast.isCustomElementProperties(node) || ast.isCustomRelationProperties(node) || ast.isElementStyleProperty(node) || ast.isDynamicViewParallelSteps(node) || ast.isModelDeployments(node) || ast.isDeploymentNodeBody(node) || ast.isDeploymentRelationBody(node) || ast.isDeployedInstanceBody(node)) {
+    if (ast.isLikeC4Lib(node) || ast.isSpecificationRule(node) || ast.isSpecificationElementKind(node) || ast.isSpecificationRelationshipKind(node) || ast.isSpecificationDeploymentNodeKind(node) || ast.isGlobals(node) || ast.isGlobalStyle(node) || ast.isGlobalStyleGroup(node) || ast.isGlobalPredicateGroup(node) || ast.isGlobalDynamicPredicateGroup(node) || ast.isGlobalStyleGroup(node) || ast.isModel(node) || ast.isElementBody(node) || ast.isExtendElementBody(node) || ast.isRelationBody(node) || ast.isRelationStyleProperty(node) || ast.isMetadataBody(node) || ast.isModelViews(node) || ast.isElementViewBody(node) || ast.isDynamicViewBody(node) || ast.isDeploymentViewBody(node) || ast.isViewRuleStyle(node) || ast.isViewRuleGroup(node) || ast.isCustomElementProperties(node) || ast.isCustomRelationProperties(node) || ast.isElementStyleProperty(node) || ast.isDynamicViewParallelSteps(node) || ast.isModelDeployments(node) || ast.isDeploymentNodeBody(node) || ast.isDeploymentRelationBody(node) || ast.isDeployedInstanceBody(node) || ast.isExtendDeploymentBody(node)) {
       const formatter = this.getNodeFormatter(node);
       const openBrace = formatter.keywords("{");
       const closeBrace = formatter.keywords("}");
@@ -120,7 +148,7 @@ export class LikeC4Formatter extends AbstractFormatter {
     this.on(node, ast.isDeploymentView)?.keywords("deployment", "view").append(FormattingOptions.oneSpace);
   }
   formatLeafProperty(node) {
-    if (ast.isElementStringProperty(node) || ast.isRelationStringProperty(node) || ast.isViewStringProperty(node) || ast.isNotationProperty(node) || ast.isSpecificationElementStringProperty(node) || ast.isSpecificationRelationshipStringProperty(node) || ast.isColorProperty(node) || ast.isLineProperty(node) || ast.isArrowProperty(node) || ast.isIconProperty(node) || ast.isShapeProperty(node) || ast.isBorderProperty(node) || ast.isOpacityProperty(node) || ast.isMultipleProperty(node) || ast.isShapeSizeProperty(node) || ast.isPaddingSizeProperty(node) || ast.isTextSizeProperty(node)) {
+    if (ast.isElementStringProperty(node) || ast.isRelationStringProperty(node) || ast.isViewStringProperty(node) || ast.isNotationProperty(node) || ast.isNotesProperty(node) || ast.isSpecificationElementStringProperty(node) || ast.isSpecificationRelationshipStringProperty(node) || ast.isColorProperty(node) || ast.isLineProperty(node) || ast.isArrowProperty(node) || ast.isIconProperty(node) || ast.isShapeProperty(node) || ast.isBorderProperty(node) || ast.isOpacityProperty(node) || ast.isMultipleProperty(node) || ast.isShapeSizeProperty(node) || ast.isPaddingSizeProperty(node) || ast.isTextSizeProperty(node)) {
       const formatter = this.getNodeFormatter(node);
       const colon = formatter.keyword(":");
       const propertyName = formatter.keywords(
@@ -128,6 +156,7 @@ export class LikeC4Formatter extends AbstractFormatter {
         "description",
         "technology",
         "notation",
+        "notes",
         "color",
         "line",
         "head",
@@ -189,6 +218,11 @@ export class LikeC4Formatter extends AbstractFormatter {
       f.properties("props").prepend(FormattingOptions.oneSpace);
     });
   }
+  formatExtendElement(node) {
+    this.on(node, ast.isExtendElement, (n, f) => {
+      f.keywords("extend").append(FormattingOptions.oneSpace);
+    });
+  }
   formatGlobals(node) {
     this.on(node, ast.isGlobalStyle, (n, f) => {
       f.keyword("style").append(FormattingOptions.oneSpace);
@@ -204,6 +238,15 @@ export class LikeC4Formatter extends AbstractFormatter {
       f.keyword("dynamicPredicateGroup").append(FormattingOptions.oneSpace);
     });
   }
+  formatImports(node) {
+    this.on(node, ast.isImportsFromPoject, (n, f) => {
+      f.keyword("import").append(FormattingOptions.oneSpace);
+      f.keywords("{", "}", "from").surround(FormattingOptions.oneSpace);
+    });
+    this.on(node, ast.isImported, (n, f) => {
+      f.keywords(",").prepend(FormattingOptions.noSpace).append(FormattingOptions.oneSpace);
+    });
+  }
   formatSpecificationRule(node) {
     if (ast.isSpecificationElementKind(node) || ast.isSpecificationRelationshipKind(node) || ast.isSpecificationTag(node) || ast.isSpecificationDeploymentNodeKind(node)) {
       const formatter = this.getNodeFormatter(node);
@@ -328,8 +371,7 @@ export class LikeC4Formatter extends AbstractFormatter {
       f.keywords("->", "<->").prepend(FormattingOptions.oneSpace);
       f.keywords("-[").prepend(FormattingOptions.oneSpace).append(FormattingOptions.noSpace);
       f.keywords("]->").prepend(FormattingOptions.noSpace).append(FormattingOptions.oneSpace);
-      const kind = f.property("kind");
-      kind.nodes[0]?.text.startsWith(".") && kind.surround(FormattingOptions.oneSpace);
+      f.property("dotKind").prepend(FormattingOptions.oneSpace).append(FormattingOptions.oneSpace);
     });
     this.on(node, ast.isDirectedRelationExpr, (n, f) => {
       f.property("target").prepend(FormattingOptions.oneSpace);
@@ -349,4 +391,60 @@ export class LikeC4Formatter extends AbstractFormatter {
     format && formatter && format(node, formatter);
     return formatter;
   }
+  doExtendedFormatting(edits) {
+    const quotesNormalizer = this.quotesNormalizerFactory(this.extendedFormattingCommands);
+    for (let command of this.extendedFormattingCommands) {
+      switch (command.type) {
+        case "normalizeQuotes":
+          quotesNormalizer(command, edits);
+          break;
+        default:
+          nonexhaustive(command.type);
+      }
+    }
+  }
+  normalizeQuotes(node) {
+    if (this.options.quoteStyle === "ignore") {
+      return;
+    }
+    let region = null;
+    region = region ?? this.on(node, ast.isStringProperty)?.property("value");
+    region = region ?? this.on(node, ast.isElement)?.properties("props");
+    region = region ?? this.on(node, ast.isImportsFromPoject)?.properties("project");
+    region = region ?? this.on(node, ast.isRelation)?.properties("title", "technology");
+    region = region ?? this.on(node, ast.isViewRuleGroup)?.properties("title");
+    region = region ?? this.on(node, ast.isDynamicViewStep)?.properties("title");
+    region = region ?? this.on(node, ast.isDeploymentNode)?.properties("title");
+    region = region ?? this.on(node, ast.isDeployedInstance)?.properties("title");
+    region = region ?? this.on(node, ast.isDeploymentRelation)?.properties("title", "technology");
+    region = region ?? this.on(node, ast.isLinkProperty)?.properties("title");
+    if (region) {
+      this.extendedFormattingCommands.push({ type: "normalizeQuotes", region });
+    }
+  }
+  quotesNormalizerFactory(commands) {
+    const quoteStyle = this.options.quoteStyle != "auto" ? this.options.quoteStyle : this.getAutoQuoteStyle(commands);
+    return (command, edits) => {
+      const quotesToReplace = quoteStyle === "single" ? '"' : "'";
+      const quotesToInsert = quoteStyle === "single" ? "'" : '"';
+      const newEdits = command.region.nodes.map((node) => ({
+        range: node.range,
+        newText: node.text.replaceAll(quotesToReplace, quotesToInsert)
+      }));
+      edits.push(...newEdits);
+    };
+  }
+  getAutoQuoteStyle(commands) {
+    const nodes = commands.flatMap((x) => x.region.nodes);
+    const doubleQuotesCount = nodes.filter((x) => x.text[0] == '"').length;
+    return doubleQuotesCount * 2 >= nodes.length ? "double" : "single";
+  }
+  onConfigurationUpdate(options) {
+    this.options = {
+      ...this.options,
+      ...options ?? {
+        quoteStyle: "auto"
+      }
+    };
+  }
 }