如何让Intellij为自定义编程语言实现代码高亮、折叠及代码提示

前提准备 #

• 安装IntelliJ IDEA（Ultimate版本功能更完整，社区版也可基础开发）
• 创建IntelliJ Platform Plugin项目，配置自定义语言的ID、文件扩展名等基础信息

1. 代码高亮实现 #

代码高亮核心是识别语法Token并映射样式：

1. 实现自定义Lexer：继承LexerAdapter，借助JFlex生成语法规则，识别关键字（如if）、括号、标识符等Token类型：

public class MyLangLexer extends LexerAdapter {
    public MyLangLexer() {
        super(new FlexAdapter(new _MyLangLexer()));
    }
}

注：JFlex规则文件需定义Token类型（如KEYWORD_IF、LBRACE、RBRACE），编译后生成对应Lexer实现

2. 配置语法高亮器：将Token类型映射到文本样式（颜色、加粗等）：

public class MyLangSyntaxHighlighter implements SyntaxHighlighter {
    public static final TextAttributesKey KEYWORD = TextAttributesKey.createTextAttributesKey("MY_LANG_KEYWORD", DefaultLanguageHighlighterColors.KEYWORD);
    public static final TextAttributesKey BRACES = TextAttributesKey.createTextAttributesKey("MY_LANG_BRACES", DefaultLanguageHighlighterColors.BRACES);

    @Override
    public Lexer getHighlightingLexer() {
        return new MyLangLexer();
    }

    @Override
    public TextAttributesKey[] getTokenHighlights(IElementType tokenType) {
        if (tokenType == MyLangTokenTypes.KEYWORD_IF) {
            return new TextAttributesKey[]{KEYWORD};
        } else if (tokenType == MyLangTokenTypes.LBRACE || tokenType == MyLangTokenTypes.RBRACE) {
            return new TextAttributesKey[]{BRACES};
        }
        return EMPTY_KEYS;
    }
}

3. 注册到插件配置：在plugin.xml中添加语言和高亮器声明：

<extensions defaultExtensionNs="com.intellij">
    <language name="MyLang" id="myLang" fileExtensions="ml" />
    <syntaxHighlighter language="myLang" implementationClass="com.example.MyLangSyntaxHighlighter" />
</extensions>

2. 代码块折叠实现 #

通过FoldingBuilderEx识别可折叠的代码块（如大括号包裹区域）：

1. 实现折叠逻辑：

public class MyLangFoldingBuilder extends FoldingBuilderEx {
    @Override
    public FoldingDescriptor[] buildFoldRegions(@NotNull PsiElement root, @NotNull Document document, boolean quick) {
        List<FoldingDescriptor> descriptors = new ArrayList<>();
        // 遍历Psi树，定位大括号块
        root.accept(new PsiRecursiveElementWalkingVisitor() {
            @Override
            public void visitElement(PsiElement element) {
                if (element.getNode().getElementType() == MyLangTokenTypes.LBRACE) {
                    PsiElement closingBrace = findMatchingRBRACE(element);
                    if (closingBrace != null) {
                        descriptors.add(new FoldingDescriptor(element.getNode(),
                                new TextRange(element.getTextRange().getStartOffset(), closingBrace.getTextRange().getEndOffset()),
                                null, "..."));
                    }
                }
                super.visitElement(element);
            }
        });
        return descriptors.toArray(new FoldingDescriptor[0]);
    }

    // 实现括号匹配逻辑，处理嵌套层级
    private PsiElement findMatchingRBRACE(PsiElement lBrace) {
        int depth = 1;
        PsiElement current = lBrace.getNextSibling();
        while (current != null && depth > 0) {
            if (current.getNode().getElementType() == MyLangTokenTypes.LBRACE) depth++;
            else if (current.getNode().getElementType() == MyLangTokenTypes.RBRACE) depth--;
            current = current.getNextSibling();
        }
        return depth == 0 ? current.getPrevSibling() : null;
    }

    @Override
    public String getPlaceholderText(@NotNull FoldingDescriptor descriptor) {
        return "...";
    }

    @Override
    public boolean isCollapsedByDefault(@NotNull FoldingDescriptor descriptor) {
        return false;
    }
}

2. 注册折叠Builder：在plugin.xml中添加：

<extensions defaultExtensionNs="com.intellij">
    <foldingBuilder language="myLang" implementationClass="com.example.MyLangFoldingBuilder" />
</extensions>

3. 下拉式代码提示实现 #

通过CompletionContributor实现动态补全逻辑：

1. 实现补全贡献者：

public class MyLangCompletionContributor extends CompletionContributor {
    public MyLangCompletionContributor() {
        extend(CompletionType.BASIC, PlatformPatterns.psiElement(), new CompletionProvider<>() {
            @Override
            protected void addCompletions(@NotNull CompletionParameters parameters, @NotNull ProcessingContext context, @NotNull CompletionResultSet result) {
                // 添加关键字补全
                result.addElement(LookupElementBuilder.create("if").withBoldness(true));
                result.addElement(LookupElementBuilder.create("else").withBoldness(true));
                // 添加自定义函数补全
                result.addElement(LookupElementBuilder.create("myCustomFunc()").withIcon(AllIcons.Nodes.Function));
                // 可根据当前输入上下文动态过滤补全项
                result.restartCompletionOnAnyPrefixChange();
            }
        });
    }
}

2. 注册补全贡献者：在plugin.xml中添加：

<extensions defaultExtensionNs="com.intellij">
    <completion.contributor language="myLang" implementationClass="com.example.MyLangCompletionContributor" />
</extensions>

关键注意事项 #

• 自定义Token类型需提前通过IElementType定义，确保Lexer、高亮器、折叠逻辑统一引用
• Psi树遍历和括号匹配需处理嵌套场景，避免识别错误
• 代码补全可结合当前Psi上下文（如已定义的变量、函数）动态生成更精准的补全项

内容的提问来源于stack exchange，提问作者Zwerg