DataGrip 2023.2 Help

Language injections

Language injections let you work with pieces of code in other languages embedded in your code. When you inject a language (such as HTML, CSS, XML, RegExp, and so on) into a string literal, you get comprehensive code assistance for editing that literal.

Temporarily inject a language

By default, the IDE injects a language temporarily. It means that if you delete the embedded element, the injection will be lost as well.

  1. Place the caret inside the string literal, tag, or attribute, in which you want to inject a language and press Alt+Enter (or use the intention action icon Intention action icon).

  2. Select Inject language or reference and choose the language you want to inject.

    Injecting HTML

Open an injection editor

  1. Place the caret within the injected code piece and press Alt+Enter (or use the intention action icon Intention action icon).

  2. Select Edit <language ID> Fragment.

    DataGrip will open a dedicated editor section for editing the code with the injected language. This editor provides full coding assistance, including code completion, inspections, intentions and code style actions.

    Open a code fragment in the dedicated editor section

Use language injection comments

  • Add a blank line before the target string literal, and type the following comment:

    // language=<language_ID>

    For comments, use the syntax of the language you want to inject. Language IDs are generally intuitive, for example, SQL, RegExp, XML, HTML.

    Use language injection comments

A language fragment may be combined with a prefix and a suffix that act together as a wrapper, turning the fragment into a syntactically complete language unit. When editing your code, you can see prefixes and suffixes only in the fragment editor. They are not shown in the main editor.

The prefix and the suffix can be included in the injection comment as follows:

// language=<language_ID> prefix=<prefix> suffix=<suffix>
Using prefixes and suffixes in language injection

Inject XML and JSON automatically

For values that are defined as XML and JSON types, the corresponding languages are injected automatically.

To inject a language automatically, declare a type in the expression (for example, XML or JSON).

Inject XML and JSON automatically

    Inject a language for user-defined data types

    You can create patterns for user-defined data types and associate those patterns with languages. For the data type that matches the pattern, DataGrip injects the specified language automatically.

    1. Declare your custom data type (for example, MY_CUSTOM_DATA_TYPE).

    2. Click the value in the quotation marks and press Alt+Enter.

    3. Select Inject by Type and select the language that you want to inject (for example, XML (XML files)).

    4. In the Type pattern field, type a regular expression for the pattern that you want to use for your custom data type (for example, use the (?i).* regular expression).

    Inject a language for user-defined data types

    Cancel injections

    1. Place the caret at the code fragment and press Alt+Enter (or use the intention action icon the Intention action button).

    2. Select Uninject language or reference.

    To cancel a language injection, you can also delete the injection comment or annotation.

    Configure rules for automatic injections

    In DataGrip, there is a set of predefined rules according to which the IDE automatically injects languages in certain places in your code.

    You can configure language injection rules on the Editor | Language Injections page of the IDE settings Control+Alt+S.

    Language injections settings

    All pre-defined injection rules are configured for the Built-in scope. In other words, they are global (and therefore available in all DataGrip projects). Custom rules can be configured for the IDE or for one project only. To change the scope of custom injections, use the the Move to Project/IDE scope button.

    To share a custom rule through VCS, move it to the Project scope using the corresponding option on the toolbar. By doing so, you will create a new file in the .idea directory named IntelliLang.xml with your custom rules that you can place under version control.

    If you don’t use a VCS, you can share your rules by exporting them to XML files (click Export on the toolbar) and then importing them to another project.

    To configure custom injection rules, click the Add button to add a new rule, or copy a predefined rule and change its settings.

    Last modified: 26 October 2023