[java-highlighting] IDEA-311833. Not correct warning about unchecked cast
[idea/community.git] / README.md
1 # IntelliJ IDEA Community Edition [![official JetBrains project](http://jb.gg/badges/official.svg)](https://github.com/JetBrains/.github/blob/main/profile/README.md)
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
7 ## Getting IntelliJ IDEA Community Edition Source Code
8 IntelliJ IDEA Community Edition source code is available from `github.com/JetBrains/intellij-community` by either cloning or
9 downloading a zip file (based on a branch) into `<IDEA_HOME>`. The default is the *master* branch. 
10
11 The master branch contains the source code which will be used to create the next major version of IntelliJ IDEA. The branch names
12 and build numbers for older releases of IntelliJ IDEA can be found on the page of
13 [Build Number Ranges](https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html).
14
15 These Git operations can also be done through the [IntelliJ IDEA user interface](https://www.jetbrains.com/help/idea/using-git-integration.html).
16
17 _**Speed Tip:**_ If the complete repository history isn't needed then using a shallow clone (`git clone --depth 1`) will save significant time.
18
19 _**On Windows:**_ Two git options are required to check out sources on Windows. Since it's a common source of Git issues on Windows anyway, those options could be set globally (execute those commands before cloning any of intellij-community/android repositories):
20
21 * `git config --global core.longpaths true`
22 * `git config --global core.autocrlf input`
23
24 IntelliJ IDEA Community Edition requires additional Android modules from separate Git repositories. To clone these repositories,
25 run one of the `getPlugins` scripts located in the `<IDEA_HOME>` directory. These scripts clone their respective *master* branches. Make sure you are inside the `<IDEA_HOME>` directory when running those scripts, so the modules get cloned inside the `<IDEA_HOME>` directory.
26 * `getPlugins.sh` for Linux or macOS.
27 * `getPlugins.bat` for Windows.
28
29 _**Note:**_ Always `git checkout` the `intellij-community` and `android` Git repositories to the same branches/tags. 
30
31 ## Building IntelliJ Community Edition
32 Version 2022.1 or newer of IntelliJ IDEA Community Edition or IntelliJ IDEA Ultimate Edition is required to build and develop
33 for the IntelliJ Platform.
34
35 ### Opening the IntelliJ Source Code for Build
36 Using IntelliJ IDEA **File | Open**, select the `<IDEA_HOME>` directory. 
37 * If IntelliJ IDEA displays an error about a missing or out of date required plugin (e.g. Kotlin),
38   [enable, upgrade, or install that plugin](https://www.jetbrains.com/help/idea/managing-plugins.html) and restart IntelliJ IDEA.
39
40 ### IntelliJ Build Configuration
41 1. It's recommended to use JetBrains Runtime 17 to compile the project. 
42    When you invoke **Build Project** for the first time, IntelliJ IDEA should suggest downloading it automatically.
43 2. If the _Maven_ plugin is disabled, [add the path variable](https://www.jetbrains.com/help/idea/absolute-path-variables.html)
44    "**MAVEN_REPOSITORY**" pointing to `<USER_HOME>/.m2/repository` directory.
45 3. Make sure you have at least 8GB of RAM on your computer. With the bare minimum of RAM, disable "Compile independent modules in parallel"
46    option in [the compiler settings](https://www.jetbrains.com/help/idea/specifying-compilation-settings.html). With notably more memory
47    available, increase "User-local build process heap size" to 3000 - that will greatly reduce compilation time.
48
49 ### Building the IntelliJ Application Source Code
50 To build IntelliJ IDEA Community Edition from source, choose **Build | Build Project** from the main menu.
51
52 To build installation packages, run the `installers.cmd` command in `<IDEA_HOME>` directory. `installers.cmd` will work on both Windows and Unix systems.
53
54 Options to build installers are passed as system properties to `installers.cmd` command.
55 You may find the list of available properties in [BuildOptions.kt](platform/build-scripts/src/org/jetbrains/intellij/build/BuildOptions.kt)
56
57 Examples (`./` should be added only for Linux/macOS):
58  * Build installers only for current operating system: `./installers.cmd -Dintellij.build.target.os=current`
59  * Build source code _incrementally_ (do not build what was already built before): `./installers.cmd -Dintellij.build.incremental.compilation=true`
60
61 `installers.cmd` is used just to run [OpenSourceCommunityInstallersBuildTarget](build/scripts/OpenSourceCommunityInstallersBuildTarget.kt) from the command line.
62 You may call it directly from IDEA, see run configuration `Build IDEA Community Installers (current OS)` for an example.
63
64 ## Running IntelliJ IDEA
65 To run the IntelliJ IDEA built from source, choose **Run | Run** from the main menu. This will use the preconfigured run configuration "**IDEA**".
66
67 To run tests on the build, apply these setting to the **Run | Edit Configurations... | Templates | JUnit** configuration tab:
68   * Working dir: `<IDEA_HOME>/bin`
69   * VM options: 
70     * `-ea` 
71  
72 You can find other helpful information at [https://www.jetbrains.com/opensource/idea](https://www.jetbrains.com/opensource/idea).
73 The "Contribute Code" section of that site describes how you can contribute to IntelliJ IDEA.
74
75 ## Running IntelliJ IDEA on CI/CD environment
76
77 To run tests outside of IntelliJ IDEA, run the `tests.cmd` command in `<IDEA_HOME>` directory. `tests.cmd` will work on both Windows and Unix systems.
78
79 Options to run tests are passed as system properties to `tests.cmd` command.
80 You may find the list of available properties in [TestingOptions.kt](platform/build-scripts/src/org/jetbrains/intellij/build/TestingOptions.kt)
81
82 Examples (`./` should be added only for Linux/macOS):
83 * Build source code _incrementally_ (do not build what was already built before): `./tests.cmd -Dintellij.build.incremental.compilation=true`
84 * Run a specific test: `./tests.cmd -Dintellij.build.test.patterns=com.intellij.util.ArrayUtilTest`
85
86 `tests.cmd` is used just to run [CommunityRunTestsBuildTarget](build/scripts/CommunityRunTestsBuildTarget.kt) from the command line.
87 You may call it directly from IDEA, see run configuration `tests in community` for an example.