Custom Language Support Tutorial

In this tutorial we will add support for a .properties language and its usages within Java code.

tip

IntelliJ Platform support for custom languages is discussed in more depth in the Custom Language Support section. Corresponding parts are linked under Reference on top of each page in this tutorial.

All relevant code added or changed on a page is linked in Code.

The accompanying Testing a Custom Language Plugin tutorial covers testing the functionality; corresponding parts are linked under Testing.

tip

The complete and fully working example plugin used in this tutorial is the simple_language_plugin code sample. See 示例代码 on how to build and run it.

This a step-by-step tutorial, and it requires completing each step, in order:

• 1. Prerequisites

• 2. Language and File Type

• 3. Grammar and Parser

• 4. Lexer and Parser Definition

• 5. Syntax Highlighter and Color Settings Page

• 6. PSI Helpers and Utilities

• 7. Annotator

• 8. Line Marker Provider

• 9. Completion Contributor

• 10. Reference Contributor

• 11. Find Usages Provider

• 12. Folding Builder

• 13. Go To Symbol Contributor

• 14. Structure View Factory

• 15. Structure Aware Navigation Bar

• 16. Formatter

• 17. Code Style Settings

• 18. Commenter

• 19. Quick Fix

• 20. Documentation

tip

If a topic you are interested in is not covered in the above sections, let us know via the "Was this page helpful?" feedback form below or other channels.

Please be specific about the topics and reasons for adding them, and leave your email in case we need more details.