WebStorm
 
2023.2
Shortcuts: Windows
Get WebStorm
You are viewing the documentation for an earlier version of WebStorm.
  1. Write and edit source code
  2. Language injections

Language injections

Last modified: 05 September 2023

Language injections let you work with pieces of code in a programming language different from the main language of your file.

WebStorm provides comprehensive language assistance for editing HTML, CSS, XML, JSON, RegExp, and other code fragments inside string and template literals as well as inside tags and attributes in XML-like languages.

Before you start

Make sure the IntelliLang bundled plugin is enabled in the Installed tab of the Settings | Plugins page as described in Install plugins.

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 or template literal, tag, or attribute, in which you want to inject a language and press AltEnter (or use the intention action icon Intention action icon).

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

    https://resources.jetbrains.com/help/img/idea/2023.2/ws_lang_injection_insert.png
    Gif

Open an injection editor

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

  2. Select Edit <language ID> Fragment.

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

    https://resources.jetbrains.com/help/img/idea/2023.2/ws_lang_injection_edit.png
    Gif

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>
https://resources.jetbrains.com/help/img/idea/2023.2/ws_lang_injection_annotate_prefix.png
Gif

Cancel injections

Configure rules for automatic injections

In WebStorm, 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 CtrlAlt0S.

Language injection settings

All pre-defined injection rules are configured for the Built-in scope. In other words, they are global (and therefore available in all WebStorm 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.

Configure background for language injections

For JavaScript, TypeScript, HTML, XML, and Pug injections, you can use custom colors for background.

https://resources.jetbrains.com/help/img/idea/2023.2/ws_injection_background.png
Gif

See also

Reference