PY-33235 Add highlighting annotator for nested functions
[idea/community.git] / README.md
1 # IntelliJ IDEA Community Edition [![official JetBrains project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
2 These instructions will help you build IntelliJ IDEA Community Edition from source code, which is the basis for IntelliJ Platform development.
3 The following conventions will be used to refer to directories on your machine:
4 * `<USER_HOME>` is your home directory.
5 * `<IDEA_HOME>` is the root directory for the IntelliJ source code.
6 * `<JDK_18_HOME>` is the root directory for the 1.8 JDK.
7
8 ## Getting IntelliJ IDEA Community Edition Source Code
9 IntelliJ IDEA Community Edition source code is available from `github.com/JetBrains/intellij-community` by either cloning or
10 downloading a zip file (based on a branch) into `<IDEA_HOME>`. The default is the *master* branch. 
11
12 The master branch contains the source code which will be used to create the next major version of IntelliJ IDEA. The branch names
13 and build numbers for older releases of IntelliJ IDEA can be found on the page of
14 [Build Number Ranges](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html).
15
16 If you intend to make open-source contributions to the IntelliJ Platform,
17 see [Contributing to the IntelliJ Project](http://www.jetbrains.org/display/IJOS/Contribute) for more information.
18
19 _**Speed Tip:**_ If the complete repository history isn't needed then using a shallow clone (`git clone --depth 1`) will save significant time.
20
21 These Git operations can also be done through the [IntelliJ IDEA user interface](https://www.jetbrains.com/help/idea/using-git-integration.html).
22
23 IntelliJ IDEA Community Edition requires additional Android modules from separate Git repositories. To clone these repositories,
24 run one of the `getPlugins` scripts located in the `<IDEA_HOME>` directory. These scripts clone their respective *master* branches.
25 * `getPlugins.sh` for Linux or macOS.
26 * `getPlugins.bat` for Windows.
27
28 _**Note:**_ Always `git checkout` the `intellij-community` and `android` Git repositories to the same branches/tags. 
29
30 ## Building IntelliJ Community Edition
31 Version 2020.1 or newer of IntelliJ IDEA Community Edition or IntelliJ IDEA Ultimate Edition is required to build and develop
32 for the IntelliJ Platform.
33
34 ### Opening the IntelliJ Source Code for Build
35 Using IntelliJ IDEA **File | Open**, select the `<IDEA_HOME>` directory. 
36 * If IntelliJ IDEA displays an error about a missing or out of date required plugin (e.g. Kotlin),
37   [enable, upgrade, or install that plugin](https://www.jetbrains.com/help/idea/managing-plugins.html) and restart IntelliJ IDEA.
38 * If IntelliJ IDEA displays an error about a Gradle configuration not found,
39   [refresh the Gradle projects](https://www.jetbrains.com/help/idea/jetgradle-tool-window.html). 
40
41 ### IntelliJ Build Configuration
42 JDK version 1.8 and JDK version 11 are required for building and developing for IntelliJ IDEA Community Edition.
43 1. Using IntelliJ IDEA, [configure](https://www.jetbrains.com/help/idea/sdk.html) a JDK named "**1.8**", pointing to `<JDK_18_HOME>`. The JDK
44    should be of version 1.8.0_162 or newer; also it must include jfxrt.jar. You may use for example Oracle JDK or Amazon Corretto (the latter 
45    can be downloaded directly from Project Structure dialog).
46    * If not already present, add `<JDK_18_HOME>/lib/tools.jar` [to the Classpath](https://www.jetbrains.com/help/idea/sdk.html#manage_sdks) tab
47      for the **1.8** JDK.
48 2. Configure a JDK named "**corretto-11**", pointing to installation of JDK 11. It's recommended to use Amazon Corretto JDK. You may 
49    [download it directly](https://www.jetbrains.com/help/idea/sdk.html#jdk-from-ide) from Project Structure dialog.    
50 3. Also configure a JDK named "**IDEA jdk**" (case sensitive), pointing to installation of JDK 1.6. If you don’t want to install JDK 1.6
51    then you may configure **IDEA jdk** to point to `<JDK_18_HOME>`. However, you must be careful to avoid using Java 8 APIs in IntelliJ IDEA Community Edition modules that use **IDEA jdk**. 
52    * If not already present, add the corresponding path for tools.jar to the Classpath for "**IDEA jdk**" JDK.
53 4. If the _Maven Integration_ plugin is disabled, [add the path variable](https://www.jetbrains.com/help/idea/absolute-path-variables.html)
54    "**MAVEN_REPOSITORY**" pointing to `<USER_HOME>/.m2/repository` directory.
55 5. _**Speed Tip:**_ If you have enough RAM on your computer,
56    [configure the compiler settings](https://www.jetbrains.com/help/idea/specifying-compilation-settings.html)
57    to enable the "Compile independent modules in parallel" option. Also, set the "User-local build process VM options" to `-Xmx2G`.
58    These changes will greatly reduce the compile time.
59
60 ### Building the IntelliJ Application Source Code
61 To build IntelliJ IDEA Community Edition from source, choose **Build | Build Project** from the main menu.
62
63 To build installation packages, run the `ant` command in `<IDEA_HOME>` directory. See the `build.xml` file for details.
64
65 ## Running IntelliJ IDEA
66 To run the IntelliJ IDEA built from source, choose **Run | Run** from the main menu. This will use the preconfigured run configuration "**IDEA**".
67
68 To run tests on the build, apply these setting to the **Run | Edit Configurations... | Templates | JUnit** configuration tab:
69   * Working dir: `<IDEA_HOME>/bin`
70   * VM options: 
71     * `-ea` 
72     * `-Djava.system.class.loader=com.intellij.util.lang.UrlClassLoader` 
73     * `-Didea.config.path=../test-config`
74     * `-Didea.system.path=../test-system`
75  
76 You can find other helpful information at [https://www.jetbrains.com/opensource/idea](https://www.jetbrains.com/opensource/idea).
77 The "Contribute Code" section of that site describes how you can contribute to IntelliJ IDEA.