@likec4/language-server 1.21.1 → 1.22.1

package/dist/index.d.ts

@@ -1,12 +1,12 @@
 import { LikeC4FileSystem } from './LikeC4FileSystem';
 import { type LikeC4Services, type LikeC4SharedServices } from './module';
-export { logger as lspLogger, setLogLevel } from './logger';
+export { getLspConnectionSink, logger as lspLogger } from './logger';
 export type { DocumentParser, LikeC4ModelBuilder, LikeC4ModelLocator, LikeC4ModelParser } from './model';
 export { createCustomLanguageServices, createLanguageServices, LikeC4Module } from './module';
 export type { LikeC4Services, LikeC4SharedServices } from './module';
 export type { LikeC4Views } from './views';
 export { LikeC4FileSystem };
-export declare function startLanguageServer(): {
+export declare function startLanguageServer(): Promise<{
     shared: LikeC4SharedServices;
     likec4: LikeC4Services;
-};
+}>;

package/dist/index.js

@@ -1,13 +1,30 @@
+import { configureLogger, getConsoleSink, getTextFormatter } from "@likec4/log";
 import { startLanguageServer as startLanguim } from "langium/lsp";
 import { createConnection, ProposedFeatures } from "vscode-languageserver/node";
 import { LikeC4FileSystem } from "./LikeC4FileSystem.js";
+import { getTelemetrySink, logger } from "./logger.js";
 import { createCustomLanguageServices } from "./module.js";
 import { ConfigurableLayouter } from "./views/configurable-layouter.js";
-export { logger as lspLogger, setLogLevel } from "./logger.js";
+export { getLspConnectionSink, logger as lspLogger } from "./logger.js";
 export { createCustomLanguageServices, createLanguageServices, LikeC4Module } from "./module.js";
 export { LikeC4FileSystem };
-export function startLanguageServer() {
+export async function startLanguageServer() {
   const connection = createConnection(ProposedFeatures.all);
+  await configureLogger({
+    sinks: {
+      console: getConsoleSink({
+        formatter: getTextFormatter()
+      }),
+      telemetry: getTelemetrySink(connection)
+    },
+    loggers: [
+      {
+        category: ["likec4"],
+        sinks: ["console", "telemetry"]
+      }
+    ]
+  });
+  logger.info("Starting LikeC4 language server");
   const services = createCustomLanguageServices({ connection, ...LikeC4FileSystem }, ConfigurableLayouter);
   startLanguim(services.shared);
   return services;

package/dist/logger.d.ts

@@ -1,4 +1,4 @@
-import { LogLevels } from '@likec4/log';
+import { type Sink, type TextFormatter } from '@likec4/log';
 import type { Connection } from 'vscode-languageserver';
 export declare const logger: any;
 export declare function logError(err: unknown): void;
@@ -6,5 +6,12 @@ export declare function logError(err: unknown): void;
  * Logs an error as warning (not critical)
  */
 export declare function logWarnError(err: unknown): void;
-export declare function setLogLevel(level: keyof typeof LogLevels): void;
-export declare function logToLspConnection(connection: Connection): void;
+type LspConnectionSinkProps = {
+    /**
+     * The text formatter to use.  Defaults to {@link defaultTextFormatter}.
+     */
+    formatter?: TextFormatter;
+};
+export declare function getLspConnectionSink(connection: Connection, props?: LspConnectionSinkProps): Sink;
+export declare function getTelemetrySink(connection: Connection): Sink;
+export {};

package/dist/logger.js

@@ -1,69 +1,75 @@
-import { nonexhaustive } from "@likec4/core";
-import { formatLogObj, LogLevels, rootLogger as root } from "@likec4/log";
-import { BROWSER } from "esm-env";
-export const logger = root.withTag("lsp");
+import {
+  errorFromLogRecord,
+  getMessageOnlyFormatter,
+  getTextFormatter,
+  loggable,
+  logger as root
+} from "@likec4/log";
+export const logger = root.getChild("server");
 export function logError(err) {
-  logger.error(err);
+  logger.error(loggable(err));
 }
 export function logWarnError(err) {
-  logger.warn(err);
+  logger.warn(loggable(err));
 }
-export function setLogLevel(level) {
-  logger.level = LogLevels[level];
-}
-export function logToLspConnection(connection) {
-  const reporter = {
-    log: (logObj, _ctx) => {
-      const { message, error } = formatLogObj(logObj);
-      switch (logObj.type) {
-        case "silent": {
-          break;
-        }
-        case "verbose":
-        case "trace": {
-          connection.tracer.log(message);
-          break;
-        }
-        case "debug": {
-          connection.console.debug(message);
-          break;
-        }
-        case "log": {
-          connection.console.log(message);
+export function getLspConnectionSink(connection, props) {
+  const format = props?.formatter ?? getTextFormatter({
+    format: ({ category, message }) => {
+      return `${category} ${message}`;
+    }
+  });
+  return (logObj) => {
+    try {
+      switch (logObj.level) {
+        case "debug":
+          connection.console.debug(format(logObj));
           break;
-        }
         case "info":
-        case "box":
-        case "ready":
-        case "start":
-        case "success": {
-          connection.console.info(message);
+          connection.console.info(format(logObj));
           break;
-        }
-        case "warn": {
-          connection.console.warn(message);
+        case "warning":
+          connection.console.warn(format(logObj));
+          break;
+        case "error":
+        case "fatal": {
+          connection.console.error(format(logObj));
           break;
         }
-        case "fail":
+      }
+    } catch (e) {
+      console.error("Error while logging to LSP connection:", e);
+    }
+  };
+}
+export function getTelemetrySink(connection) {
+  const messageOnly = getMessageOnlyFormatter();
+  return (logObj) => {
+    try {
+      switch (logObj.level) {
         case "error":
         case "fatal": {
-          connection.console.error(message);
-          if (error) {
-            connection.telemetry.logEvent({ eventName: "error", ...error });
+          const err = errorFromLogRecord(logObj);
+          if (err) {
+            connection.telemetry.logEvent({
+              eventName: "error",
+              message: `${err.name}: ${err.message}`,
+              category: logObj.category.join("."),
+              ...err.stack && {
+                stack: err.stack
+              }
+            });
           } else {
-            connection.telemetry.logEvent({ eventName: "error", message });
+            connection.telemetry.logEvent({
+              eventName: "error",
+              message: messageOnly(logObj),
+              category: logObj.category.join(".")
+            });
           }
           break;
         }
-        default:
-          nonexhaustive(logObj.type);
       }
+    } catch (e) {
+      console.error("Error while logging to LSP connection:", e);
     }
   };
-  if (BROWSER) {
-    root.addReporter(reporter);
-  } else {
-    root.setReporters([reporter]);
-  }
-  logger.setReporters(root.options.reporters);
 }

package/dist/model/fqn-computation.js

@@ -2,7 +2,7 @@ import { AsFqn, LinkedList, nonexhaustive } from "@likec4/core";
 import { AstUtils, CstUtils, GrammarUtils, MultiMap } from "langium";
 import { isDefined, isEmpty } from "remeda";
 import { ast, ElementOps } from "../ast.js";
-import { logError } from "../logger.js";
+import { logWarnError } from "../logger.js";
 import { getFqnElementRef } from "../utils/elementRef.js";
 const { findNodeForProperty } = GrammarUtils;
 const { toDocumentSegment } = CstUtils;
@@ -66,7 +66,7 @@ export function computeDocumentFqn(document, services) {
       }
       nonexhaustive(el);
     } catch (e) {
-      logError(e);
+      logWarnError(e);
     }
   }
 }

package/dist/model/model-builder.js

@@ -114,7 +114,7 @@ function buildModel(services, docs) {
       try {
         const __kind = c4Specification.elements[kind];
         if (!__kind) {
-          logger.warn(`No kind '${kind}' found for ${id}`);
+          logger.warn`No kind '${kind}' found for ${id}`;
           return null;
         }
         const links = unresolvedLinks ? resolveLinks(doc, unresolvedLinks) : null;
@@ -210,7 +210,7 @@ function buildModel(services, docs) {
       (acc, el) => {
         const parent = parentFqn(el.id);
         if (parent && isNullish(acc[parent])) {
-          logWarnError(`No parent found for ${el.id}`);
+          logger.debug`No parent found for ${el.id}`;
           return acc;
         }
         acc[el.id] = withExtendElementData(el);
@@ -230,9 +230,10 @@ function buildModel(services, docs) {
       ...model
     }) => {
       if (isNullish(elements[source]) || isNullish(elements[target])) {
-        logger.warn(
-          `Invalid relation ${id} at ${doc.uri.path} ${astPath}, source: ${source}(${!!elements[source]}), target: ${target}(${!!elements[target]})`
-        );
+        logger.debug`Invalid relation ${id}
+  source: ${source} resolved: ${!!elements[source]}
+  target: ${target} resolved: ${!!elements[target]}
+  at ${doc.uri.path}\n`;
         return null;
       }
       const links = unresolvedLinks ? resolveLinks(doc, unresolvedLinks) : null;
@@ -279,7 +280,7 @@ function buildModel(services, docs) {
       try {
         const __kind = c4Specification.deployments[parsed.kind];
         if (!__kind) {
-          logger.warn(`No kind '${parsed.kind}' found for ${parsed.id}`);
+          logger.warn`No kind ${parsed.kind} found for ${parsed.id}`;
           return null;
         }
         let {
@@ -317,7 +318,7 @@ function buildModel(services, docs) {
       (acc, el) => {
         const parent = parentFqn(el.id);
         if (parent && isNullish(acc[parent])) {
-          logWarnError(`No parent found for deployment element ${el.id}`);
+          logger.debug`No parent found for deployment element ${el.id}`;
           return acc;
         }
         acc[el.id] = el;
@@ -337,9 +338,7 @@ function buildModel(services, docs) {
       ...model
     }) => {
       if (isNullish(deploymentElements[source.id]) || isNullish(deploymentElements[target.id])) {
-        logger.warn(
-          `Invalid deployment relation ${id} at ${doc.uri.path} ${astPath}, source: ${source.id}(${!!deploymentElements[source.id]}), target: ${target.id}(${!!deploymentElements[target.id]})`
-        );
+        logger.warn`Invalid deployment relation ${id} at ${doc.uri.path} ${astPath}, source: ${source.id}(${!!deploymentElements[source.id]}), target: ${target.id}(${!!deploymentElements[target.id]})`;
         return null;
       }
       const links = unresolvedLinks ? resolveLinks(doc, unresolvedLinks) : null;
@@ -370,7 +369,7 @@ function buildModel(services, docs) {
     reduce(
       (acc, el) => {
         if (isDefined(acc[el.id])) {
-          logWarnError(`Duplicate deployment relation ${el.id}`);
+          logger.debug`Duplicate deployment relation ${el.id}`;
           return acc;
         }
         acc[el.id] = el;
@@ -480,7 +479,7 @@ export class LikeC4ModelBuilder extends ADisposable {
         DocumentState.Validated,
         async (docs, _cancelToken) => {
           let parsed = [];
-          logger.debug(`[ModelBuilder] onValidated (${docs.length} docs)`);
+          logger.debug`[ModelBuilder] onValidated (${docs.length} docs)`;
           for (const doc of docs) {
             try {
               parsed.push(parser.parse(doc).uri);
@@ -495,7 +494,7 @@ export class LikeC4ModelBuilder extends ADisposable {
         }
       )
     );
-    logger.debug(`[ModelBuilder] Created`);
+    logger.debug`[ModelBuilder] Created`;
   }
   langiumDocuments;
   listeners = [];
@@ -512,7 +511,7 @@ export class LikeC4ModelBuilder extends ADisposable {
     }
     const cache = this.services.WorkspaceCache;
     return cache.get(CACHE_KEY_PARSED_MODEL, () => {
-      logger.debug(`[ModelBuilder] buildModel (${docs.length} docs)`);
+      logger.debug`[ModelBuilder] buildModel (${docs.length} docs)`;
       return buildModel(this.services, docs);
     });
   }

package/dist/model-change/ModelChanges.js

@@ -40,8 +40,8 @@ export class LikeC4ModelChanges {
           range: modifiedRange
         };
       });
-    } catch (e) {
-      logger.error(`Failed to apply change ${changeView.change.op} ${changeView.viewId}`, e);
+    } catch (error) {
+      logger.error(`Failed to apply change ${changeView.change.op} ${changeView.viewId}`, { error });
     }
     return result;
   }

package/dist/module.js

@@ -15,7 +15,7 @@ import {
   LikeC4GeneratedModule,
   LikeC4GeneratedSharedModule
 } from "./generated/module.js";
-import { logger, logToLspConnection } from "./logger.js";
+import { logger } from "./logger.js";
 import {
   LikeC4CodeLensProvider,
   LikeC4CompletionProvider,
@@ -120,9 +120,6 @@ export function createSharedServices(context = {}) {
     ...EmptyFileSystem,
     ...context
   };
-  if (context.connection) {
-    logToLspConnection(context.connection);
-  }
   return inject(
     createDefaultSharedModule(moduleContext),
     LikeC4GeneratedSharedModule,

package/dist/references/scope-provider.js

@@ -11,7 +11,7 @@ import {
   StreamScope
 } from "langium";
 import { ast } from "../ast.js";
-import { logger } from "../logger.js";
+import { logWarnError } from "../logger.js";
 import { elementRef, getFqnElementRef } from "../utils/elementRef.js";
 const { getDocument } = AstUtils;
 export class LikeC4ScopeProvider extends DefaultScopeProvider {
@@ -98,11 +98,11 @@ export class LikeC4ScopeProvider extends DefaultScopeProvider {
         }
         return this.computeScope(context);
       } catch (e) {
-        logger.warn(e);
+        logWarnError(e);
         return this.getGlobalScope(referenceType, context);
       }
     } catch (e) {
-      logger.warn(e);
+      logWarnError(e);
       return EMPTY_SCOPE;
     }
   }

package/dist/view-utils/manual-layout.js

@@ -3,7 +3,7 @@ import { decode, encode } from "@msgpack/msgpack";
 import { fromBase64, toBase64 } from "@smithy/util-base64";
 import { AstUtils, CstUtils } from "langium";
 import { mapValues } from "remeda";
-import { logger } from "../logger.js";
+import { logger, logWarnError } from "../logger.js";
 const { getDocument } = AstUtils;
 function pack({
   nodes,
@@ -90,7 +90,7 @@ export function parseViewManualLayout(node) {
     return deserializeFromComment(commentNode.text);
   } catch (e) {
     const doc = getDocument(node);
-    logger.warn(e);
+    logWarnError(e);
     logger.warn(
       `Ignoring manual layout of "${node.name ?? "unnamed"}" at ${doc.uri.fsPath}:${1 + (commentNode.range.start.line || 0)}`
     );

package/dist/views/configurable-layouter.js

@@ -7,7 +7,7 @@ function graphvizBinPath() {
   try {
     return which.sync("dot");
   } catch (error) {
-    logger.error("Error checking for native Graphviz:", error);
+    logger.error("Error checking for native Graphviz:", { error });
     return null;
   }
 }
@@ -19,7 +19,7 @@ export const ConfigurableLayouter = {
       const layouter = new GraphvizLayouter(wasmAdapter);
       const langId = services.LanguageMetaData.languageId;
       services.shared.workspace.ConfigurationProvider.onConfigurationSectionUpdate((update) => {
-        logger.debug("Configuration update", update);
+        logger.debug("Configuration update", { update });
         if (update.section === langId) {
           try {
             const { mode, path } = update.configuration.graphviz ?? {
@@ -43,11 +43,11 @@ export const ConfigurableLayouter = {
             layouter.changePort(new GraphvizBinaryAdapter(binaryPath));
             logger.info(`use graphviz binary: ${binaryPath}`);
           } catch (error) {
-            logger.error("Failed to update configuration", error);
+            logger.error("Failed to update configuration", { error });
           }
           return;
         }
-        logger.warn("Unexpected configuration update", update);
+        logger.warn("Unexpected configuration update", { update });
       });
       return layouter;
     }

package/dist/views/likec4-views.d.ts

@@ -1,4 +1,5 @@
 import type { ComputedView, DiagramView, OverviewGraph, ViewId } from '@likec4/core';
+import { GraphvizLayouter } from '@likec4/layouts';
 import { type Cancellation } from 'langium';
 import type { LikeC4Services } from '../module';
 export type GraphvizOut = {
@@ -15,7 +16,7 @@ export declare class LikeC4Views {
     private cache;
     private viewsWithReportedErrors;
     constructor(services: LikeC4Services);
-    private get layouter();
+    get layouter(): GraphvizLayouter;
     computedViews(cancelToken?: Cancellation.CancellationToken): Promise<ComputedView[]>;
     layoutAllViews(cancelToken?: Cancellation.CancellationToken): Promise<Array<Readonly<GraphvizOut>>>;
     layoutView(viewId: ViewId, cancelToken?: Cancellation.CancellationToken): Promise<GraphvizOut | null>;

package/dist/views/likec4-views.js

@@ -1,5 +1,5 @@
 import { values } from "remeda";
-import { logger, logWarnError } from "../logger.js";
+import { logError, logWarnError } from "../logger.js";
 export class LikeC4Views {
   constructor(services) {
     this.services = services;
@@ -64,7 +64,7 @@ export class LikeC4Views {
         this.services.shared.lsp.Connection?.window.showErrorMessage(`LikeC4: ${errMessage}`);
         this.viewsWithReportedErrors.add(viewId);
       }
-      logger.error(e);
+      logError(e);
       return Promise.reject(e);
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@likec4/language-server",
   "description": "LikeC4 Language Server",
-  "version": "1.21.1",
+  "version": "1.22.1",
   "license": "MIT",
   "bugs": "https://github.com/likec4/likec4/issues",
   "homepage": "https://likec4.dev",
@@ -9,7 +9,6 @@
   "files": [
     "bin",
     "dist",
-    "src",
     "!**/__mocks__/",
     "!**/__tests__/",
     "!**/*.spec.*",
@@ -21,7 +20,7 @@
     "directory": "packages/language-server"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=20.18.3"
   },
   "engineStrict": true,
   "type": "module",
@@ -89,15 +88,18 @@
     "vitest:ui": "vitest --no-isolate --ui",
     "test:watch": "vitest"
   },
+  "dependencies": {
+    "@hpcc-js/wasm-graphviz": "1.7.0"
+  },
   "devDependencies": {
-    "@likec4/core": "1.21.1",
-    "@likec4/icons": "1.21.1",
-    "@likec4/layouts": "1.21.1",
-    "@likec4/log": "1.21.1",
-    "@likec4/tsconfig": "1.21.1",
-    "@msgpack/msgpack": "^3.0.0-beta4",
+    "@likec4/core": "1.22.1",
+    "@likec4/icons": "1.22.1",
+    "@likec4/layouts": "1.22.1",
+    "@likec4/log": "1.22.1",
+    "@likec4/tsconfig": "1.22.1",
+    "@msgpack/msgpack": "^3.0.0",
     "@smithy/util-base64": "^4.0.0",
-    "@types/node": "^20.17.7",
+    "@types/node": "^20.17.17",
     "@types/which": "^3.0.4",
     "@vitest/coverage-v8": "^3.0.4",
     "esm-env": "^1.2.2",
@@ -113,7 +115,7 @@
     "strip-indent": "^4.0.0",
     "tsx": "~4.19.2",
     "turbo": "^2.4.0",
-    "type-fest": "4.28.1",
+    "type-fest": "4.34.1",
     "typescript": "^5.7.3",
     "ufo": "^1.5.4",
     "unbuild": "^3.3.1",
@@ -122,7 +124,7 @@
     "vscode-languageserver": "9.0.1",
     "vscode-languageserver-types": "3.17.5",
     "vscode-uri": "3.0.8",
-    "which": "^4.0.0"
+    "which": "^5.0.0"
   },
   "packageManager": "yarn@4.6.0"
 }

package/dist/test/setup.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test/setup.js

@@ -1,7 +0,0 @@
-import { consola } from "@likec4/log";
-import { beforeEach, vi } from "vitest";
-import { logger } from "../logger.js";
-beforeEach(() => {
-  consola.mockTypes(() => vi.fn());
-  logger.mockTypes(() => vi.fn());
-});

package/src/LikeC4FileSystem.ts

@@ -1,38 +0,0 @@
-import { fdir } from 'fdir'
-import { type FileSystemNode, URI } from 'langium'
-import { NodeFileSystemProvider } from 'langium/node'
-import { LikeC4LanguageMetaData } from './generated/module'
-import { logger } from './logger'
-
-export const LikeC4FileSystem = {
-  fileSystemProvider: () => new SymLinkTraversingFileSystemProvider(),
-}
-
-const hasExtension = (path: string) => LikeC4LanguageMetaData.fileExtensions.some((ext) => path.endsWith(ext))
-/**
- * A file system provider that follows symbolic links.
- * @see https://github.com/likec4/likec4/pull/1213
- */
-class SymLinkTraversingFileSystemProvider extends NodeFileSystemProvider {
-  override async readDirectory(folderPath: URI): Promise<FileSystemNode[]> {
-    const entries = [] as FileSystemNode[]
-    try {
-      const crawled = await new fdir()
-        .withSymlinks()
-        .withFullPaths()
-        .filter(hasExtension)
-        .crawl(folderPath.fsPath)
-        .withPromise()
-      for (const path of crawled) {
-        entries.push({
-          isFile: true,
-          isDirectory: false,
-          uri: URI.file(path),
-        })
-      }
-    } catch (error) {
-      logger.error(error)
-    }
-    return entries
-  }
-}