Context Mapper IntelliJ Plugin

NOTE: This plugin is a proof of concept. It does not support all Context Mapper features yet.

Context Mapper 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 Context Mapper 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)
• Maybe you want to install a 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.

@contextmapper: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

Contributing

Contribution is always welcome! Here are some ways how you can contribute:

• Create Github issues if you find bugs or just want to give suggestions for improvements.
• This is an open source project: if you want to code, create pull requests from forks of this repository. Please refer to a Github issue if you contribute this way.
• If you want to contribute to our documentation and user guides on our website https://contextmapper.org/, create pull requests from forks of the corresponding page repo https://github.com/ContextMapper/contextmapper.github.io or create issues there.

Licence

ContextMapper is released under the Apache License, Version 2.0.