@likec4/language-server 0.31.0 → 0.32.0

package/README.md

@@ -1,3 +1,5 @@
 # LikeC4 Language Server
 
+[docs](https://likec4.dev/docs/) | [example](https://likec4.dev/examples/bigbank/likec4/)
+
 Language Server Protocol (LSP) based on [languim](https://github.com/languim/languim) library.

package/contrib/likec4.monarch.ts

@@ -1,7 +1,7 @@
 // Monarch syntax highlighting for the likec4 language.
 export default {
     keywords: [
-        'BottomTop','LeftRight','RightLeft','TopBottom','amber','autoLayout','blue','browser','color','cylinder','description','element','exclude','extend','gray','green','include','indigo','it','kind','link','mobile','model','muted','of','person','primary','queue','rectangle','red','secondary','shape','sky','slate','specification','storage','style','tag','technology','this','title','view','views'
+        'BottomTop','LeftRight','RightLeft','TopBottom','amber','autoLayout','blue','browser','color','cylinder','description','element','exclude','extend','gray','green','icon','include','indigo','it','kind','link','mobile','model','muted','of','person','primary','queue','rectangle','red','secondary','shape','sky','slate','specification','storage','style','tag','technology','this','title','view','views'
     ],
     operators: [
         '*','.*'

package/contrib/likec4.tmLanguage.json

@@ -12,7 +12,7 @@
     },
     {
       "name": "keyword.control.likec4",
-      "match": "\\b(BottomTop|LeftRight|RightLeft|TopBottom|amber|autoLayout|blue|browser|color|cylinder|description|element|exclude|extend|gray|green|include|indigo|it|kind|link|mobile|model|muted|of|person|primary|queue|rectangle|red|secondary|shape|sky|slate|specification|storage|style|tag|technology|this|title|view|views)\\b"
+      "match": "\\b(BottomTop|LeftRight|RightLeft|TopBottom|amber|autoLayout|blue|browser|color|cylinder|description|element|exclude|extend|gray|green|icon|include|indigo|it|kind|link|mobile|model|muted|of|person|primary|queue|rectangle|red|secondary|shape|sky|slate|specification|storage|style|tag|technology|this|title|view|views)\\b"
     },
     {
       "name": "string.quoted.double.likec4",

package/dist/ast.d.ts

@@ -5,8 +5,9 @@ import * as ast from './generated/ast';
 export { ast };
 export interface ParsedAstSpecification {
     kinds: Record<c4.ElementKind, {
-        shape: c4.ElementShape;
-        color: c4.ThemeColor;
+        shape?: c4.ElementShape;
+        color?: c4.ThemeColor;
+        icon?: c4.IconUrl;
     }>;
 }
 export interface ParsedAstElement {
@@ -16,6 +17,7 @@ export interface ParsedAstElement {
     title: string;
     description?: string;
     technology?: string;
+    icon?: c4.IconUrl;
     tags?: c4.NonEmptyArray<c4.Tag>;
     links?: c4.NonEmptyArray<string>;
     shape?: c4.ElementShape;
@@ -67,9 +69,15 @@ export declare function resolveRelationPoints(node: ast.Relation): {
     source: ast.Element;
     target: ast.Element;
 };
-export declare function toElementStyle(props?: ast.AStyleProperty[]): {
+export declare function toElementStyle(props?: ast.StyleProperties['props']): {
     color?: c4.ThemeColor;
     shape?: c4.ElementShape;
+    icon?: c4.IconUrl;
+};
+export declare function toElementStyleExcludeDefaults(props?: ast.StyleProperties['props']): {
+    shape?: c4.ElementShape;
+    color?: c4.ThemeColor;
+    icon?: c4.IconUrl;
 };
 export declare function toAutoLayout(direction: ast.ViewRuleLayoutDirection): c4.ViewRuleAutoLayout['autoLayout'];
 //# sourceMappingURL=ast.d.ts.map

package/dist/ast.js

@@ -1,6 +1,5 @@
-import { RelationRefError } from '@likec4/core';
+import { DefaultElementShape, DefaultThemeColor, RelationRefError, nonexhaustive } from '@likec4/core';
 import { DocumentState } from 'langium/lib/workspace';
-// import objectHash from 'object-hash'
 import { elementRef } from './elementRef';
 import * as ast from './generated/ast';
 import { LikeC4LanguageMetaData } from './generated/module';
@@ -55,7 +54,11 @@ export function isLikeC4LangiumDocument(doc) {
 }
 export function isParsedLikeC4LangiumDocument(doc) {
     return (isLikeC4LangiumDocument(doc) &&
-        ['c4Specification', 'c4Elements', 'c4Relations', 'c4Views'].every(key => key in doc));
+        doc.state >= DocumentState.Validated &&
+        'c4Specification' in doc &&
+        'c4Elements' in doc &&
+        'c4Relations' in doc &&
+        'c4Views' in doc);
 }
 export const isValidLikeC4LangiumDocument = (doc) => {
     if (!isParsedLikeC4LangiumDocument(doc))
@@ -122,16 +125,34 @@ export function resolveRelationPoints(node) {
 }
 export function toElementStyle(props) {
     const result = {};
-    const color = props?.find(ast.isColorProperty)?.value;
-    if (color) {
-        result.color = color;
+    if (!props || props.length === 0) {
+        return result;
     }
-    const shape = props?.find(ast.isShapeProperty)?.value;
-    if (shape) {
-        result.shape = shape;
+    for (const prop of props) {
+        if (ast.isColorProperty(prop)) {
+            result.color = prop.value;
+            continue;
+        }
+        if (ast.isShapeProperty(prop)) {
+            result.shape = prop.value;
+            continue;
+        }
+        if (ast.isIconProperty(prop)) {
+            result.icon = prop.value;
+            continue;
+        }
+        nonexhaustive(prop);
     }
     return result;
 }
+export function toElementStyleExcludeDefaults(props) {
+    const { color, shape, ...rest } = toElementStyle(props);
+    return {
+        ...rest,
+        ...(color && color !== DefaultThemeColor ? { color } : {}),
+        ...(shape && shape !== DefaultElementShape ? { shape } : {})
+    };
+}
 export function toAutoLayout(direction) {
     switch (direction) {
         case 'TopBottom': {

package/dist/generated/ast.d.ts

@@ -4,13 +4,10 @@
  ******************************************************************************/
 import type { AstNode, Reference, ReferenceInfo, TypeMetaData } from 'langium';
 import { AbstractAstReflection } from 'langium';
-export type AStyleProperty = ColorProperty | ShapeProperty;
-export declare const AStyleProperty = "AStyleProperty";
-export declare function isAStyleProperty(item: unknown): item is AStyleProperty;
 export type ElementExpression = ElementKindExpression | ElementRefExpression | ElementTagExpression | WildcardExpression;
 export declare const ElementExpression = "ElementExpression";
 export declare function isElementExpression(item: unknown): item is ElementExpression;
-export type ElementProperty = ElementStringProperty | ElementStyleProperties;
+export type ElementProperty = ElementStringProperty | StyleProperties;
 export declare const ElementProperty = "ElementProperty";
 export declare function isElementProperty(item: unknown): item is ElementProperty;
 export type ElementShape = 'browser' | 'cylinder' | 'mobile' | 'person' | 'queue' | 'rectangle' | 'storage';
@@ -35,7 +32,7 @@ export declare function isViewRule(item: unknown): item is ViewRule;
 export type ViewRuleLayoutDirection = 'BottomTop' | 'LeftRight' | 'RightLeft' | 'TopBottom';
 export declare function isViewRuleLayoutDirection(item: unknown): item is ViewRuleLayoutDirection;
 export interface ColorProperty extends AstNode {
-    readonly $container: ElementStyleProperties | SpecificationStyleProperties | ViewRuleStyle;
+    readonly $container: StyleProperties | ViewRuleStyle;
     readonly $type: 'ColorProperty';
     key: 'color';
     value: ThemeColor;
@@ -93,21 +90,13 @@ export interface ElementRefExpression extends AstNode {
 export declare const ElementRefExpression = "ElementRefExpression";
 export declare function isElementRefExpression(item: unknown): item is ElementRefExpression;
 export interface ElementStringProperty extends AstNode {
-    readonly $container: ElementBody;
+    readonly $container: ElementBody | SpecificationElementKind | SpecificationTag;
     readonly $type: 'ElementStringProperty';
     key: 'description' | 'technology' | 'title';
     value: string;
 }
 export declare const ElementStringProperty = "ElementStringProperty";
 export declare function isElementStringProperty(item: unknown): item is ElementStringProperty;
-export interface ElementStyleProperties extends AstNode {
-    readonly $container: ElementBody;
-    readonly $type: 'ElementStyleProperties';
-    key: 'style';
-    props: Array<ColorProperty | ShapeProperty>;
-}
-export declare const ElementStyleProperties = "ElementStyleProperties";
-export declare function isElementStyleProperties(item: unknown): item is ElementStyleProperties;
 export interface ElementTagExpression extends AstNode {
     readonly $container: InOutExpression | IncomingExpression | OutgoingExpression | RelationExpression | ViewRuleExpression | ViewRuleStyle;
     readonly $type: 'ElementTagExpression';
@@ -142,6 +131,14 @@ export interface ExtendElementBody extends AstNode {
 }
 export declare const ExtendElementBody = "ExtendElementBody";
 export declare function isExtendElementBody(item: unknown): item is ExtendElementBody;
+export interface IconProperty extends AstNode {
+    readonly $container: StyleProperties | ViewRuleStyle;
+    readonly $type: 'IconProperty';
+    key: 'icon';
+    value: Uri;
+}
+export declare const IconProperty = "IconProperty";
+export declare function isIconProperty(item: unknown): item is IconProperty;
 export interface IncomingExpression extends AstNode {
     readonly $container: InOutExpression | IncomingExpression | OutgoingExpression | RelationExpression | ViewRuleExpression | ViewRuleStyle;
     readonly $type: 'IncomingExpression';
@@ -235,7 +232,7 @@ export interface RelationStringProperty extends AstNode {
 export declare const RelationStringProperty = "RelationStringProperty";
 export declare function isRelationStringProperty(item: unknown): item is RelationStringProperty;
 export interface ShapeProperty extends AstNode {
-    readonly $container: ElementStyleProperties | SpecificationStyleProperties | ViewRuleStyle;
+    readonly $container: StyleProperties | ViewRuleStyle;
     readonly $type: 'ShapeProperty';
     key: 'shape';
     value: ElementShape;
@@ -246,7 +243,7 @@ export interface SpecificationElementKind extends AstNode {
     readonly $container: SpecificationRule;
     readonly $type: 'SpecificationElementKind';
     kind: ElementKind;
-    style?: SpecificationStyleProperties;
+    style?: StyleProperties;
 }
 export declare const SpecificationElementKind = "SpecificationElementKind";
 export declare function isSpecificationElementKind(item: unknown): item is SpecificationElementKind;
@@ -258,17 +255,10 @@ export interface SpecificationRule extends AstNode {
 }
 export declare const SpecificationRule = "SpecificationRule";
 export declare function isSpecificationRule(item: unknown): item is SpecificationRule;
-export interface SpecificationStyleProperties extends AstNode {
-    readonly $container: SpecificationElementKind | SpecificationTag;
-    readonly $type: 'SpecificationStyleProperties';
-    props: Array<ColorProperty | ShapeProperty>;
-}
-export declare const SpecificationStyleProperties = "SpecificationStyleProperties";
-export declare function isSpecificationStyleProperties(item: unknown): item is SpecificationStyleProperties;
 export interface SpecificationTag extends AstNode {
     readonly $container: SpecificationRule;
     readonly $type: 'SpecificationTag';
-    style?: SpecificationStyleProperties;
+    style?: StyleProperties;
     tag: Tag;
 }
 export declare const SpecificationTag = "SpecificationTag";
@@ -281,6 +271,14 @@ export interface StrictElementRef extends AstNode {
 }
 export declare const StrictElementRef = "StrictElementRef";
 export declare function isStrictElementRef(item: unknown): item is StrictElementRef;
+export interface StyleProperties extends AstNode {
+    readonly $container: ElementBody | SpecificationElementKind | SpecificationTag;
+    readonly $type: 'StyleProperties';
+    key: 'style';
+    props: Array<ColorProperty | IconProperty | ShapeProperty>;
+}
+export declare const StyleProperties = "StyleProperties";
+export declare function isStyleProperties(item: unknown): item is StyleProperties;
 export interface Tag extends AstNode {
     readonly $container: SpecificationTag;
     readonly $type: 'Tag';
@@ -321,7 +319,7 @@ export declare function isViewRuleExpression(item: unknown): item is ViewRuleExp
 export interface ViewRuleStyle extends AstNode {
     readonly $container: ElementView;
     readonly $type: 'ViewRuleStyle';
-    props: Array<ColorProperty | ShapeProperty>;
+    props: Array<ColorProperty | IconProperty | ShapeProperty>;
     targets: Array<ElementExpression>;
 }
 export declare const ViewRuleStyle = "ViewRuleStyle";
@@ -334,7 +332,6 @@ export interface WildcardExpression extends AstNode {
 export declare const WildcardExpression = "WildcardExpression";
 export declare function isWildcardExpression(item: unknown): item is WildcardExpression;
 export type LikeC4AstType = {
-    AStyleProperty: AStyleProperty;
     ColorProperty: ColorProperty;
     Element: Element;
     ElementBody: ElementBody;
@@ -345,12 +342,12 @@ export type LikeC4AstType = {
     ElementRef: ElementRef;
     ElementRefExpression: ElementRefExpression;
     ElementStringProperty: ElementStringProperty;
-    ElementStyleProperties: ElementStyleProperties;
     ElementTagExpression: ElementTagExpression;
     ElementView: ElementView;
     Expression: Expression;
     ExtendElement: ExtendElement;
     ExtendElementBody: ExtendElementBody;
+    IconProperty: IconProperty;
     InOutExpression: InOutExpression;
     IncomingExpression: IncomingExpression;
     LikeC4Document: LikeC4Document;
@@ -365,9 +362,9 @@ export type LikeC4AstType = {
     ShapeProperty: ShapeProperty;
     SpecificationElementKind: SpecificationElementKind;
     SpecificationRule: SpecificationRule;
-    SpecificationStyleProperties: SpecificationStyleProperties;
     SpecificationTag: SpecificationTag;
     StrictElementRef: StrictElementRef;
+    StyleProperties: StyleProperties;
     Tag: Tag;
     Tags: Tags;
     View: View;

package/dist/generated/ast.js

@@ -3,10 +3,6 @@
  * DO NOT EDIT MANUALLY!
  ******************************************************************************/
 import { AbstractAstReflection } from 'langium';
-export const AStyleProperty = 'AStyleProperty';
-export function isAStyleProperty(item) {
-    return reflection.isInstance(item, AStyleProperty);
-}
 export const ElementExpression = 'ElementExpression';
 export function isElementExpression(item) {
     return reflection.isInstance(item, ElementExpression);
@@ -77,10 +73,6 @@ export const ElementStringProperty = 'ElementStringProperty';
 export function isElementStringProperty(item) {
     return reflection.isInstance(item, ElementStringProperty);
 }
-export const ElementStyleProperties = 'ElementStyleProperties';
-export function isElementStyleProperties(item) {
-    return reflection.isInstance(item, ElementStyleProperties);
-}
 export const ElementTagExpression = 'ElementTagExpression';
 export function isElementTagExpression(item) {
     return reflection.isInstance(item, ElementTagExpression);
@@ -97,6 +89,10 @@ export const ExtendElementBody = 'ExtendElementBody';
 export function isExtendElementBody(item) {
     return reflection.isInstance(item, ExtendElementBody);
 }
+export const IconProperty = 'IconProperty';
+export function isIconProperty(item) {
+    return reflection.isInstance(item, IconProperty);
+}
 export const IncomingExpression = 'IncomingExpression';
 export function isIncomingExpression(item) {
     return reflection.isInstance(item, IncomingExpression);
@@ -153,10 +149,6 @@ export const SpecificationRule = 'SpecificationRule';
 export function isSpecificationRule(item) {
     return reflection.isInstance(item, SpecificationRule);
 }
-export const SpecificationStyleProperties = 'SpecificationStyleProperties';
-export function isSpecificationStyleProperties(item) {
-    return reflection.isInstance(item, SpecificationStyleProperties);
-}
 export const SpecificationTag = 'SpecificationTag';
 export function isSpecificationTag(item) {
     return reflection.isInstance(item, SpecificationTag);
@@ -165,6 +157,10 @@ export const StrictElementRef = 'StrictElementRef';
 export function isStrictElementRef(item) {
     return reflection.isInstance(item, StrictElementRef);
 }
+export const StyleProperties = 'StyleProperties';
+export function isStyleProperties(item) {
+    return reflection.isInstance(item, StyleProperties);
+}
 export const Tag = 'Tag';
 export function isTag(item) {
     return reflection.isInstance(item, Tag);
@@ -195,14 +191,10 @@ export function isWildcardExpression(item) {
 }
 export class LikeC4AstReflection extends AbstractAstReflection {
     getAllTypes() {
-        return ['AStyleProperty', 'ColorProperty', 'Element', 'ElementBody', 'ElementExpression', 'ElementKind', 'ElementKindExpression', 'ElementProperty', 'ElementRef', 'ElementRefExpression', 'ElementStringProperty', 'ElementStyleProperties', 'ElementTagExpression', 'ElementView', 'Expression', 'ExtendElement', 'ExtendElementBody', 'InOutExpression', 'IncomingExpression', 'LikeC4Document', 'LinkProperty', 'Model', 'ModelViews', 'OutgoingExpression', 'Relation', 'RelationBody', 'RelationExpression', 'RelationStringProperty', 'ShapeProperty', 'SpecificationElementKind', 'SpecificationRule', 'SpecificationStyleProperties', 'SpecificationTag', 'StrictElementRef', 'Tag', 'Tags', 'View', 'ViewProperty', 'ViewRule', 'ViewRuleAutoLayout', 'ViewRuleExpression', 'ViewRuleStyle', 'WildcardExpression'];
+        return ['ColorProperty', 'Element', 'ElementBody', 'ElementExpression', 'ElementKind', 'ElementKindExpression', 'ElementProperty', 'ElementRef', 'ElementRefExpression', 'ElementStringProperty', 'ElementTagExpression', 'ElementView', 'Expression', 'ExtendElement', 'ExtendElementBody', 'IconProperty', 'InOutExpression', 'IncomingExpression', 'LikeC4Document', 'LinkProperty', 'Model', 'ModelViews', 'OutgoingExpression', 'Relation', 'RelationBody', 'RelationExpression', 'RelationStringProperty', 'ShapeProperty', 'SpecificationElementKind', 'SpecificationRule', 'SpecificationTag', 'StrictElementRef', 'StyleProperties', 'Tag', 'Tags', 'View', 'ViewProperty', 'ViewRule', 'ViewRuleAutoLayout', 'ViewRuleExpression', 'ViewRuleStyle', 'WildcardExpression'];
     }
     computeIsSubtype(subtype, supertype) {
         switch (subtype) {
-            case ColorProperty:
-            case ShapeProperty: {
-                return this.isSubtype(AStyleProperty, supertype);
-            }
             case ElementExpression:
             case IncomingExpression:
             case InOutExpression:
@@ -217,7 +209,7 @@ export class LikeC4AstReflection extends AbstractAstReflection {
                 return this.isSubtype(ElementExpression, supertype);
             }
             case ElementStringProperty:
-            case ElementStyleProperties: {
+            case StyleProperties: {
                 return this.isSubtype(ElementProperty, supertype);
             }
             case ElementView: {
@@ -288,14 +280,6 @@ export class LikeC4AstReflection extends AbstractAstReflection {
                     ]
                 };
             }
-            case 'ElementStyleProperties': {
-                return {
-                    name: 'ElementStyleProperties',
-                    mandatory: [
-                        { name: 'props', type: 'array' }
-                    ]
-                };
-            }
             case 'ElementTagExpression': {
                 return {
                     name: 'ElementTagExpression',
@@ -353,9 +337,9 @@ export class LikeC4AstReflection extends AbstractAstReflection {
                     ]
                 };
             }
-            case 'SpecificationStyleProperties': {
+            case 'StyleProperties': {
                 return {
-                    name: 'SpecificationStyleProperties',
+                    name: 'StyleProperties',
                     mandatory: [
                         { name: 'props', type: 'array' }
                     ]