Live Templates
IntelliJ’s live templates are a key feature for programming workflows. From saving keystrokes to auto generating code snippets that I otherwise have to look up, there are plenty of use-cases.
The templates are (on my system) stored
under /Users/lars/Library/Application Support/JetBrains/IntelliJIdea2021.1/jba_config/templates in
a file called Lars.xml. Grouping them under my name makes it easier to figure out which ones are
from me and which ones came with the IDE.
The content of that file currently looks like this:
<templateSet group="Lars">
<template name="clink" value="{@link package.class#member label}" description="link from within javadoc" toReformat="false" toShortenFQNames="true">
<context>
<option name="JAVA_COMMENT" value="true" />
</context>
</template>
<template name="logger" value="private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger($class$.class);" description="slf4j logger" toReformat="true" toShortenFQNames="true" useStaticImport="true">
<variable name="class" expression="className()" defaultValue="" alwaysStopAt="true" />
<context>
<option name="JAVA_DECLARATION" value="true" />
</context>
</template>
<template name="readResource" value="java.nio.file.Files.readString( java.nio.file.Paths.get("src/test/resources/toc.xml")); java.io.InputStream is = getClass().getResourceAsStream("/toc.xml"); String fromInputStream = new java.io.BufferedReader( new java.io.InputStreamReader(is, java.nio.charset.StandardCharsets.UTF_8)) .lines() .collect(java.util.stream.Collectors.joining("\n"));" description="read file from test resource folder" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="sleep" value="private static boolean sleep(int ms) { try { Thread.sleep(ms); return true; } catch (InterruptedException e) { return false; } }" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
</context>
</template>
<template name="at" value="org.assertj.core.api.Assertions.assertThat($SELECTION$).isEqualTo("-1");" description="assertJ assertThat" toReformat="true" toShortenFQNames="true" useStaticImport="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="time" value="long $TIME$ = System.nanoTime(); try { $SELECTION$ } finally { $TIME$ = System.nanoTime() - $TIME$; System.out.printf("$TIME$ = %dms%n", ($TIME$/1_000_000)); }" description="Measure execution time" toReformat="true" toShortenFQNames="true">
<variable name="TIME" expression="" defaultValue=""time"" alwaysStopAt="true" />
<context>
<option name="JAVA_CODE" value="true" />
</context>
</template>
<template name="aa" value="org.junit.jupiter.api.Assertions.assertAll( () -> $END$, () -> );" description="assertAll( () -> assertThat..., () -> assertThat...);" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="clock" value="Clock clock = java.time.Clock.fixed(java.time.Instant.parse("2019-01-01T10:15:30.00Z"), java.time.ZoneOffset.UTC);" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="para" value="@org.junit.jupiter.params.ParameterizedTest @org.junit.jupiter.params.provider.ValueSource(strings = {"", " "}) @org.junit.jupiter.params.provider.CsvSource({"test,TEST", "tEst,TEST", "Java,JAVA"}) @org.junit.jupiter.params.provider.CsvFileSource(resources = "/data.csv", numLinesToSkip = 1) @org.junit.jupiter.params.provider.MethodSource("grossSalaryProvider") void isBlank_ShouldReturnTrueForNullOrBlankStrings(String input) { org.assertj.core.api.Assertions.assertThat(input.strip().isEmpty()).isTrue(); } static java.util.stream.Stream<Arguments> grossSalaryProvider() { return Stream.of( org.junit.jupiter.params.provider.Arguments.of(5_000, 1337), org.junit.jupiter.params.provider.Arguments.of(5_000, 1337), org.junit.jupiter.params.provider.Arguments.of(5_000, 1337) ); }" description="JUnit 5 Parameterized Tests" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
</context>
</template>
<template name="restassured" value="// @formatter:off // testImplementation("io.rest-assured:rest-assured:4.3.3") // testImplementation("io.rest-assured:json-path:4.3.3") io.restassured.RestAssured.given(). port(TEST_VERTICLE_PORT). header("Client-Id", "test:1.2.3"). when(). get("/ulmcustomertest"). then(). statusCode(200). body(equalTo("true"). //extract(). //response() ); // @formatter:on" description="" toReformat="false" toShortenFQNames="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="stdout" value="final java.io.PrintStream systemOut = System.out; try (java.io.ByteArrayOutputStream baos = new ByteArrayOutputStream()) { System.setOut(new java.io.PrintStream(baos, true, java.nio.charset.StandardCharsets.UTF_8)); org.approvaltests.Approvals.verify(baos.toString()); } catch (java.io.IOException e) { throw new RuntimeException(e); } finally { System.setOut(systemOut); }" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="reversedIntStream" value="java.util.stream.IntStream.rangeClosed(to, from) .map(i -> to - i + from)" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
<option name="JAVA_EXPRESSION" value="true" />
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="enumlookup" value=" private static final java.util.Map<String, Xxx> lookup = new java.util.HashMap<>(); static { for (Xxx x : Xxx.values()) { lookup.put(x.value, x); } } public static Xxx get(String x) { return lookup.getOrDefault(x, Xxx.ANY); }" description="lookup enum by string" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
</context>
</template>
<template name="ll" value="java.util.List<$END$> list = new java.util.ArrayList<>();" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
<option name="JAVA_EXPRESSION" value="true" />
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="lo" value="java.util.List.of($END$);" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
<option name="JAVA_EXPRESSION" value="true" />
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="disabled" value="@org.junit.jupiter.api.Disabled("make the change easy, then make the easy change")" description="" toReformat="false" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
</context>
</template>
<template name="mockstatic" value="try (var myMock = org.mockito.Mockito.mockStatic(CurrencyConversion.class)) { myMock.when(CurrencyConversion::currencySymbols).thenReturn(List.of("EUR", "USD")); assertThat(CurrencyConversion.currencySymbols()).contains("EUR", "USD"); } // use testImplementation("org.mockito:mockito-inline:3.5.11")" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="await" value="org.awaitility.Awaitility.await().atLeast(1, TimeUnit.SECONDS).atMost(1, java.util.concurrent.TimeUnit.SECONDS).until(future::isComplete);" description="awaitly" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="snippet" value="// begin-snippet: $SnippetName$ $SELECTION$ // end-snippet // use in .md file: snippet: $SnippetName$" description="generate a code snippet" toReformat="true" toShortenFQNames="true">
<variable name="SnippetName" expression=""MySnippetName"" defaultValue="" alwaysStopAt="true" />
<context>
<option name="JAVA_CODE" value="true" />
</context>
</template>
<template name="typeref" value="com.fasterxml.jackson.core.type.TypeReference<List<Repository>> ref = new TypeReference<>() {};" description="jackson typeref" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="given" value="org.mockito.BDDMockito.given(accountService.getLoggedUser()).willReturn(new User());" description="" toReformat="true" toShortenFQNames="true" useStaticImport="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="ae" value="org.junit.jupiter.api.Assertions.assertEquals(ex, ac);" description="assertEquals from JUnit 5" toReformat="true" toShortenFQNames="true" useStaticImport="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="mockMvc" value="@org.springframework.beans.factory.annotation.Autowired org.springframework.test.web.servlet.MockMvc mockMvc; org.springframework.test.web.servlet.MvcResult result = this.mockMvc .perform( org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post("/api/users") .header("Authorization", "") .contentType(org.springframework.http.MediaType.APPLICATION_JSON) .content( "{\"userName\":\"testUserDetails\",\"firstName\":\"xxx\",\"lastName\":\"xxx\",\"password\":\"xxx\"}")) .andDo(org.springframework.test.web.servlet.result.MockMvcResultHandlers.print()) .andExpect(org.springframework.test.web.servlet.result.MockMvcResultMatchers.status().isBadRequest()) .andReturn(); String content = result.getResponse().getContentAsString();" description="" toReformat="true" toShortenFQNames="true" useStaticImport="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="bools" value="Boolean[] booleans = new Boolean[]{true, false};" description="Boolean array" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="aeot" value="org.assertj.core.api.Assertions.assertThatExceptionOfType(IllegalStateException.class) .isThrownBy(() -> callme()) .withMessage("Expected message"); " description="" toReformat="true" toShortenFQNames="true" useStaticImport="true">
<context>
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="ftcr" value="@org.junit.jupiter.api.extension.ExtendWith(com.github.larseckart.tcr.FastTestCommitRevertMainExtension.class)" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
</context>
</template>
<template name="cor" value="public abstract class Handler<T> { private final Handler<T> next; public Handler() { this.next = new Handler<T>() { @Override protected boolean canHandle(T item) { return true; } @Override protected void handle(T item) { } }; } public Handler(Handler<T> next) { this.next = next; } public void process(T item) { if (canHandle(item)) { handle(item); } else { next.process(item); } } protected abstract boolean canHandle(T item); protected abstract void handle(T item); }" description="chain of responsibility" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_DECLARATION" value="true" />
<option name="JAVA_STATEMENT" value="true" />
</context>
</template>
<template name="mockwebserver" value="testImplementation("com.squareup.okhttp3:mockwebserver:4.10.0")" description="" toReformat="false" toShortenFQNames="true">
<context>
<option name="GROOVY_DECLARATION" value="true" />
<option name="GROOVY_STATEMENT" value="true" />
</context>
</template>
<template name="given-surround" value="org.mockito.BDDMockito.given($SELECTION$).willReturn();" description="" toReformat="true" toShortenFQNames="true">
<context>
<option name="JAVA_EXPRESSION" value="true" />
</context>
</template>
</templateSet>