@likec4/language-server 1.17.1 → 1.18.0

package/src/index.ts

@@ -8,6 +8,7 @@ export type * from './model'
 export type * from './module'
 export { createCustomLanguageServices, createLanguageServices, LikeC4Module } from './module'
 export { LikeC4FileSystem }
+
 export function startLanguageServer() {
   /* browser specific setup code */
   const connection = createConnection(ProposedFeatures.all)

package/src/like-c4.langium

@@ -6,6 +6,7 @@ entry LikeC4Grammar:
     models+=Model  |
     views+=ModelViews |
     globals+=Globals |
+    deployments+=ModelDeployments  |
     likec4lib+=LikeC4Lib
   )*
 ;
@@ -18,22 +19,15 @@ LikeC4Lib:
     '}'
   '}';
 
-LibIcon:
-  name=IconId;
+LibIcon: name=IconId;
 
 // Specification -------------------------------------
 
-ElementKind:
-  name=Id;
-
-Tag:
-  name=Id;
-
-RelationshipKind:
-  name=Id;
-
-CustomColor:
-  name=CustomColorId;
+ElementKind: name=Id;
+Tag: name=Id;
+RelationshipKind: name=Id;
+CustomColor: name=CustomColorId;
+DeploymentNodeKind: name=Id;
 
 SpecificationRule:
   name='specification' '{'
@@ -41,7 +35,8 @@ SpecificationRule:
       elements+=SpecificationElementKind |
       tags+=SpecificationTag |
       relationships+=SpecificationRelationshipKind |
-      colors+=SpecificationColor
+      colors+=SpecificationColor |
+      deploymentNodes+=SpecificationDeploymentNodeKind
     )*
   '}';
 
@@ -56,6 +51,14 @@ SpecificationElementKind:
 SpecificationElementStringProperty:
   key=('technology' | 'notation') ':'? value=String ';'?;
 
+SpecificationDeploymentNodeKind:
+  'deploymentNode' kind=DeploymentNodeKind ('{'
+    props+=(
+      SpecificationElementStringProperty |
+      ElementStyleProperty
+    )*
+  '}')?;
+
 SpecificationTag:
   'tag' tag=Tag;
 
@@ -201,9 +204,9 @@ ModelViews:
     )*
   '}';
 
-type LikeC4View = ElementView | DynamicView;
+type LikeC4View = ElementView | DynamicView | DeploymentView;
 LikeC4ViewRule returns LikeC4View:
-  ElementView | DynamicView;
+  ElementView | DynamicView | DeploymentView;
 
 ElementView:
   'view' name=Id? (
@@ -372,7 +375,7 @@ ElementSelectorExpression infers ElementExpression:
 ElementDescedantsExpression infers ElementExpression:
   ElementRef (
     {infer ExpandElementExpression.expand=current} DotUnderscore |
-    {infer ElementDescedantsExpression.parent=current} DotWildcard
+    {infer ElementDescedantsExpression.parent=current} suffix=DotWildcard
   )?
 ;
 
@@ -410,7 +413,7 @@ WhereRelationNegation:
 
 WhereRelation:
   {infer WhereRelationTag} 'tag' EqOperator value=[Tag:TagId]? |
-  {infer WhereRelationKind} 'kind' EqOperator value=[RelationshipKind]?
+  {infer WhereRelationKind} 'kind' EqOperator value=[RelationshipKind:Id]?
 ;
 
 type WhereTagEqual = WhereElementTag | WhereRelationTag;
@@ -436,7 +439,7 @@ DirectedRelationExpressions infers RelationExpression:
 
 OutgoingRelationExpression:
   from=ElementExpression
-  (isBidirectional?='<->' | '->' | '-[' kind=[RelationshipKind] ']->' | kind=[RelationshipKind:DotId])
+  (isBidirectional?='<->' | '->' | '-[' kind=[RelationshipKind:Id] ']->' | kind=[RelationshipKind:DotId])
 ;
 
 // Comma-separated list of ElementExpressions
@@ -509,6 +512,149 @@ NavigateToProperty:
 RelationNavigateToProperty:
   key='navigateTo' value=DynamicViewRef;
 
+// Deployment -------------------------------------
+
+ModelDeployments:
+  name='deployment' '{'
+    elements+=(
+      DeploymentNode |
+      DeploymentRelation
+    )*
+  '}';
+
+type DeploymentElement = DeploymentNode | DeployedInstance;
+
+DeploymentNode:
+  (
+    kind=[DeploymentNodeKind:Id] name=Id |
+    name=Id Eq kind=[DeploymentNodeKind:Id]
+  )
+  title=String?
+  body=DeploymentNodeBody?
+;
+
+DeploymentNodeBody: '{'
+  tags=Tags?
+  props+=ElementProperty*
+  elements+=(
+    DeployedInstance |
+    DeploymentRelation |
+    DeploymentNode
+  )*
+'}';
+
+DeployedInstance:
+  (name=Id Eq)?
+  ('instanceOf' | 'instance' 'of')
+  element=ElementRef
+  title=String?
+  body=DeployedInstanceBody?
+  ';'?
+;
+
+DeployedInstanceBody: '{'
+  tags=Tags?
+  props+=ElementProperty*
+'}';
+
+// Rules:
+// - DeployedInstance can be referenced from DeploymentNode
+// - Element can be referenced from DeployedInstance
+// Forced by scope computation
+type DeploymentReferenceable = DeploymentNode | DeployedInstance | Element;
+DeploymentRef:
+  value=[DeploymentReferenceable:Id] ({infer DeploymentRef.parent=current} StickyDot value=[DeploymentReferenceable:Id])*;
+
+DeploymentRelation:
+  source=DeploymentRef
+  ('->' | '-[' kind=[RelationshipKind:Id] ']->' | kind=[RelationshipKind:DotId])
+  target=DeploymentRef
+  (
+    title=String
+    technology=String?
+  )?
+  tags=Tags?
+  body=DeploymentRelationBody?
+;
+
+DeploymentRelationBody: '{'
+  tags=Tags?
+  props+=RelationProperty*
+'}'
+;
+
+DeploymentView:
+  'deployment' 'view' name=Id body=DeploymentViewBody?
+;
+
+DeploymentViewBody: '{'
+  tags=Tags?
+  props+=ViewProperty*
+  rules+=DeploymentViewRule*
+'}';
+
+DeploymentViewRule:
+  DeploymentViewRulePredicate |
+  DeploymentViewRuleStyle |
+  ViewRuleAutoLayout
+;
+
+DeploymentViewRuleStyle:
+  'style' target=DeploymentExpressionIterator '{'
+    props+=(
+      StyleProperty |
+      NotationProperty
+    )*
+  '}';
+
+
+DeploymentViewRulePredicate:
+  (isInclude?='include' | 'exclude')
+  expr=DeploymentViewRulePredicateExpression
+;
+
+DeploymentViewRulePredicateExpression:
+  value=DeploymentExpression ({infer DeploymentViewRulePredicateExpression.prev=current} ',' (value=DeploymentExpression)?)*
+;
+
+DeploymentExpression:
+  DeploymentRelationExpression |
+  DeploymentElementExpression
+;
+
+DeploymentElementExpression:
+  {infer WildcardExpression} isWildcard?='*' |
+  DeploymentRefExpression
+;
+
+DeploymentRefExpression:
+  ref=DeploymentRef selector=(DotUnderscore | DotWildcard)?
+;
+
+DeploymentRelationExpression:
+  InOutDeploymentRelationExpression |
+  DirectedDeploymentRelationExpression
+;
+
+InOutDeploymentRelationExpression infers DeploymentRelationExpression:
+  IncomingDeploymentRelationExpression ({infer InOutDeploymentRelationExpression.inout=current} '->')?
+;
+
+IncomingDeploymentRelationExpression:
+  '->' to=DeploymentElementExpression;
+
+DirectedDeploymentRelationExpression infers DeploymentRelationExpression:
+  OutgoingDeploymentRelationExpression ({infer DirectedDeploymentRelationExpression.source=current} target=DeploymentElementExpression)?
+;
+
+OutgoingDeploymentRelationExpression:
+  from=DeploymentElementExpression
+  (isBidirectional?='<->' | '->' | '-[' kind=[RelationshipKind:Id] ']->' | kind=[RelationshipKind:DotId])
+;
+
+DeploymentExpressionIterator:
+  value=DeploymentElementExpression ({infer DeploymentExpressionIterator.prev=current} ',' (value=DeploymentElementExpression)?)*
+;
 // Global -------------------------------------
 
 Globals:
@@ -545,6 +691,8 @@ GlobalStyleGroup:
     styles+=ViewRuleStyle*
   '}';
 
+type FqnReferenceable = DeploymentReferenceable | Element | ExtendElement;
+
 // Common properties -------------------------------------
 
 LinkProperty:
@@ -635,7 +783,7 @@ CustomColorId returns string:
   IdTerminal | ElementShape | ArrowType | LineOptions | 'element' | 'model';
 
 Id returns string:
-  IdTerminal | ElementShape | ThemeColor | ArrowType | LineOptions | 'element' | 'model' | 'group';
+  IdTerminal | ElementShape | ThemeColor | ArrowType | LineOptions | 'element' | 'model' | 'group' | 'node' | 'deployment';
 
 fragment EqOperator:
   (
@@ -674,8 +822,8 @@ terminal LIB_ICON: /(aws|azure|gcp|tech):[-\w]*/;
 terminal URI_WITH_SCHEMA: /\w+:\/\/\S+/;
 terminal URI_RELATIVE: /\.{0,2}\/[^\/]\S+/;
 
-terminal DotUnderscore: /\b\._/;
-terminal DotWildcard: /\b\.\*/;
+terminal DotUnderscore: /\b\._(?![_a-zA-Z])/;
+terminal DotWildcard: /\b\.\*{1,2}/;
 terminal Hash: '#';
 
 // No space allowed before dot

package/src/logger.ts

@@ -1,9 +1,10 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import { type ConsolaReporter, LogLevels, rootLogger as root } from '@likec4/log'
+import { BROWSER } from 'esm-env'
 import { isError } from 'remeda'
 import type { Connection } from 'vscode-languageserver'
 
 export const logger = root.withTag('lsp')
+// export const logger = root
 
 export function logError(err: unknown): void {
   logger.error(err)
@@ -92,6 +93,10 @@ export function logToLspConnection(connection: Connection): void {
       }
     }
   }
-  root.setReporters([reporter])
+  if (BROWSER) {
+    root.addReporter(reporter)
+  } else {
+    root.setReporters([reporter])
+  }
   logger.setReporters(root.options.reporters)
 }

package/src/lsp/CodeLensProvider.ts

@@ -7,7 +7,6 @@ import type { LikeC4Services } from '../module'
 
 export class LikeC4CodeLensProvider implements CodeLensProvider {
   constructor(private services: LikeC4Services) {
-    //
   }
 
   async provideCodeLens(

package/src/lsp/CompletionProvider.ts

@@ -22,6 +22,21 @@ export class LikeC4CompletionProvider extends DefaultCompletionProvider {
     if (!this.filterKeyword(context, keyword)) {
       return
     }
+    if (keyword.value === 'deployment' && AstUtils.hasContainerOfType(context.node, ast.isModelViews)) {
+      return acceptor(context, {
+        label: keyword.value,
+        detail: `Insert deployment view`,
+        kind: CompletionItemKind.Class,
+        insertTextFormat: InsertTextFormat.Snippet,
+        insertText: [
+          'deployment view ${1:view_${TM_FILENAME_BASE}_${CURRENT_SECOND}} {',
+          '\ttitle \'${2:Untitled}\'',
+          '\t',
+          '\t$0',
+          '}'
+        ].join('\n')
+      })
+    }
     if (['title', 'description', 'technology'].includes(keyword.value)) {
       return acceptor(context, {
         label: keyword.value,
@@ -30,7 +45,7 @@ export class LikeC4CompletionProvider extends DefaultCompletionProvider {
         insertText: `${keyword.value} '\${0}'`
       })
     }
-    if (['views', 'specification', 'model', 'with'].includes(keyword.value)) {
+    if (['views', 'specification', 'model', 'deployment', 'with'].includes(keyword.value)) {
       return acceptor(context, {
         label: keyword.value,
         detail: `Insert ${keyword.value} block`,
@@ -52,7 +67,7 @@ export class LikeC4CompletionProvider extends DefaultCompletionProvider {
         ].join('\n')
       })
     }
-    if (keyword.value === 'dynamic') {
+    if (keyword.value === 'dynamic' && AstUtils.hasContainerOfType(context.node, ast.isModelViews)) {
       return acceptor(context, {
         label: keyword.value,
         detail: `Insert dynamic view`,

package/src/lsp/DocumentSymbolProvider.ts

@@ -4,9 +4,9 @@ import type { DocumentSymbolProvider, NodeKindProvider } from 'langium/lsp'
 import { filter, isEmpty, isTruthy, map, pipe } from 'remeda'
 import { type DocumentSymbol, SymbolKind } from 'vscode-languageserver-types'
 import { ast, type LikeC4LangiumDocument } from '../ast'
-import { getFqnElementRef } from '../elementRef'
 import { logError } from '../logger'
 import type { LikeC4Services } from '../module'
+import { getFqnElementRef } from '../utils/elementRef'
 
 export class LikeC4DocumentSymbolProvider implements DocumentSymbolProvider {
   protected readonly nodeKindProvider: NodeKindProvider
@@ -61,7 +61,10 @@ export class LikeC4DocumentSymbolProvider implements DocumentSymbolProvider {
       [...astSpec.elements, ...astSpec.tags, ...astSpec.relationships],
       map(nd => {
         try {
-          if (ast.isSpecificationElementKind(nd) || ast.isSpecificationRelationshipKind(nd)) {
+          if (
+            ast.isSpecificationElementKind(nd) || ast.isSpecificationRelationshipKind(nd)
+            || ast.isSpecificationDeploymentNodeKind(nd)
+          ) {
             return this.getKindSymbol(nd)
           }
           if (ast.isSpecificationTag(nd)) {

package/src/lsp/HoverProvider.ts

@@ -4,14 +4,16 @@ import { isTruthy } from 'remeda'
 import stripIndent from 'strip-indent'
 import type { Hover } from 'vscode-languageserver-types'
 import { ast } from '../ast'
-import type { LikeC4ModelLocator } from '../model'
+import type { LikeC4ModelLocator, LikeC4ModelParser } from '../model'
 import type { LikeC4Services } from '../module'
 
 export class LikeC4HoverProvider extends AstNodeHoverProvider {
+  private parser: LikeC4ModelParser
   private locator: LikeC4ModelLocator
 
   constructor(services: LikeC4Services) {
     super(services)
+    this.parser = services.likec4.ModelParser
     this.locator = services.likec4.ModelLocator
   }
 
@@ -27,6 +29,36 @@ export class LikeC4HoverProvider extends AstNodeHoverProvider {
       }
     }
 
+    if (ast.isDeploymentNode(node)) {
+      const el = this.parser.parseDeploymentNode(node, () => true)
+      const lines = [el.id as string + '  ']
+      if (el.title !== node.name) {
+        lines.push(`### ${el.title}`)
+      }
+      lines.push('Deployment: `' + el.kind + '` ')
+      return {
+        contents: {
+          kind: 'markdown',
+          value: lines.join('\n')
+        }
+      }
+    }
+
+    if (ast.isDeployedInstance(node)) {
+      const instance = this.parser.parseDeployedInstance(node, () => true)
+      const el = this.locator.getParsedElement(instance.element)
+      const lines = [instance.id + '  ', `instance of \`${instance.element}\``]
+      if (el) {
+        lines.push(`### ${el.title}`, 'Element: `' + el.kind + '` ')
+      }
+      return {
+        contents: {
+          kind: 'markdown',
+          value: lines.join('\n')
+        }
+      }
+    }
+
     // if (ast.isElementKind(node)) {
     //   const spec = this.specIndex.get(node.name as ElementKind)
     //   return {
@@ -45,7 +77,7 @@ export class LikeC4HoverProvider extends AstNodeHoverProvider {
       if (!el) {
         return
       }
-      const lines = [el.id, `### ${el.title}`, '`' + el.kind + '` ']
+      const lines = [el.id, `### ${el.title}`, 'Element: `' + el.kind + '` ']
       return {
         contents: {
           kind: 'markdown',

package/src/lsp/SemanticTokenProvider.ts

@@ -10,6 +10,26 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
     node: AstNode,
     acceptor: SemanticTokenAcceptor
   ): void | undefined | 'prune' {
+    if (ast.isElement(node) || ast.isDeploymentNode(node)) {
+      return this.highlightNameAndKind(node, acceptor)
+    }
+    if (ast.isDeployedInstance(node)) {
+      if ('name' in node) {
+        acceptor({
+          node,
+          property: 'name',
+          type: SemanticTokenTypes.variable,
+          modifier: [
+            SemanticTokenModifiers.definition,
+            SemanticTokenModifiers.readonly
+          ]
+        })
+      }
+      return
+    }
+    if (ast.isLikeC4View(node)) {
+      return this.highlightView(node, acceptor)
+    }
     if (ast.isRelationshipKind(node)) {
       return acceptor({
         node,
@@ -70,6 +90,20 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
       })
       return 'prune'
     }
+    if (ast.isDeploymentRefExpression(node)) {
+      if (node.selector) {
+        acceptor({
+          node,
+          property: 'selector',
+          type: SemanticTokenTypes.variable,
+          modifier: [
+            SemanticTokenModifiers.definition,
+            SemanticTokenModifiers.readonly
+          ]
+        })
+      }
+      return
+    }
     if (ast.isWhereRelationKind(node) && isTruthy(node.value)) {
       acceptor({
         node,
@@ -108,6 +142,18 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
       })
       return 'prune'
     }
+    if (ast.isDeploymentRef(node)) {
+      acceptor({
+        node,
+        property: 'value',
+        type: node.parent ? SemanticTokenTypes.property : SemanticTokenTypes.variable,
+        modifier: [
+          SemanticTokenModifiers.definition,
+          SemanticTokenModifiers.readonly
+        ]
+      })
+      return !node.parent ? 'prune' : undefined
+    }
     if (ast.isElementRef(node) || ast.isFqnElementRef(node)) {
       acceptor({
         node,
@@ -137,7 +183,10 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
       })
       return
     }
-    if (ast.isSpecificationElementKind(node) || ast.isSpecificationRelationshipKind(node)) {
+    if (
+      ast.isSpecificationElementKind(node) || ast.isSpecificationRelationshipKind(node)
+      || ast.isSpecificationDeploymentNodeKind(node)
+    ) {
       acceptor({
         node,
         property: 'kind',
@@ -196,30 +245,13 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
         property: 'key',
         type: SemanticTokenTypes.property
       })
-      if (ast.isIconProperty(node)) {
-        if (node.libicon) {
-          acceptor({
-            node,
-            property: 'libicon',
-            type: SemanticTokenTypes.enum,
-            modifier: [SemanticTokenModifiers.defaultLibrary]
-          })
-        } else {
-          if (node.value === 'none') {
-            acceptor({
-              node,
-              property: 'value',
-              type: SemanticTokenTypes.enum,
-              modifier: [SemanticTokenModifiers.defaultLibrary]
-            })
-          } else {
-            acceptor({
-              node,
-              property: 'value',
-              type: SemanticTokenTypes.string
-            })
-          }
-        }
+      if (ast.isIconProperty(node) && (node.libicon || node.value === 'none')) {
+        acceptor({
+          node,
+          property: node.libicon ? 'libicon' : 'value',
+          type: SemanticTokenTypes.enum,
+          modifier: [SemanticTokenModifiers.defaultLibrary]
+        })
         return 'prune'
       }
       if ('value' in node && node.value) {
@@ -252,15 +284,9 @@ export class LikeC4SemanticTokenProvider extends AbstractSemanticTokenProvider {
       }
       return 'prune'
     }
-    if (ast.isElement(node)) {
-      return this.highlightAstElement(node, acceptor)
-    }
-    if (ast.isLikeC4View(node)) {
-      return this.highlightView(node, acceptor)
-    }
   }
 
-  private highlightAstElement(node: ast.Element, acceptor: SemanticTokenAcceptor) {
+  private highlightNameAndKind(node: ast.Element | ast.DeploymentNode, acceptor: SemanticTokenAcceptor) {
     acceptor({
       node,
       property: 'name',