@likec4/language-server 1.32.1 → 1.33.0

package/dist/config/schema.d.ts

@@ -1,7 +1,7 @@
 import * as v from 'valibot';
 export declare const ProjectConfig: v.ObjectSchema<{
-    readonly name: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>]>, v.DescriptionAction<string, "Project name, must be unique in the workspace">]>;
-    readonly contactPerson: v.OptionalSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>]>, v.DescriptionAction<string, "A person who has been involved in creating or maintaining this project">]>, undefined>;
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, "Project name cannot be empty">, v.ExcludesAction<string, "default", "Project name cannot be \"default\"">, v.ExcludesAction<string, ".", "Project name cannot contain \".\", try to use A-z, 0-9, _ and -">, v.ExcludesAction<string, "@", "Project name cannot contain \"@\", try to use A-z, 0-9, _ and -">, v.ExcludesAction<string, "#", "Project name cannot contain \"#\", try to use A-z, 0-9, _ and -">, v.DescriptionAction<string, "Project name, must be unique in the workspace">]>;
+    readonly contactPerson: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, "Contact person cannot be empty if specified">, v.DescriptionAction<string, "A person who has been involved in creating or maintaining this project">]>, undefined>;
     readonly exclude: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string[], "List of file patterns to exclude from the project, default is [\"**/node_modules/**/*\"]">]>, undefined>;
 }, undefined>;
 export type ProjectConfig = v.InferOutput<typeof ProjectConfig>;

package/dist/config/schema.js

@@ -1,25 +1,22 @@
 import JSON5 from "json5";
 import * as v from "valibot";
-const nonEmptyString = v.pipe(v.string(), v.nonEmpty());
 export const ProjectConfig = v.object({
   name: v.pipe(
-    nonEmptyString,
-    // TODO: check if this is needed
-    // v.excludes('.', 'Project name cannot contain "."'),
+    v.string(),
+    v.nonEmpty("Project name cannot be empty"),
+    v.excludes("default", 'Project name cannot be "default"'),
+    v.excludes(".", 'Project name cannot contain ".", try to use A-z, 0-9, _ and -'),
+    v.excludes("@", 'Project name cannot contain "@", try to use A-z, 0-9, _ and -'),
+    v.excludes("#", 'Project name cannot contain "#", try to use A-z, 0-9, _ and -'),
     v.description("Project name, must be unique in the workspace")
   ),
   contactPerson: v.optional(
     v.pipe(
-      nonEmptyString,
+      v.string(),
+      v.nonEmpty("Contact person cannot be empty if specified"),
       v.description("A person who has been involved in creating or maintaining this project")
     )
   ),
-  // imports: v.optional(
-  //   v.pipe(
-  //     v.record(v.string(), nonEmptyString),
-  //     v.description('Imported projects'),
-  //   ),
-  // ),
   exclude: v.optional(
     v.pipe(
       v.array(v.string()),

package/dist/formatting/LikeC4Formatter.js

@@ -79,7 +79,7 @@ export class LikeC4Formatter extends AbstractFormatter {
         n.target,
         n.tags
       ], isTruthy)).prepend(FormattingOptions.oneSpace);
-      f.properties("title", "technology").prepend(FormattingOptions.oneSpace);
+      f.properties("title", "description", "technology").prepend(FormattingOptions.oneSpace);
     });
   }
   formatExtendDeployment(node) {
@@ -100,7 +100,7 @@ export class LikeC4Formatter extends AbstractFormatter {
           n.target,
           n.tags
         ], isTruthy)).prepend(FormattingOptions.oneSpace);
-        f.properties("title", "technology").prepend(FormattingOptions.oneSpace);
+        f.properties("title", "description", "technology").prepend(FormattingOptions.oneSpace);
       }
     );
     this.on(node, ast.isDynamicViewStep, (n, f) => {

package/dist/generated/ast.d.ts

@@ -8,6 +8,7 @@ export declare const LikeC4Terminals: {
     LINE_COMMENT: RegExp;
     WS: RegExp;
     NL: RegExp;
+    BOOLEAN: RegExp;
     LIB_ICON: RegExp;
     URI_WITH_SCHEMA: RegExp;
     URI_RELATIVE: RegExp;
@@ -19,6 +20,7 @@ export declare const LikeC4Terminals: {
     NotEqual: RegExp;
     Eq: RegExp;
     Percent: RegExp;
+    MarkdownString: RegExp;
     String: RegExp;
     Float: RegExp;
     Number: RegExp;
@@ -26,12 +28,10 @@ export declare const LikeC4Terminals: {
     IdTerminal: RegExp;
 };
 export type LikeC4TerminalNames = keyof typeof LikeC4Terminals;
-export type LikeC4KeywordNames = "(" | ")" | "*" | "," | "->" | "-[" | ":" | ";" | "<-" | "<->" | "BottomTop" | "LeftRight" | "RightLeft" | "TopBottom" | "]->" | "amber" | "and" | "autoLayout" | "blue" | "border" | "browser" | "color" | "crow" | "cylinder" | "dashed" | "deployment" | "deploymentNode" | "description" | "diamond" | "dot" | "dotted" | "dynamic" | "dynamicPredicateGroup" | "element" | "element.kind" | "element.tag" | "exclude" | "extend" | "extends" | "false" | "from" | "global" | "gray" | "green" | "group" | "head" | "icon" | "icons" | "import" | "include" | "indigo" | "instance" | "instanceOf" | "is" | "kind" | "large" | "lg" | "likec4lib" | "line" | "link" | "md" | "medium" | "metadata" | "mobile" | "model" | "multiple" | "muted" | "navigateTo" | "node" | "none" | "normal" | "not" | "notation" | "notes" | "odiamond" | "odot" | "of" | "onormal" | "opacity" | "open" | "or" | "padding" | "par" | "parallel" | "person" | "predicate" | "predicateGroup" | "primary" | "queue" | "rectangle" | "red" | "relationship" | "rgb" | "rgba" | "secondary" | "shape" | "size" | "sky" | "slate" | "sm" | "small" | "solid" | "source" | "specification" | "storage" | "style" | "styleGroup" | "tag" | "tail" | "target" | "technology" | "textSize" | "title" | "true" | "vee" | "view" | "views" | "where" | "with" | "xl" | "xlarge" | "xs" | "xsmall" | "{" | "}";
+export type LikeC4KeywordNames = "(" | ")" | "*" | "," | "->" | "-[" | ":" | ";" | "<-" | "<->" | "BottomTop" | "LeftRight" | "RightLeft" | "TopBottom" | "]->" | "amber" | "and" | "autoLayout" | "blue" | "border" | "browser" | "color" | "crow" | "cylinder" | "dashed" | "deployment" | "deploymentNode" | "description" | "diamond" | "dot" | "dotted" | "dynamic" | "dynamicPredicateGroup" | "element" | "element.kind" | "element.tag" | "exclude" | "extend" | "extends" | "from" | "global" | "gray" | "green" | "group" | "head" | "icon" | "icons" | "import" | "include" | "indigo" | "instance" | "instanceOf" | "is" | "kind" | "large" | "lg" | "likec4lib" | "line" | "link" | "md" | "medium" | "metadata" | "mobile" | "model" | "multiple" | "muted" | "navigateTo" | "node" | "none" | "normal" | "not" | "notation" | "notes" | "odiamond" | "odot" | "of" | "onormal" | "opacity" | "open" | "or" | "padding" | "par" | "parallel" | "person" | "predicate" | "predicateGroup" | "primary" | "queue" | "rectangle" | "red" | "relationship" | "rgb" | "rgba" | "secondary" | "shape" | "size" | "sky" | "slate" | "sm" | "small" | "solid" | "source" | "specification" | "storage" | "style" | "styleGroup" | "tag" | "tail" | "target" | "technology" | "textSize" | "title" | "vee" | "view" | "views" | "where" | "with" | "xl" | "xlarge" | "xs" | "xsmall" | "{" | "}";
 export type LikeC4TokenNames = LikeC4TerminalNames | LikeC4KeywordNames;
 export type ArrowType = 'crow' | 'diamond' | 'dot' | 'none' | 'normal' | 'odiamond' | 'odot' | 'onormal' | 'open' | 'vee';
 export declare function isArrowType(item: unknown): item is ArrowType;
-export type Boolean = boolean;
-export declare function isBoolean(item: unknown): item is Boolean;
 export type BorderStyleValue = 'none' | LineOptions;
 export declare function isBorderStyleValue(item: unknown): item is BorderStyleValue;
 export type ColorLiteral = HexColor | RGBAColor;
@@ -251,6 +251,7 @@ export interface DeploymentRelation extends langium.AstNode {
     readonly $container: DeployedInstanceBody | DeploymentNodeBody | ExtendDeploymentBody | ModelDeployments;
     readonly $type: 'DeploymentRelation';
     body?: DeploymentRelationBody;
+    description?: string;
     dotKind?: RelationKindDotRef;
     kind?: langium.Reference<RelationshipKind>;
     source?: FqnRef;
@@ -414,7 +415,7 @@ export interface ElementStringProperty extends langium.AstNode {
     readonly $container: CustomElementProperties | DeployedInstanceBody | DeploymentNodeBody | ElementBody;
     readonly $type: 'ElementStringProperty';
     key: 'description' | 'technology' | 'title';
-    value: string;
+    value: MarkdownOrString;
 }
 export declare const ElementStringProperty = "ElementStringProperty";
 export declare function isElementStringProperty(item: unknown): item is ElementStringProperty;
@@ -680,11 +681,19 @@ export interface LinkProperty extends langium.AstNode {
 }
 export declare const LinkProperty = "LinkProperty";
 export declare function isLinkProperty(item: unknown): item is LinkProperty;
+export interface MarkdownOrString extends langium.AstNode {
+    readonly $container: ElementStringProperty | MetadataAttribute | NotationProperty | NotesProperty | RelationStringProperty | SpecificationRelationshipStringProperty | ViewStringProperty;
+    readonly $type: 'MarkdownOrString';
+    markdown?: string;
+    text?: string;
+}
+export declare const MarkdownOrString = "MarkdownOrString";
+export declare function isMarkdownOrString(item: unknown): item is MarkdownOrString;
 export interface MetadataAttribute extends langium.AstNode {
     readonly $container: MetadataBody;
     readonly $type: 'MetadataAttribute';
     key: string;
-    value: string;
+    value: MarkdownOrString;
 }
 export declare const MetadataAttribute = "MetadataAttribute";
 export declare function isMetadataAttribute(item: unknown): item is MetadataAttribute;
@@ -724,7 +733,7 @@ export interface MultipleProperty extends langium.AstNode {
     readonly $container: CustomElementProperties | DeploymentViewRuleStyle | ElementStyleProperty | GlobalStyle | ViewRuleStyle;
     readonly $type: 'MultipleProperty';
     key: 'multiple';
-    value: Boolean;
+    value: boolean;
 }
 export declare const MultipleProperty = "MultipleProperty";
 export declare function isMultipleProperty(item: unknown): item is MultipleProperty;
@@ -740,7 +749,7 @@ export interface NotationProperty extends langium.AstNode {
     readonly $container: CustomElementProperties | CustomRelationProperties | DeploymentViewRuleStyle | GlobalStyle | ViewRuleStyle;
     readonly $type: 'NotationProperty';
     key: 'notation';
-    value: string;
+    value: MarkdownOrString;
 }
 export declare const NotationProperty = "NotationProperty";
 export declare function isNotationProperty(item: unknown): item is NotationProperty;
@@ -748,7 +757,7 @@ export interface NotesProperty extends langium.AstNode {
     readonly $container: CustomRelationProperties;
     readonly $type: 'NotesProperty';
     key: 'notes';
-    value: string;
+    value: MarkdownOrString;
 }
 export declare const NotesProperty = "NotesProperty";
 export declare function isNotesProperty(item: unknown): item is NotesProperty;
@@ -782,6 +791,7 @@ export interface Relation extends langium.AstNode {
     readonly $container: ElementBody | ExtendElementBody | Model;
     readonly $type: 'Relation';
     body?: RelationBody;
+    description?: string;
     dotKind?: RelationKindDotRef;
     kind?: langium.Reference<RelationshipKind>;
     source?: FqnRef;
@@ -842,7 +852,7 @@ export interface RelationStringProperty extends langium.AstNode {
     readonly $container: CustomRelationProperties | DeploymentRelationBody | RelationBody;
     readonly $type: 'RelationStringProperty';
     key: 'description' | 'technology' | 'title';
-    value: string;
+    value: MarkdownOrString;
 }
 export declare const RelationStringProperty = "RelationStringProperty";
 export declare function isRelationStringProperty(item: unknown): item is RelationStringProperty;
@@ -926,7 +936,7 @@ export interface SpecificationRelationshipStringProperty extends langium.AstNode
     readonly $container: SpecificationRelationshipKind;
     readonly $type: 'SpecificationRelationshipStringProperty';
     key: 'notation' | 'technology';
-    value: string;
+    value: MarkdownOrString;
 }
 export declare const SpecificationRelationshipStringProperty = "SpecificationRelationshipStringProperty";
 export declare function isSpecificationRelationshipStringProperty(item: unknown): item is SpecificationRelationshipStringProperty;
@@ -1055,7 +1065,7 @@ export interface ViewStringProperty extends langium.AstNode {
     readonly $container: DeploymentViewBody | DynamicViewBody | ElementViewBody;
     readonly $type: 'ViewStringProperty';
     key: 'description' | 'title';
-    value: string;
+    value: MarkdownOrString;
 }
 export declare const ViewStringProperty = "ViewStringProperty";
 export declare function isViewStringProperty(item: unknown): item is ViewStringProperty;
@@ -1222,6 +1232,7 @@ export type LikeC4AstType = {
     LikeC4View: LikeC4View;
     LineProperty: LineProperty;
     LinkProperty: LinkProperty;
+    MarkdownOrString: MarkdownOrString;
     MetadataAttribute: MetadataAttribute;
     MetadataBody: MetadataBody;
     MetadataProperty: MetadataProperty;

package/dist/generated/ast.js

@@ -4,6 +4,7 @@ export const LikeC4Terminals = {
   LINE_COMMENT: /\/\/[^\n\r]*/,
   WS: /[\t ]+/,
   NL: /[\r\n]+/,
+  BOOLEAN: /true|false/,
   LIB_ICON: /(aws|azure|gcp|tech):[-\w]*/,
   URI_WITH_SCHEMA: /\w+:\/{2}\S+/,
   URI_RELATIVE: /\.{0,2}\/[^\/]\S+/,
@@ -15,6 +16,7 @@ export const LikeC4Terminals = {
   NotEqual: /\!\={1,2}/,
   Eq: /\={1,2}/,
   Percent: /\b\d+%/,
+  MarkdownString: /(('''([\s\S]*?'''))|("""([\s\S]*?""")))/,
   String: /"(?:[^"\\]|\\.)*"|'(?:[^'\\]|\\.)*'/,
   Float: /\b\d+\.\d+\b/,
   Number: /\b\d+\b/,
@@ -24,9 +26,6 @@ export const LikeC4Terminals = {
 export function isArrowType(item) {
   return item === "none" || item === "normal" || item === "onormal" || item === "dot" || item === "odot" || item === "diamond" || item === "odiamond" || item === "crow" || item === "open" || item === "vee";
 }
-export function isBoolean(item) {
-  return typeof item === "boolean";
-}
 export function isBorderStyleValue(item) {
   return isLineOptions(item) || item === "none";
 }
@@ -448,6 +447,10 @@ export const LinkProperty = "LinkProperty";
 export function isLinkProperty(item) {
   return reflection.isInstance(item, LinkProperty);
 }
+export const MarkdownOrString = "MarkdownOrString";
+export function isMarkdownOrString(item) {
+  return reflection.isInstance(item, MarkdownOrString);
+}
 export const MetadataAttribute = "MetadataAttribute";
 export function isMetadataAttribute(item) {
   return reflection.isInstance(item, MetadataAttribute);
@@ -674,7 +677,7 @@ export function isWildcardExpression(item) {
 }
 export class LikeC4AstReflection extends langium.AbstractAstReflection {
   getAllTypes() {
-    return [ArrowProperty, BorderProperty, ColorLiteral, ColorProperty, CustomColor, CustomElementProperties, CustomRelationProperties, DeployedInstance, DeployedInstanceBody, DeploymentElement, DeploymentNode, DeploymentNodeBody, DeploymentNodeKind, DeploymentNodeOrElementKind, DeploymentRelation, DeploymentRelationBody, DeploymentView, DeploymentViewBody, DeploymentViewRule, DeploymentViewRulePredicate, DeploymentViewRuleStyle, DirectedRelationExpr, DynamicView, DynamicViewBody, DynamicViewGlobalPredicateRef, DynamicViewIncludePredicate, DynamicViewParallelSteps, DynamicViewRef, DynamicViewRule, DynamicViewStep, Element, ElementBody, ElementKind, ElementKindExpression, ElementProperty, ElementRef, ElementStringProperty, ElementStyleProperty, ElementTagExpression, ElementView, ElementViewBody, ElementViewRef, ExpressionV2, Expressions, ExtendDeployment, ExtendDeploymentBody, ExtendElement, ExtendElementBody, ExtendElementProperty, FqnExpr, FqnExprOrWhere, FqnExprOrWith, FqnExprWhere, FqnExprWith, FqnExpressions, FqnRef, FqnRefExpr, FqnReferenceable, GlobalDynamicPredicateGroup, GlobalPredicateGroup, GlobalStyle, GlobalStyleGroup, GlobalStyleId, Globals, HexColor, IconProperty, Imported, ImportsFromPoject, InOutRelationExpr, IncomingRelationExpr, LibIcon, LikeC4Grammar, LikeC4Lib, LikeC4View, LineProperty, LinkProperty, MetadataAttribute, MetadataBody, MetadataProperty, Model, ModelDeployments, ModelReferenceable, ModelViews, MultipleProperty, NavigateToProperty, NotationProperty, NotesProperty, OpacityProperty, OutgoingRelationExpr, PaddingSizeProperty, RGBAColor, Referenceable, Relation, RelationBody, RelationExpr, RelationExprOrWhere, RelationExprOrWith, RelationExprWhere, RelationExprWith, RelationKindDotRef, RelationNavigateToProperty, RelationProperty, RelationStringProperty, RelationStyleProperty, RelationshipKind, RelationshipStyleProperty, ShapeProperty, ShapeSizeProperty, SizeProperty, SpecificationColor, SpecificationDeploymentNodeKind, SpecificationElementKind, SpecificationElementStringProperty, SpecificationRelationshipKind, SpecificationRelationshipStringProperty, SpecificationRule, SpecificationTag, StrictFqnElementRef, StrictFqnRef, StringProperty, StyleProperty, Tag, TagRef, Tags, TextSizeProperty, ViewProperty, ViewRef, ViewRule, ViewRuleAutoLayout, ViewRuleGlobalPredicateRef, ViewRuleGlobalStyle, ViewRuleGroup, ViewRulePredicate, ViewRuleStyle, ViewRuleStyleOrGlobalRef, ViewStringProperty, WhereBinaryExpression, WhereElement, WhereElementExpression, WhereElementKind, WhereElementNegation, WhereElementTag, WhereExpression, WhereKindEqual, WhereRelation, WhereRelationExpression, WhereRelationKind, WhereRelationNegation, WhereRelationParticipantKind, WhereRelationParticipantTag, WhereRelationTag, WhereTagEqual, WildcardExpression];
+    return [ArrowProperty, BorderProperty, ColorLiteral, ColorProperty, CustomColor, CustomElementProperties, CustomRelationProperties, DeployedInstance, DeployedInstanceBody, DeploymentElement, DeploymentNode, DeploymentNodeBody, DeploymentNodeKind, DeploymentNodeOrElementKind, DeploymentRelation, DeploymentRelationBody, DeploymentView, DeploymentViewBody, DeploymentViewRule, DeploymentViewRulePredicate, DeploymentViewRuleStyle, DirectedRelationExpr, DynamicView, DynamicViewBody, DynamicViewGlobalPredicateRef, DynamicViewIncludePredicate, DynamicViewParallelSteps, DynamicViewRef, DynamicViewRule, DynamicViewStep, Element, ElementBody, ElementKind, ElementKindExpression, ElementProperty, ElementRef, ElementStringProperty, ElementStyleProperty, ElementTagExpression, ElementView, ElementViewBody, ElementViewRef, ExpressionV2, Expressions, ExtendDeployment, ExtendDeploymentBody, ExtendElement, ExtendElementBody, ExtendElementProperty, FqnExpr, FqnExprOrWhere, FqnExprOrWith, FqnExprWhere, FqnExprWith, FqnExpressions, FqnRef, FqnRefExpr, FqnReferenceable, GlobalDynamicPredicateGroup, GlobalPredicateGroup, GlobalStyle, GlobalStyleGroup, GlobalStyleId, Globals, HexColor, IconProperty, Imported, ImportsFromPoject, InOutRelationExpr, IncomingRelationExpr, LibIcon, LikeC4Grammar, LikeC4Lib, LikeC4View, LineProperty, LinkProperty, MarkdownOrString, MetadataAttribute, MetadataBody, MetadataProperty, Model, ModelDeployments, ModelReferenceable, ModelViews, MultipleProperty, NavigateToProperty, NotationProperty, NotesProperty, OpacityProperty, OutgoingRelationExpr, PaddingSizeProperty, RGBAColor, Referenceable, Relation, RelationBody, RelationExpr, RelationExprOrWhere, RelationExprOrWith, RelationExprWhere, RelationExprWith, RelationKindDotRef, RelationNavigateToProperty, RelationProperty, RelationStringProperty, RelationStyleProperty, RelationshipKind, RelationshipStyleProperty, ShapeProperty, ShapeSizeProperty, SizeProperty, SpecificationColor, SpecificationDeploymentNodeKind, SpecificationElementKind, SpecificationElementStringProperty, SpecificationRelationshipKind, SpecificationRelationshipStringProperty, SpecificationRule, SpecificationTag, StrictFqnElementRef, StrictFqnRef, StringProperty, StyleProperty, Tag, TagRef, Tags, TextSizeProperty, ViewProperty, ViewRef, ViewRule, ViewRuleAutoLayout, ViewRuleGlobalPredicateRef, ViewRuleGlobalStyle, ViewRuleGroup, ViewRulePredicate, ViewRuleStyle, ViewRuleStyleOrGlobalRef, ViewStringProperty, WhereBinaryExpression, WhereElement, WhereElementExpression, WhereElementKind, WhereElementNegation, WhereElementTag, WhereExpression, WhereKindEqual, WhereRelation, WhereRelationExpression, WhereRelationKind, WhereRelationNegation, WhereRelationParticipantKind, WhereRelationParticipantTag, WhereRelationTag, WhereTagEqual, WildcardExpression];
   }
   computeIsSubtype(subtype, supertype) {
     switch (subtype) {
@@ -1019,6 +1022,7 @@ export class LikeC4AstReflection extends langium.AbstractAstReflection {
           name: DeploymentRelation,
           properties: [
             { name: "body" },
+            { name: "description" },
             { name: "dotKind" },
             { name: "kind" },
             { name: "source" },
@@ -1500,6 +1504,15 @@ export class LikeC4AstReflection extends langium.AbstractAstReflection {
           ]
         };
       }
+      case MarkdownOrString: {
+        return {
+          name: MarkdownOrString,
+          properties: [
+            { name: "markdown" },
+            { name: "text" }
+          ]
+        };
+      }
       case MetadataAttribute: {
         return {
           name: MetadataAttribute,
@@ -1550,7 +1563,7 @@ export class LikeC4AstReflection extends langium.AbstractAstReflection {
           name: MultipleProperty,
           properties: [
             { name: "key" },
-            { name: "value" }
+            { name: "value", defaultValue: false }
           ]
         };
       }
@@ -1615,6 +1628,7 @@ export class LikeC4AstReflection extends langium.AbstractAstReflection {
           name: Relation,
           properties: [
             { name: "body" },
+            { name: "description" },
             { name: "dotKind" },
             { name: "kind" },
             { name: "source" },