@likec4/language-server 1.2.2 → 1.4.0

package/src/like-c4.langium

@@ -21,7 +21,11 @@ RelationshipKind:
 
 SpecificationRule:
   name='specification' '{'
-    (elements+=SpecificationElementKind | tags+=SpecificationTag | relationships+=SpecificationRelationshipKind)*
+    (
+      elements+=SpecificationElementKind |
+      tags+=SpecificationTag |
+      relationships+=SpecificationRelationshipKind
+    )*
   '}';
 
 SpecificationElementKind:
@@ -47,7 +51,8 @@ Model:
       ExplicitRelation |
       Element
     )*
-  '}';
+  '}'
+;
 
 Element:
   (
@@ -61,16 +66,17 @@ Element:
       )?
     )?
   )?
-  ('{' body=ElementBody '}')?
+  body=ElementBody?
 ;
 
-ElementBody:
+ElementBody: '{'
   tags=Tags?
   props+=ElementProperty*
   elements+=(
     Relation |
     Element
   )*
+'}'
 ;
 
 ElementProperty:
@@ -80,37 +86,37 @@ ElementStringProperty:
   key=('title' | 'technology' | 'description') Colon? value=String SemiColon?;
 
 ExtendElement:
-  'extend' element=FqnElementRef '{'
-    body=ExtendElementBody
-  '}'
+  'extend' element=FqnElementRef body=ExtendElementBody
 ;
 
-ExtendElementBody:
+ExtendElementBody:  '{'
   elements+=(
     ExplicitRelation |
     Element
   )*
+'}'
 ;
 
 //
 FqnElementRef:
-  el=[Element] ({infer FqnElementRef.parent=current} Dot el=[Element])*;
+  el=[Element] ({infer FqnElementRef.parent=current} dot=StickyDot el=[Element])*;
 
 ElementRef:
-  el=[Element] ({infer ElementRef.parent=current} Dot el=[Element])*;
+  el=[Element] ({infer ElementRef.parent=current} dot=StickyDot el=[Element])*;
 
 Tags:
-  value+=[Tag:TagId] (Comma? value+=[Tag:TagId])* (Comma | SemiColon)?;
+  (value+=[Tag:TagId] comma+=(Comma | SemiColon)?)+
+;
 
 Relation:
   ExplicitRelation | ImplicitRelation;
 
 fragment RelationFragment:
-  ('->' | '-[' kind=[RelationshipKind] ']->')
+  ('->' | '-[' kind=[RelationshipKind] ']->' | kind=[RelationshipKind:DotId] )
   target=ElementRef
   title=String?
   tags=Tags?
-  ('{' body=RelationBody '}')?
+  body=RelationBody?
 ;
 
 ExplicitRelation:
@@ -119,9 +125,10 @@ ExplicitRelation:
 ImplicitRelation:
   ('this' | 'it')? RelationFragment;
 
-RelationBody:
+RelationBody: '{'
   tags=Tags?
   props+=RelationProperty*
+'}'
 ;
 
 RelationProperty:
@@ -142,8 +149,8 @@ RelationStyleProperty:
 ModelViews:
   name='views' '{'
     views+=(
-      ElementView |
-      DynamicView
+      DynamicView |
+      ElementView
     )*
   '}';
 
@@ -154,19 +161,18 @@ ElementView:
     'extends' extends=ElementViewRef |
     'of' viewOf=ElementRef
   )?
-  '{' body=ElementViewBody '}'
+  body=ElementViewBody
 ;
 
 DynamicView:
-  'dynamic' 'view' name=Id '{'
-     body=DynamicViewBody
-  '}'
+  'dynamic' 'view' name=Id body=DynamicViewBody
 ;
 
-DynamicViewBody:
+DynamicViewBody: '{'
   tags=Tags?
   props+=ViewProperty*
   (steps+=DynamicViewStep | rules+=DynamicViewRule)*
+  '}'
 ;
 
 ViewRef:
@@ -175,12 +181,15 @@ ViewRef:
 ElementViewRef:
   view=[ElementView];
 
-ElementViewBody:
+ElementViewBody: '{'
   tags=Tags?
   props+=ViewProperty*
   rules+=ViewRule*
+'}'
 ;
 
+type StringProperty = ElementStringProperty| ViewStringProperty;
+
 ViewProperty:
   ViewStringProperty | LinkProperty
 ;
@@ -209,15 +218,15 @@ DynamicViewStep:
 
 ViewRulePredicate:
   ({infer IncludePredicate} 'include' | {infer ExcludePredicate} 'exclude')
-  expressions+=ViewRulePredicateExpr (Comma expressions+=ViewRulePredicateExpr)* Comma?
+  expressions+=ViewRulePredicateExpr (commas+=Comma expressions+=ViewRulePredicateExpr)* Comma?
 ;
 
 DynamicViewRulePredicate:
-  'include' expressions+=ViewRulePredicateExpr (Comma expressions+=ViewRulePredicateExpr)* Comma?
+  'include' expressions+=ViewRulePredicateExpr (commas+=Comma expressions+=ViewRulePredicateExpr)* Comma?
 ;
 
 ViewRuleStyle:
-  'style' targets+=ElementExpr (Comma targets+=ElementExpr)* Comma? '{'
+  'style' targets+=ElementExpr (commas+=Comma targets+=ElementExpr)* Comma? '{'
     styleprops+=StyleProperty*
   '}';
 
@@ -227,7 +236,7 @@ ViewRuleAutoLayout:
 ViewRulePredicateExpr:
   InOutExpr |
   ElementExpr (
-    {infer CustomElementExpr.target=current} 'with' '{' body=CustomElementExprBody '}' |
+    {infer CustomElementExpr.target=current} 'with'  body=CustomElementExprBody |
     {infer RelationExpr.source=current} (isBidirectional?='<->' | '->') target=ElementExpr |
     {infer OutgoingExpr.from=current} '->'
   )?
@@ -251,7 +260,7 @@ WildcardExpr:
 ;
 
 ElementSelectorExpr infers ElementExpr:
-  'element' Dot (
+  'element' StickyDot (
     {infer ElementTagExpr} 'tag' IsEqual tag=[Tag:TagId] |
     {infer ElementKindExpr} 'kind' IsEqual kind=[ElementKind]
   )
@@ -264,16 +273,17 @@ DescedantsExpr infers ElementExpr:
   )?
 ;
 
-CustomElementExprBody:
+CustomElementExprBody: '{'
   props+=(
     NavigateToProperty |
     ElementStringProperty |
     StyleProperty
   )*
+'}'
 ;
 
 NavigateToProperty:
-  'navigateTo' value=ViewRef;
+  key='navigateTo' value=ViewRef;
 
 // Common properties -------------------------------------
 
@@ -323,7 +333,11 @@ RelationshipStyleProperty:
   ColorProperty | LineProperty | ArrowProperty;
 
 LineOptions returns string:
-  'solid' | 'dashed' | 'dotted';
+  'solid' |
+  'dashed' |
+  'dotted'
+;
+
 ArrowType returns string:
   'none' |
   'normal' |
@@ -345,7 +359,10 @@ Uri returns string:
 // Percent returns string: PERCENT;
 
 TagId returns string:
-  TagHash Id;
+  Hash Id;
+
+DotId returns string:
+  Dot Id;
 
 Id returns string:
   IdTerminal | ElementShape | ThemeColor | ArrowType | LineOptions | 'element' | 'model';
@@ -378,15 +395,17 @@ terminal URI_RELATIVE: /\.{0,2}\/[^\/]\S+/;
 
 terminal DotUnderscore: /\b\._/;
 terminal DotWildcard: /\b\.\*/;
-terminal TagHash: /\#\b/;
-terminal Dot: /\b\./;
+terminal Hash: '#';
+
+// No space allowed before dot
+terminal StickyDot: /\b\./;
+terminal Dot: '.';
 terminal NotEqual: /\!\={1,2}/;
 terminal Eq: /\={1,2}/;
 terminal Colon: ':';
 terminal SemiColon: ';';
 terminal Comma: ',';
 terminal Percent: /\b\d+%/;
-// terminal Percent: ('0'..'9')+ '%';
 
 terminal String: /"[^"]*"|'[^']*'/;
 

package/src/logger.ts

@@ -17,17 +17,23 @@ export const logger = {
     if (isSilent) return
     console.info(message)
   },
-  warn(message: string) {
+  warn(message: unknown) {
     if (isSilent) return
-    console.warn(message)
+    if (typeof message === 'string' || message instanceof Error) {
+      console.warn(message)
+      return
+    }
+    const error = normalizeError(message)
+    console.warn(`${error.name}: ${error.message}`)
   },
-  error(message: any) {
+  error(message: unknown) {
     if (isSilent) return
-    if (typeof message === 'string') {
+    if (typeof message === 'string' || message instanceof Error) {
       console.error(message)
       return
     }
-    console.error(normalizeError(message))
+    const error = normalizeError(message)
+    console.error(`${error.name}: ${error.message}`, error)
   },
   silent(silent = true) {
     isSilent = silent
@@ -36,8 +42,16 @@ export const logger = {
 
 export type Logger = typeof logger
 
-export function logError(error: unknown): void {
-  logger.error(error)
+export function logError(err: unknown): void {
+  if (typeof err === 'string') {
+    logger.error(err)
+    return
+  }
+  if (err instanceof Error) {
+    logger.error(err.stack ?? err.message)
+    return
+  }
+  logger.error(normalizeError(err))
 }
 
 export function logWarnError(err: unknown): void {

package/src/lsp/CompletionProvider.ts

@@ -0,0 +1,7 @@
+import { type CompletionProviderOptions, DefaultCompletionProvider } from 'langium/lsp'
+
+export class LikeC4CompletionProvider extends DefaultCompletionProvider {
+  readonly completionOptions = {
+    triggerCharacters: ['.']
+  } satisfies CompletionProviderOptions
+}

package/src/lsp/SemanticTokenProvider.ts

@@ -9,17 +9,22 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
     node: AstNode,
     acceptor: SemanticTokenAcceptor
   ): void | undefined | 'prune' {
+    if (ast.isRelationshipKind(node)) {
+      return acceptor({
+        node,
+        property: 'name',
+        type: SemanticTokenTypes.function
+      })
+    }
     if (ast.isRelation(node) && 'kind' in node) {
-      acceptor({
+      return acceptor({
         node,
         property: 'kind',
-        type: SemanticTokenTypes.type,
-        modifier: [SemanticTokenModifiers.definition]
+        type: SemanticTokenTypes.function
       })
     }
-
     if (ast.isElementViewRef(node)) {
-      acceptor({
+      return acceptor({
         node,
         property: 'view',
         type: SemanticTokenTypes.variable
@@ -28,15 +33,24 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
     if (ast.isDescedantsExpr(node) && node.$cstNode) {
       acceptor({
         cst: node.$cstNode,
-        type: SemanticTokenTypes.variable
+        type: SemanticTokenTypes.variable,
+        modifier: [
+          SemanticTokenModifiers.definition,
+          SemanticTokenModifiers.readonly
+        ]
       })
       return 'prune'
     }
     if (ast.isWildcardExpr(node) && node.$cstNode) {
       acceptor({
         cst: node.$cstNode,
-        type: SemanticTokenTypes.variable
+        type: SemanticTokenTypes.variable,
+        modifier: [
+          SemanticTokenModifiers.definition,
+          SemanticTokenModifiers.readonly
+        ]
       })
+      return 'prune'
     }
 
     if (ast.isElementKindExpr(node)) {
@@ -59,33 +73,50 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
       acceptor({
         node,
         property: 'el',
-        type: node.parent ? SemanticTokenTypes.property : SemanticTokenTypes.variable
+        type: node.parent ? SemanticTokenTypes.property : SemanticTokenTypes.variable,
+        modifier: [
+          SemanticTokenModifiers.definition,
+          SemanticTokenModifiers.readonly
+        ]
       })
+      return !node.parent ? 'prune' : undefined
     }
     if (ast.isSpecificationElementKind(node) || ast.isSpecificationRelationshipKind(node)) {
       acceptor({
         node,
         property: 'kind',
         type: SemanticTokenTypes.type,
-        modifier: [SemanticTokenModifiers.definition]
+        modifier: [
+          SemanticTokenModifiers.declaration,
+          SemanticTokenModifiers.readonly
+        ]
       })
     }
     if (ast.isTags(node)) {
       acceptor({
         node,
         property: 'value',
-        type: SemanticTokenTypes.type,
-        modifier: [SemanticTokenModifiers.definition]
+        type: SemanticTokenTypes.interface
       })
     }
     if (ast.isTag(node)) {
-      acceptor({
+      return acceptor({
         node,
         property: 'name',
         type: SemanticTokenTypes.type,
         modifier: [SemanticTokenModifiers.definition]
       })
     }
+    if (
+      ast.isRelationStyleProperty(node)
+      || (ast.isStyleProperties(node) && ast.isElementBody(node.$container))
+    ) {
+      acceptor({
+        node,
+        property: 'key',
+        type: SemanticTokenTypes.property
+      })
+    }
     if (
       ast.isColorProperty(node)
       || ast.isShapeProperty(node)
@@ -93,6 +124,11 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
       || ast.isLineProperty(node)
       || ast.isBorderProperty(node)
     ) {
+      acceptor({
+        node,
+        property: 'key',
+        type: SemanticTokenTypes.property
+      })
       acceptor({
         node,
         property: 'value',
@@ -100,24 +136,42 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
       })
     }
     if (ast.isOpacityProperty(node)) {
+      acceptor({
+        node,
+        property: 'key',
+        type: SemanticTokenTypes.property
+      })
       acceptor({
         node,
         property: 'value',
         type: SemanticTokenTypes.number
       })
+      return
     }
-    if (ast.isLinkProperty(node) || ast.isIconProperty(node)) {
+    if (
+      ast.isLinkProperty(node)
+      || ast.isIconProperty(node)
+      || ast.isElementStringProperty(node)
+      || ast.isRelationStringProperty(node)
+      || ast.isViewStringProperty(node)
+    ) {
+      acceptor({
+        node,
+        property: 'key',
+        type: SemanticTokenTypes.property
+      })
       acceptor({
         node,
         property: 'value',
         type: SemanticTokenTypes.string
       })
+      return
     }
     if (ast.isElement(node)) {
-      this.highlightAstElement(node, acceptor)
+      return this.highlightAstElement(node, acceptor)
     }
     if (ast.isLikeC4View(node)) {
-      this.highlightView(node, acceptor)
+      return this.highlightView(node, acceptor)
     }
   }
 
@@ -126,7 +180,10 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
       node,
       property: 'name',
       type: SemanticTokenTypes.variable,
-      modifier: [SemanticTokenModifiers.declaration]
+      modifier: [
+        SemanticTokenModifiers.declaration,
+        SemanticTokenModifiers.readonly
+      ]
     })
     acceptor({
       node,
@@ -142,7 +199,11 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
         node,
         property: 'name',
         type: SemanticTokenTypes.variable,
-        modifier: [SemanticTokenModifiers.declaration]
+        modifier: [
+          SemanticTokenModifiers.declaration,
+          SemanticTokenModifiers.readonly,
+          'local'
+        ]
       })
     }
   }

package/src/lsp/index.ts

@@ -1,4 +1,5 @@
 export * from './CodeLensProvider'
+export * from './CompletionProvider'
 export * from './DocumentHighlightProvider'
 export * from './DocumentLinkProvider'
 export * from './DocumentSymbolProvider'

package/src/model/model-builder.ts

@@ -7,7 +7,6 @@ import {
   type StrictElementView,
   type ViewID
 } from '@likec4/core'
-import { computeDynamicView, computeView, LikeC4ModelGraph } from '@likec4/graph'
 import { deepEqual as eq } from 'fast-equals'
 import type { URI, WorkspaceCache } from 'langium'
 import { DocumentState, interruptAndCheck, type LangiumDocument, type LangiumDocuments } from 'langium'
@@ -17,6 +16,7 @@ import {
   flatMap,
   forEach,
   isNullish,
+  isNumber,
   isTruthy,
   map,
   mapToObj,
@@ -36,6 +36,7 @@ import type {
 } from '../ast'
 import { isParsedLikeC4LangiumDocument } from '../ast'
 import { logError, logger, logWarnError } from '../logger'
+import { computeDynamicView, computeView, LikeC4ModelGraph } from '../model-graph'
 import type { LikeC4Services } from '../module'
 import { printDocs } from '../utils/printDocs'
 import { assignNavigateTo, resolveRelativePaths, resolveRulesExtendedViews } from '../view-utils'
@@ -87,7 +88,7 @@ function buildModel(services: LikeC4Services, docs: ParsedLikeC4LangiumDocument[
           ...(icon && { icon }),
           style: {
             ...(border && { border }),
-            ...(opacity && { opacity })
+            ...(isNumber(opacity) && { opacity })
           },
           links: links ? resolveLinks(doc, links) : null,
           tags: tags ?? null,
@@ -169,43 +170,6 @@ function buildModel(services: LikeC4Services, docs: ParsedLikeC4LangiumDocument[
     mapToObj(r => [r.id, r])
   )
 
-  // const toElementView = (view: ParsedAstElementView, doc: LangiumDocument): c4.ElementView => {
-  //   let { astPath, rules, title, description, tags, links, id, __, ...model } = view
-
-  //   if ('viewOf' in view) {
-  //     title ??= elements[view.viewOf]?.title ?? null
-  //   }
-  //   if (!title && view.id === 'index') {
-  //     title = 'Landscape view'
-  //   }
-  //   return {
-  //     __,
-  //     id,
-  //     ...model,
-  //     title,
-  //     description,
-  //     tags,
-  //     links: links ? resolveLinks(doc, links) : null,
-  //     docUri: '',
-  //     rules
-  //   }
-  // }
-
-  // const toDynamicView = (view: ParsedAstDynamicView, doc: LangiumDocument): c4.DynamicView => {
-  //   let { rules, steps, title, description, tags, links, id, __ } = view
-  //   return {
-  //     __,
-  //     id,
-  //     title,
-  //     description,
-  //     tags,
-  //     links: links ? resolveLinks(doc, links) : null,
-  //     docUri: '',
-  //     rules,
-  //     steps
-  //   }
-  // }
-
   const toC4View = (doc: LangiumDocument) => {
     const docUri = doc.uri.toString()
     return (parsedAstView: ParsedAstView): c4.View => {

package/src/model/model-parser.ts

@@ -1,6 +1,6 @@
 import { type c4, InvalidModelError, invariant, isNonEmptyArray, nonexhaustive } from '@likec4/core'
 import type { AstNode, LangiumDocument } from 'langium'
-import { AstUtils } from 'langium'
+import { AstUtils, CstUtils } from 'langium'
 import { isTruthy } from 'remeda'
 import stripIndent from 'strip-indent'
 import type {
@@ -29,6 +29,7 @@ import { elementRef, getFqnElementRef } from '../elementRef'
 import { logError, logger, logWarnError } from '../logger'
 import type { LikeC4Services } from '../module'
 import { stringHash } from '../utils'
+import { deserializeFromComment } from '../view-utils/manual-layout'
 import type { FqnIndex } from './fqn-index'
 
 const { getDocument } = AstUtils
@@ -380,6 +381,14 @@ export class LikeC4ModelParser {
     nonexhaustive(astRule)
   }
 
+  private parseViewManualLaout(node: ast.DynamicView | ast.ElementView): c4.ViewManualLayout | undefined {
+    const commentNode = CstUtils.findCommentNode(node.$cstNode, ['BLOCK_COMMENT'])
+    if (!commentNode) {
+      return undefined
+    }
+    return deserializeFromComment(commentNode.text)
+  }
+
   private parseDynamicStep(node: ast.DynamicViewStep): c4.DynamicViewStep {
     const sourceEl = elementRef(node.source)
     if (!sourceEl) {
@@ -435,11 +444,12 @@ export class LikeC4ModelParser {
     const tags = this.convertTags(body)
     const links = body.props.filter(ast.isLinkProperty).map(p => p.value)
 
+    const manualLayout = this.parseViewManualLaout(astNode)
+
     const view: ParsedAstElementView = {
       __: 'element',
       id: id as c4.ViewID,
       astPath,
-      ...(viewOf && { viewOf }),
       title,
       description,
       tags,
@@ -451,7 +461,9 @@ export class LikeC4ModelParser {
           logWarnError(e)
           return []
         }
-      })
+      }),
+      ...(viewOf && { viewOf }),
+      ...(manualLayout && { manualLayout })
     }
     ViewOps.writeId(astNode, view.id)
 
@@ -489,6 +501,8 @@ export class LikeC4ModelParser {
 
     ViewOps.writeId(astNode, id as c4.ViewID)
 
+    const manualLayout = this.parseViewManualLaout(astNode)
+
     return {
       __: 'dynamic',
       id: id as c4.ViewID,
@@ -553,7 +567,8 @@ export class LikeC4ModelParser {
           logWarnError(e)
         }
         return acc
-      }, [] as c4.DynamicViewStep[])
+      }, [] as c4.DynamicViewStep[]),
+      ...(manualLayout && { manualLayout })
     }
   }