Create Reusable Live Templates in IntelliJ IDEA to Eliminate Boilerplate

Desired Outcome

Define a Live Template that expands a short abbreviation into a frequently used code block — such as a logger declaration, a JUnit test skeleton, or a try-with-resources pattern — with editable placeholders that you can tab through. The template should only appear in the appropriate language context (e.g., Java class files) and be portable across team members via settings export.

Prerequisites

• IntelliJ IDEA 2023.1 or later (Community or Ultimate). The Live Templates UI has been stable since 2020, but variable expressions like className() behave consistently only in recent releases.
• A project open with at least one Java file so you can verify context filtering.
• Write access to the IDE configuration directory (default location: ~/Library/Application Support/JetBrains/IntelliJIdea2023.x on macOS, %APPDATA%\JetBrains\IntelliJIdea2023.x on Windows, ~/.config/JetBrains/IntelliJIdea2023.x on Linux).

Procedure: Create a Logger Template

1. Open the Live Templates Settings

Press Ctrl+Alt+S (Windows/Linux) or Cmd+, (macOS) to open Settings. Navigate to Editor → Live Templates. You’ll see a tree of template groups on the left (e.g., Java, JUnit, other).

2. Add a New Template to the Java Group

1. Select the Java group (create it via the + → Template Group if missing).
2. Click + → Live Template.
3. Fill in:
   • Abbreviation: log (short, memorable, unique within the Java context).
   • Description: SLF4J logger declaration.
   • Template text: paste the block below.

private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger($CLASS$.class);$END$

3. Define the Context

Click the Define link next to “Applicable in” and check Java → Declaration. This restricts expansion to inside a class body, not inside methods or comments.

4. Configure the Variable

Click Edit variables. For $CLASS$ set:

• Expression: className() — resolves to the current class name automatically.
• Default value: leave empty (the expression supplies it).
• Skip if defined: checked — prevents the cursor from stopping on this variable since it’s auto-filled.

Leave $END$ as the final cursor position after expansion.

5. Save and Test

1. Click OK to close the variable dialog, then Apply in Settings.
2. Open a Java class file, type log at the class level, and press Tab (default expansion key). The template expands to:

   private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(MyClass.class);

   with the cursor after the semicolon ($END$).
3. Verify that typing log inside a method does not trigger the template (context enforcement).

Expected Checks

• Expansion works: Abbreviation + Tab produces the exact code block with correct class name.
• Context respected: No expansion in XML, properties, or inside method bodies.
• Variable behavior: $CLASS$ is replaced automatically; cursor lands at $END$ without extra Tab stops.
• No abbreviation collision: If you already have a log template in another group (e.g., “other”), the Java-group one wins inside Java declarations because context priority is group-order dependent. Reorder groups via drag-and-drop if needed.

Sharing the Template (Portability)

To distribute the template to teammates or reuse on another machine:

1. File → Manage IDE Settings → Export Settings.
2. Check only Live templates (uncheck everything else to avoid overwriting keymaps, inspections, etc.).
3. Save the settings.zip.
4. Recipients import via File → Manage IDE Settings → Import Settings and select the zip.

Alternatively, copy the template XML directly from <config>/templates/user.xml (created after first custom template) into version control and symlink or script its placement. The XML format is stable across 2023.x–2024.x.

Limitations & Gotchas

• Expression scope: className() returns the innermost class name. In nested classes it yields the inner class name, which may not be what you want for a logger. Use className(true) for the outer class (undocumented, may change).
• Duplicate abbreviations: If two templates in the same context share an abbreviation, the first in the list wins silently. Keep abbreviations unique per context.
• No multi-cursor expansion: Live Templates expand at the primary caret only. For repeated patterns across multiple lines, use Structural Search and Replace or a plugin like MultiTemplate.
• Kotlin context: The same template won’t appear in .kt files unless you also check Kotlin → Declaration in the context dialog. Kotlin’s logger idiom often uses LoggerFactory.getLogger() without .class, so consider a separate Kotlin template.

Recovery / Rollback

If a template behaves unexpectedly:

1. Return to Editor → Live Templates, select the template, and click the Revert button (appears after modification) to restore the built-in version if it was a modified default.
2. Delete the custom template via the - button.
3. To reset all Live Templates to factory defaults, delete user.xml in the templates directory and restart the IDE.

Quick Verification Checklist

1. Create test template test → System.out.println("$END$"); in Java context.
2. Type test + Tab in a Java class → cursor inside quotes.
3. Type test + Tab in an XML file → no expansion.
4. Export settings, import into a clean IDE profile → template appears and expands.