1- < img src = " https://www.yegor256.com/images/books/elegant-objects/cactus.svg " height = " 92px " />
1+ # IntelliJ IDEA Plugin for EO
22
33[ ![ EO principles respected here] ( https://www.elegantobjects.org/badge.svg )] ( https://www.elegantobjects.org )
44[ ![ DevOps By Rultor.com] ( http://www.rultor.com/b/objectionary/eo )] ( http://www.rultor.com/p/objectionary/eo )
55[ ![ We recommend IntelliJ IDEA] ( https://www.elegantobjects.org/intellij-idea.svg )] ( https://www.jetbrains.com/idea/ )
66
7- ![ Lines of code] ( https://img.shields.io/tokei/lines/github/objectionary/eo-intellij-plugin )
87[ ![ Hits-of-Code] ( https://hitsofcode.com/github/objectionary/eo-intellij-plugin )] ( https://hitsofcode.com/view/github/objectionary/eo-intellij-plugin )
9- [ ![ Build ] ( https://img.shields.io/github/workflow/status/objectionary/eo-intellij-plugin/Java%20CI )] ( https://github.com/yasamprom/eo-intellij-plugin/actions/workflows/build.yaml )
8+ [ ![ build ] ( https://img.shields.io/github/workflow/status/objectionary/eo-intellij-plugin/build )] ( https://github.com/yasamprom/eo-intellij-plugin/actions/workflows/build.yaml )
109[ ![ codecov] ( https://codecov.io/gh/objectionary/eo-intellij-plugin/branch/master/graph/badge.svg )] ( https://codecov.io/gh/objectionary/eo-intellij-plugin )
1110[ ![ License] ( https://img.shields.io/badge/license-MIT-green.svg )] ( https://github.com/objectionary/eo/blob/master/LICENSE.txt )
1211
1312This is Intellij plugin for [ EO] ( https://github.com/objectionary/eo ) .
1413
1514Installing is possible from [ IntelliJ IDEA] ( https://www.jetbrains.com/idea/ )
1615and other [ JetBrains] ( https://www.jetbrains.com/ ) family products, such
17- as [ PyCharm] ( https://www.jetbrains.com/ru-ru/pycharm/ ) , [ CLion] ( https://www.jetbrains.com/ru-ru/clion/ ) , and so on. Just type "EO" in plugins search tab and you will find it.
16+ as [ PyCharm] ( https://www.jetbrains.com/ru-ru/pycharm/ ) ,
17+ [ CLion] ( https://www.jetbrains.com/ru-ru/clion/ ) , and so on.
18+ Just type "EO" in plugins search tab and you will find it.
1819
19- You may also install it from [ its page] ( https://plugins.jetbrains.com/plugin/19460-eo )
20+ You may also install it from
21+ [ its page] ( https://plugins.jetbrains.com/plugin/19460-eo )
2022at JetBrains Marketplace.
2123
2224## How to Contribute
2325
24- Fork repository, make changes, send us a [ pull request] ( https://www.yegor256.com/2014/04/15/github-guidelines.html ) .
26+ Fork repository, make changes, send us a
27+ [ pull request] ( https://www.yegor256.com/2014/04/15/github-guidelines.html ) .
2528We will review your changes and apply them to the ` master ` branch shortly,
2629provided they don't violate our quality standards. To avoid frustration,
2730before sending us your pull request please run full gradle build:
2831
2932``` bash
30- $ gradle build
33+ gradle build
3134```
3235For checking code quality we use [ Qulice] ( https://www.qulice.com/index.html )
3336
3437``` bash
35- $ gradle qulice
38+ gradle qulice
3639```
3740
38- You will need [ Gradle] ( https://gradle.org/guides/ ) , [ Maven] ( https://maven.apache.org/ ) and Java 14+ installed.
41+ You will need [ Gradle] ( https://gradle.org/guides/ ) ,
42+ [ Maven] ( https://maven.apache.org/ ) and Java 14+ installed.
3943
4044
4145
4246## Structure
4347
4448Project has two parts: manually written and auto-generated.
4549
46- In ` src/main ` you may find source code. Classes listed there are not auto-generated. They describe EO language and ` .eo ` extension.
50+ In ` src/main ` you may find source code. Classes listed there are not
51+ auto-generated. They describe EO language and ` .eo ` extension.
4752
48- The second part is auto-generated classes. They should be generated from ` .g4 ` file and moved into
49- ` src/java/org/eolang/jetbrains/parser ` . The grammar will be downloaded automatically
53+ The second part is auto-generated classes. They should be generated
54+ from ` .g4 ` file and moved into
55+ ` src/java/org/eolang/jetbrains/parser ` . The grammar will be downloaded
56+ automatically
5057during ` build ` gradle task. Needed class will be generated at the same time.
5158
5259Resources (icons and ` plugin.xml ` ) are located in ` src/resources ` .
5360
54- We use [ Rultor] ( https://github.com/yegor256/rultor ) for publishing (see ` .rultor.yml ` ).
61+ We use [ Rultor] ( https://github.com/yegor256/rultor )
62+ for publishing (see ` .rultor.yml ` ).
5563
5664## How it Works
5765
5866Plugin is implemented in Java and ANTLR4 grammar.
5967
60- [ ANTLR4 adapter] ( https://github.com/antlr/antlr4-intellij-adaptor ) is used for generating ` EOLexer ` and ` EOParser ` classes.
68+ [ ANTLR4 adapter] ( https://github.com/antlr/antlr4-intellij-adaptor )
69+ is used for generating ` EOLexer ` and ` EOParser ` classes.
6170
6271## Compiling EO sources using plugin
6372
6473In order to compile eo sources withing the project it must be maven project.
6574Its ` pom ` file should contain ` eo-maven-plugin ` configuration as follows:
75+
6676``` xml
6777<build >
6878 <plugins >
@@ -80,4 +90,6 @@ Its `pom` file should contain `eo-maven-plugin` configuration as follows:
8090 </plugins >
8191 </build >
8292```
83- Having this set up compilation can be triggered by ` Build -> EO compile ` menu action.
93+
94+ Having this set up compilation can be triggered by
95+ ` Build -> EO compile ` menu action.
0 commit comments