dprint

This plugin adds support for dprint, a flexible and extensible code formatter (dprint.dev). Please report bugs and feature requests to our github.

N.B. Currently only UTF-8 file formats are supported correctly.

To use this plugin:

• Install and configure dprint for your repository, dprint.dev/setup
• Configure this plugin at Preferences -> Tools -> dprint.
  • Ensure Enable dprint is checked
  • To run dprint on save check Run dprint on save.
  • To enable overriding the default IntelliJ formatter check Default formatter override. If a file can be formatted via dprint, the default IntelliJ formatter will be overridden and dprint will be run in its place when using Option+Shift+Cmd+L on macOS or Alt+Shift+Ctrl+L on Windows and Linux.
  • To enable verbose logging from the underlying dprint daemon process check Verbose daemon logging
  • If your dprint.json config file isn't at the base of your project, provide the absolute path to your config in the Config file path field, otherwise it will be detected automatically.
  • If dprint isn't on your path or in node_modules, provide the absolute path to the dprint executable in the Executable path field, otherwise it will be detected automatically.
• Use the "Reformat with dprint" action by using the "Find Action" popup (Cmd/Ctrl+Shift+A).
• Output from the plugin will be displayed in the dprint tool window. This includes config errors and any syntax errors that may be stopping your file from being formatted.

This plugin uses a long-running process known as the editor-service. If you change your dprint.json file outside of IntelliJ or dprint is not formatting as expected, run the Restart dprint action. If you need to reset all settings to defaults, use the Reset to Defaults button in Preferences -> Tools -> dprint. This will reset all configuration values and restart the editor service.

The plugin supports both dprint schema v4 and v5 and will automatically detect the appropriate version based on your dprint installation.

Please report any issues with this Intellij plugin to the github repository.

Installation

• Manually:

  Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

---

Development

This project is currently built using JDK 21 and targets IntelliJ 2024.3+. To install on a mac with homebrew run brew install openjdk@21 and set that as your project SDK.

Dprint setup

To test this plugin, you will require dprint installed. To install on a mac with homebrew run brew install dprint. When running the plugin via the Run Plugin configuration, add a default dprint config file by running dprint init.

Intellij Setup

• Set up linting settings, run Gradle > Tasks > help > ktlintGenerateBaseline. This sets up IntelliJ with appropriate formatting settings.

Running

There are 3 default run configs set up

• Run Plugin - This starts up an instance of Intellij Ultimate with the plugin installed and enabled.
• Run Tests - This runs linting and tests.
• Run Verifications - This verifies the plugin is publishable.

Depending on the version of IntelliJ you are running for development, you will need to change the platformType property in gradle.properties. It is IU for IntelliJ Ultimate and IC for IntelliJ Community.

Plugin Architecture

The plugin uses a simplified architecture centered around:

• DprintService: Central service managing formatting operations and state
• DprintTaskExecutor: Handles background task execution using Kotlin coroutines
• EditorService: Communicates with the dprint CLI daemon (supports v4 and v5 schemas)
• DprintExternalFormatter: Integrates with IntelliJ's formatting system
• Configuration: Project and user-level settings with reset functionality