How can i add custom expression functions for Live templates in Intellij

Question

How can add new custom functions for Live Templates in Idea Intellij.

For example i need a custom function which can convert a live template variable from Camel Case to Spaced. i.e in Live Template on variable has to be inserted at multiple places with & without space.

Eg. "MyVar" and "My Var". So i want to insert an expression to convert 'MyVar' to 'My Var'.

No expression available by default can be used for this.

Thanks.

score 17 · Accepted Answer · answered Aug 28 '12 at 10:49

17

There is OpenAPI for providing Live Template functions. One can create IntelliJ IDEA plug-in that will add more functions.

See the Macro abstract class. Plug-in should define extension point, like this one:

<liveTemplateMacro implementation="com.intellij.codeInsight.template.macro.CapitalizeMacro"/>

Search IntelliJ IDEA Community code base for sample implementations.

answered Aug 28 '12 at 10:49

CrazyCoder

389,263
172
990
904

Thanks a lot i was able to make it work by extending MacroBase i.e. Parent of Capitalize Macro. – Aman Sep 11 '12 at 19:52
5

so if I create one of these. how do i add it to phpstorm? – Artistan Jun 12 '17 at 15:58
@Artistan look new answer – mqliutie Mar 07 '23 at 10:32

score 0 · Answer 2 · answered Mar 07 '23 at 10:31

Thanks @CrazyCoder answer , I will show my code how I added the custom expression to live templates.

Creating a Plugin Gradle Project https://plugins.jetbrains.com/docs/intellij/creating-plugin-project.html

If you have error like Could not resolve all files for configuration ':classpath'.

you should open Preferences -> Build,Execution,Deployment -> Build Tools -> Gradle select Gradle JVM to you have installed version

Create your own class like this:

package com.xxxx.yourPackage;

import com.intellij.codeInsight.template.*;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class MyLiveTemplateExpression extends Macro {


    @Override
    public @NonNls String getName() {
        return "MyLiveTemplateExpression";
    }

    @Override
    public @Nullable Result calculateResult(Expression @NotNull [] params, ExpressionContext context) {
        return new TextResult("测试自己的宏");
    }
}

In this code the method getName will return a string name which will be shown in live-templates

edit plugin.xml add liveTemplateMacro tag into extensions tag, like this:

<liveTemplateMacro implementation="com.xxxx.yourPackage.yourClass"/>

In my case implementation value is com.xxxx.cusomLiveTemplate.MyLiveTemplateExpression

Select right sidebar Gradle to build jar
open Perference -> plugins click setting icon and choose install from disk to install plugin
you can use this expression now

Because I am a frontend developer, I do not how to write java code... so the code is not strong, I really hope some javaer can edit this answer or tell me how to write more better!

Sorry for my poor English, Hope someone can edit it and make it more easy to understand

How can i add custom expression functions for Live templates in Intellij

2 Answers2

Linked