Doma Tools for IntelliJ

"Doma Tools" is a plugin that supports the development of Doma based projects in IntelliJ.

It checks associations between DAO and SQL and offers coding support features for Doma syntax, such as generating SQL template files, navigating between files, and inspecting the validity of bind variables.

Features

Actions

The plugin adds several actions and gutter icons. Shortcut keys can be used for these actions.

• Jump to SQL
  • Jump from DAO to SQL.
  • You can also jump to the SQL file using the gutter icon displayed alongside.
• Generate SQL
  • Generate an SQL file.
• Jump to DAO
  • Jump from SQL to DAO.
  • You can also jump to the DAO method using the gutter icon displayed alongside.

Inspection

Checks that bind variables are used appropriately for DAO and SQL associations. The plugin also provides quick fixes for DAO methods where the required SQL files do not exist.

• Quick fix to generate SQL template file.
• Checks for unused DAO method arguments.
• Checks for undefined bind variable names.
• Checks the class name and package name for static property calls.
• Optional types are recognized as their element type (e.g., a parameter of type Optional<String> is treated as type String).
• For custom functions, checks for methods that are not defined in the configured ExpressionFunctions implementation class.

Completion

Code completion is available to assist you in coding within directives.

• Suggests DAO method arguments in bind variable directives.
• Analyzes DAO method argument types and suggests instance fields and methods.
• Suggests package and class names for class names used in static property calls.
• Suggests members defined as static in static fields and method calls.
• Directives such as Condition, Loop, and Population are suggested after %.
• Suggests built-in and custom functions after @.
• Optional types are recognized as their element type (e.g., a parameter of type Optional<String> is treated as type String).

Refactoring

Along with DAO changes, the plugin will refactor the SQL file directory and file name.

• After refactoring the DAO name, the SQL directory name will also be updated.
• After refactoring the DAO method name, the SQL file name will also be updated.
• After refactoring the DAO package, the SQL directory will also be updated.

Formatter (Preview)

Provides code formatting for SQL syntax. This feature is in preview. You cannot customize the indentation or keywords to be broken down!

Automatic indentation on newlines provided by the SQL formatting feature is disabled by default.

To enable auto-indentation, toggle the corresponding flag in the settings screen below.

Settings > Other Settings > Doma Tools > Enable auto-indent for SQL

Reference Contributor

Ctrl+Click on a bind variable in an SQL file to jump to its source symbol.

This feature works in source JARs as well, but in binary JARs, if the DAO method’s argument parameter names have been changed, the references cannot be resolved and the feature will not function.

• The DAO method’s argument parameter definition.
• The field and method definitions on that parameter’s type.
• The class definition referenced by @ClassName@.
• Custom functions in the configured ExpressionFunctions implementation class.
• You can also jump using the Go To > Declaration Usage menu.

Settings

Some functions of "Doma Tools" can be customized from the settings screen.

• Enable/disable inspections and customize error levels.
• Highlight color settings for SQL elements.
• Customize action shortcut keys.
• Enable/disable automatic indentation when breaking SQL lines.

If you want to use custom functions defined in your own ExpressionFunctions implementation class, place a doma.compile.config file directly under the resources directory and specify the doma.expr.functions entry.

Doma Setting Options with Configuration File

Example: doma.compile.config

doma.expr.functions=example.expression.MyExpressionFunctions

The contents of doma.compile.config are cached. The cache is updated based on the file's last modified timestamp, so please make sure to save the file after making any changes. Autosave may not update the cache.