Context Mapper IntelliJ Plugin

ContextMapper is an open source tool providing a Domain-specific Language based on Domain-Driven Design (DDD) patterns for context mapping and service decomposition.

System Requirements

To use the ContextMapper IntelliJ plugin you need the following tools (besides IntelliJ and our extension) installed locally:

• Oracle Java or OpenJDK (JRE 11 or newer)
• Node.js (v22)
• If you want to use our Context Map generator you need to have Graphviz installed on your system.
  • Ensure that the binaries are part of the PATH environment variable and can be called from the terminal.
  • Especially on Windows this is not the case after the installation of Graphviz. The default installation path is C:\Program Files (x86)\GraphvizX.XX, which means you have to add C:\Program Files (x86)\GraphvizX.XX\bin to your PATH variable.
• Maybe you want to install the PlantUML extension for the generated PlantUML diagrams.
• LSP4IJ IntelliJ plugin (will be installed automatically when installing our plugin)

Build and/or Run Extension Locally

This project uses Gradle to build the IntelliJ plugin.

Requirements

To be able to work on the plugin in IntelliJ, you need to have the Plugin DevKit plugin installed.

The language server package is downloaded from the GitHub NPM registry, which requires you to provide an authentication token. You can get a token by creating a personal access token in your GitHub account. Make sure that the token includes the package:read permission.

To configure the registry and authentication, add this configuration to the .npmrc file in your home directory.

@lstreckeisen:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=<TOKEN>

Commands

After cloning this repository, you can build the project with the following command:

./gradlew clean buildPlugin

Use the following command to build and run the plugin:

./gradlew runIde