Merge branch 'main' of github.com:lstreckeisen/context-mapper-language-server into CMI-95-Improve-Language-Server-Command-error-handling

lstreckeisen · lstreckeisen · commit f3e386bdb918 · 2025-05-21T16:08:51.000+02:00
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/docs/class_formatting.puml b/docs/class_formatting.puml
@@ -1,17 +1,19 @@
 @startuml
-abstract class AbstractFormatter
+abstract class AbstractFormatter {
+{abstract} # format(node: AstNode)
+}
 
 class ContextMapperDslFormatter {
-# format(AstNode)
+# format(node: AstNode)
 }
 
 interface ContextMapperFormatter {
-+ format(T, NodeFormatter<T>)
++ format(node: T, formatter: NodeFormatter<T>)
 }
 
 class ContextMapperFormatterRegistry {
 - _formatters: Map<string, ContextMapperFormatter<AstNode>>
-+ get(AstNode): ContextMapperFormatter<AstNode> | undefined
++ get(node: AstNode): ContextMapperFormatter<AstNode> | undefined
 }
 
 AbstractFormatter <|-- ContextMapperDslFormatter
diff --git a/docs/class_generators.puml b/docs/class_generators.puml
@@ -1,18 +1,29 @@
 @startuml
 
+<style>
+class {
+    MaximumWidth: 500
+}
+</style>
+
+abstract class AbstractExecuteCommandHandler {
+{abstract} + registerCommands(ExecuteCommandAcceptor)
+}
+
 class ContextMapperCommandHandler {
 + registerCommands(ExecuteCommandAcceptor)
 }
 
 class GeneratorCommandExecutor {
 - serviceRegistry: ServiceRegistry
-+ execute(ContextMapperGenerator, unknown[], CancellationToken)
++ execute(generator: ContextMapperGenerator, args: unknown[], cancelToken: CancellationToken): Promise<string[]>
 }
 
 interface ContextMapperGenerator {
-+ generate(ContextMappingModel, string, unknown[], CancellationToken)
++ generate(model: ContextMappingModel, filePath: string, args: unknown[], cancelToken: CancellationToken): Promise<string[]>
 }
 
+AbstractExecuteCommandHandler <|-- ContextMapperCommandHandler
 ContextMapperCommandHandler *-- "1" GeneratorCommandExecutor
 ContextMapperCommandHandler o-- "0..*" ContextMapperGenerator
 
diff --git a/docs/class_semantic_tokens.puml b/docs/class_semantic_tokens.puml
@@ -1,17 +1,19 @@
 @startuml
-abstract class AbstractSemanticTokenProvider
+abstract class AbstractSemanticTokenProvider {
+{abstract} # highlightElement(node: AstNode, acceptor: SemanticTokenAcceptor)
+}
 
 class ContextMapperDslSemanticTokenProvider {
-# highlightElement(AstNode, SemanticTokenAcceptor)
+# highlightElement(node: AstNode, acceptor: SemanticTokenAcceptor)
 }
 
 class SemanticTokenProviderRegistry {
 - semanticTokenProviders: Map<string, ContextMapperSemanticTokenProvider<AstNode>>
-+ get(AstNode): ContextMapperSemanticTokenProvider<AstNode>
++ get(node: AstNode): ContextMapperSemanticTokenProvider<AstNode> | undefined
 }
 
 interface ContextMapperSemanticTokenProvider {
-+ highlight(T, SemanticTokenAcceptor)
++ highlight(node: T, acceptor: SemanticTokenAcceptor)
 }
 
 AbstractSemanticTokenProvider <|-- ContextMapperDslSemanticTokenProvider
diff --git a/docs/class_semantic_validation.puml b/docs/class_semantic_validation.puml
@@ -1,22 +1,22 @@
 @startuml
 abstract class ValidationRegistry {
-+ register(ValidationChecks<T>, ThisParameterType)
++ register(checks: ValidationChecks<T>, validator: ThisParameterType)
 }
 
 class ContextMapperDslValidationRegistry {
 }
 
 class ContextMapperDslValidator {
-+ validate(AstNode, ValidationAcceptor)
++ validate(node: AstNode, acceptor: ValidationAcceptor)
 }
 
 class ContextMapperValidationProviderRegistry {
 - _providers: Map<string, ContextMapperValidationProvider<AstNode>>
-+ get(AstNode): ContextMapperValidationProvider<AstNode>
++ get(node: AstNode): ContextMapperValidationProvider<AstNode> | undefined
 }
 
 interface ContextMapperValidationProvider {
-+ validate(T, ValidationAcceptor)
++ validate(node: T, acceptor: ValidationAcceptor)
 }
 
 ValidationRegistry <|-- ContextMapperDslValidationRegistry
diff --git a/package.json b/package.json
@@ -40,6 +40,7 @@
         "eslint": "~9.26.0",
         "jiti": "^2.4.2",
         "langium-cli": "~3.5.0",
+        "tsarch": "^5.4.1",
         "typescript": "~5.8.3",
         "typescript-eslint": "^8.32.1",
         "vitest": "^3.1.3"
diff --git a/src/language/commands/ContextMapperCommandHandler.ts b/src/language/commands/ContextMapperCommandHandler.ts
@@ -1,8 +1,8 @@
 import { AbstractExecuteCommandHandler, ExecuteCommandAcceptor, ExecuteCommandFunction } from 'langium/lsp'
 import { LangiumDefaultSharedCoreServices } from 'langium'
 import { GeneratorCommandExecutor } from './GeneratorCommandExecutor.js'
-import { PlantUMLGenerator } from '../generators/PlantUMLGenerator.js'
-import { ContextMapperGenerator } from '../generators/ContextMapperGenerator.js'
+import { PlantUMLGenerator } from './generators/PlantUMLGenerator.js'
+import { ContextMapperGenerator } from './generators/ContextMapperGenerator.js'
 
 export class ContextMapperCommandHandler extends AbstractExecuteCommandHandler {
   private readonly generatorCommandExecutor: GeneratorCommandExecutor
diff --git a/src/language/commands/GeneratorCommandExecutor.ts b/src/language/commands/GeneratorCommandExecutor.ts
@@ -1,7 +1,7 @@
 import { ServiceRegistry, URI } from 'langium'
 import path from 'node:path'
 import fs from 'node:fs'
-import { ContextMapperGenerator } from '../generators/ContextMapperGenerator.js'
+import { ContextMapperGenerator } from './generators/ContextMapperGenerator.js'
 import { ContextMappingModel } from '../generated/ast.js'
 import { ContextMapperDslLanguageMetaData } from '../generated/module.js'
 import { ContextMapperDslServices } from '../ContextMapperDslModule.js'
diff --git a/src/language/commands/generators/ContextMapperGenerator.ts b/src/language/commands/generators/ContextMapperGenerator.ts
@@ -1,4 +1,4 @@
-import { ContextMappingModel } from '../generated/ast.js'
+import { ContextMappingModel } from '../../generated/ast.js'
 import { CancellationToken } from 'vscode-languageserver'
 
 export interface ContextMapperGenerator {
diff --git a/src/language/commands/generators/PlantUMLGenerator.ts b/src/language/commands/generators/PlantUMLGenerator.ts
@@ -1,7 +1,7 @@
 import { ContextMapperGenerator } from './ContextMapperGenerator.js'
 import path from 'node:path'
 import fs from 'node:fs'
-import { ContextMappingModel } from '../generated/ast.js'
+import { ContextMappingModel } from '../../generated/ast.js'
 import { ComponentDiagramGenerator } from './plantuml/ComponentDiagramGenerator.js'
 import { CancellationToken } from 'vscode-languageserver'
 
diff --git a/src/language/commands/generators/plantuml/ComponentDiagramGenerator.ts b/src/language/commands/generators/plantuml/ComponentDiagramGenerator.ts
@@ -13,7 +13,7 @@ import {
   Relationship,
   SymmetricRelationship,
   UpstreamDownstreamRelationship, UpstreamRole
-} from '../../generated/ast.js'
+} from '../../../generated/ast.js'
 import { PlantUMLBuilder } from './PlantUMLBuilder.js'
 
 export class ComponentDiagramGenerator implements PlantUMLDiagramGenerator<ContextMap> {
diff --git a/src/language/commands/generators/plantuml/PlantUMLBuilder.ts b/src/language/commands/generators/plantuml/PlantUMLBuilder.ts
diff --git a/src/language/commands/generators/plantuml/PlantUMLDiagramGenerator.ts b/src/language/commands/generators/plantuml/PlantUMLDiagramGenerator.ts
diff --git a/test/archunit/SeparationOfConcerns.test.ts b/test/archunit/SeparationOfConcerns.test.ts
@@ -0,0 +1,27 @@
+import { describe, expect, test } from 'vitest'
+import { filesOfProject } from 'tsarch'
+import fs from 'node:fs'
+import path from 'node:path'
+
+describe('Ensure separation of concerns', () => {
+  test('check language-internal dependencies', async () => {
+    const langFolders = fs.readdirSync(path.join(__dirname, '..', '..', 'src', 'language'), { withFileTypes: true })
+      .filter(file => file.isDirectory() && file.name !== 'generated')
+      .map(file => path.join('language', file.name))
+
+    for (const sourceFolder of langFolders) {
+      const ruleBuilder = filesOfProject()
+        .inFolder(sourceFolder)
+        .shouldNot()
+        .dependOnFiles()
+
+
+      for (const objectFolder of langFolders.filter(folder => folder !== sourceFolder)) {
+        const rule = ruleBuilder.inFolder(objectFolder)
+
+        const violations = await rule.check()
+        expect(violations, `expect ${sourceFolder} not to depend on ${objectFolder}`).toHaveLength(0)
+      }
+    }
+  })
+})
diff --git a/test/commands/PlantUMLComponentDiagramPerformance.test.ts b/test/commands/PlantUMLComponentDiagramPerformance.test.ts
@@ -0,0 +1,40 @@
+import { afterEach, beforeAll, describe, expect, test } from 'vitest'
+import path from 'node:path'
+import fs from 'node:fs'
+import { createContextMapperDslServices } from '../../src/language/ContextMapperDslModule.js'
+import { NodeFileSystem } from 'langium/node'
+import { clearDocuments } from 'langium/test'
+import { ExecuteCommandHandler } from 'langium/lsp'
+
+const outDir = path.join(__dirname, 'out')
+
+let services: ReturnType<typeof createContextMapperDslServices>
+let commandHandler: ExecuteCommandHandler
+
+beforeAll(() => {
+  services = createContextMapperDslServices(NodeFileSystem)
+  commandHandler = services.shared.lsp.ExecuteCommandHandler!
+})
+
+afterEach(async () => {
+  await clearDocuments(services.shared, services.shared.workspace.LangiumDocuments.all.toArray())
+  fs.rmSync(outDir, {
+    recursive: true,
+    force: true
+  })
+})
+
+describe('PlantUML component diagram generation - performance test', () => {
+  test('test PlantUML generation performance for stage 3 DDD-Sample', async () => {
+    const file = path.join(__dirname, '..', 'example-files', 'DDD-Sample-Stage-3.cml')
+
+    const startTime = Date.now()
+    const result = await commandHandler.executeCommand('org.contextmapper.GeneratePlantUML', [file, outDir])
+    const endTime = Date.now()
+
+    expect(result).toHaveLength(1)
+    const outContent = fs.readdirSync(outDir)
+    expect(outContent).toHaveLength(1)
+    expect(endTime - startTime).toBeLessThanOrEqual(500)
+  })
+})
diff --git a/test/commands/generators/ComponentDiagramGenereator.test.ts b/test/commands/generators/ComponentDiagramGenereator.test.ts
@@ -1,6 +1,6 @@
 // adapted from https://github.com/ContextMapper/context-mapper-dsl/blob/master/org.contextmapper.dsl.tests/src/org/contextmapper/dsl/generators/plantuml/PlantUMLComponentDiagramCreatorTest.java
 
-import { ComponentDiagramGenerator } from '../../src/language/generators/plantuml/ComponentDiagramGenerator.js'
+import { ComponentDiagramGenerator } from '../../../src/language/commands/generators/plantuml/ComponentDiagramGenerator.js'
 import { beforeEach, describe, expect, test } from 'vitest'
 import {
   Aggregate,
@@ -14,7 +14,7 @@ import {
   SharedKernel,
   UpstreamDownstreamRelationship,
   UpstreamRole
-} from '../../src/language/generated/ast.js'
+} from '../../../src/language/generated/ast.js'
 import { Reference } from 'langium'
 
 let generator: ComponentDiagramGenerator
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -6,6 +6,7 @@ import { defineConfig } from 'vitest/config'
 
 export default defineConfig({
   test: {
+    globals: true,
     coverage: {
       provider: 'v8',
       reporter: ['lcov'],
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,22 +1,22 @@`
`1`	`1`	`@startuml`
`2`	`2`	`abstract class ValidationRegistry {`
`3`		`-+ register(ValidationChecks<T>, ThisParameterType)`
	`3`	`++ register(checks: ValidationChecks<T>, validator: ThisParameterType)`
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`class ContextMapperDslValidationRegistry {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`class ContextMapperDslValidator {`
`10`		`-+ validate(AstNode, ValidationAcceptor)`
	`10`	`++ validate(node: AstNode, acceptor: ValidationAcceptor)`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`class ContextMapperValidationProviderRegistry {`
`14`	`14`	`- _providers: Map<string, ContextMapperValidationProvider<AstNode>>`
`15`		`-+ get(AstNode): ContextMapperValidationProvider<AstNode>`
	`15`	`++ get(node: AstNode): ContextMapperValidationProvider<AstNode> \| undefined`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`interface ContextMapperValidationProvider {`
`19`		`-+ validate(T, ValidationAcceptor)`
	`19`	`++ validate(node: T, acceptor: ValidationAcceptor)`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`ValidationRegistry <\|-- ContextMapperDslValidationRegistry`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ContextMappingModel } from '../generated/ast.js'`
	`1`	`+import { ContextMappingModel } from '../../generated/ast.js'`
`2`	`2`	`import { CancellationToken } from 'vscode-languageserver'`
`3`	`3`
`4`	`4`	`export interface ContextMapperGenerator {`