IntelliJ IDEA 2021.2 Help

Projects

In IntelliJ IDEA, a project helps you to organize your source code, tests, libraries that you use, build instructions, and your personal settings in a single unit.

IntelliJ IDEA project overview

Project formats

In IntelliJ IDEA, there are two types of formats in which a project's configuration can be stored — the file-based format and the directory-based format.

File-based format

The file-based format was the only one available in older versions of IntelliJ IDEA; now it is outdated. Projects in this format contain several files: the .ipr, .iws, and .iml files. Generally, we don't recommend using this format unless you need to open projects in different file managers by clicking the .ipr file, or unless you need to store multiple projects in one directory.

A simple file-based project shown in Finder

Directory-based format

For the directory-based format, the IDE creates the .iml file and the .idea directory that keeps project settings. It's the default format for projects in IntelliJ IDEA at this moment.

This format was introduced after the file-based format. Its main advantage is that it's adjusted to store project files in Version Control Systems: the project data is split over multiple files, and merge conflicts are less likely. For more information on how to share projects in different formats, refer to How to manage projects under Version Control Systems

A simple directory-based project shown in Finder

Change the project format to directory-based

  • From the main menu, select File | Manage IDE Settings | Save as Directory-Based Format.

Change the IML file location for Go projects in IntelliJ IDEA

When you create a Go project in IntelliJ IDEA, you can specify a directory for the .iml file. The default location is the root directory of the project.

Change the IML file location for new Go projects

  1. To create a new Go project, navigate to File | New | Project.

  2. In the New Project wizard dialog, select Go and click Next.

  3. Click More Settings.

  4. In the Module file location field, add /.idea to the existing path.

    Change the IML file location for new Go projects

If you want to change the IML file location for existing Go projects in IntelliJ IDEA, you need to modify the modules.xml file in the .idea directory.

Change the IML file location for existing Go projects

  1. In the Project tool window, navigate to the .idea folder of the project.

  2. Add .idea/ to fileurl and filepath attributes of the IML file location.

  3. Move the IML file to the .idea directory.

    Change the IML file location for existing Go projects

Share project settings through VCS

Project settings are stored in the project directory as a set of XML files under the .idea folder. This folder contains both user-specific settings that shouldn't be placed under version control and project settings that are normally shared among developers working in a team, for example, the code style configuration.

When you place a project under version control, your personal settings are automatically ignored. IntelliJ IDEA moves workspace.xml — the file with your personal settings — to the list of ignored files to avoid conflicts with other developers' settings.

Configuration files are processed according to your choice. Once you modify the project settings, and a new configuration file is created, the IDE shows a notification at the bottom of the screen prompting you to select how you want to treat configuration files in this project:

  • View files: view the list of created configuration files and select, which of them you want to place under version control. After that, the selected files will be scheduled for addition to VCS.

  • Always Add: silently schedule all configuration files created in the .idea directory for addition to VCS (applies only to the current project).

  • Don't Ask Again: never schedule configuration files for addition to VCS; they will have the unversioned status until you manually add them to VCS (applies only to the current project).

If you close the notification without selecting any option, it will appear again after a new configuration file is created. The new file will also go to the list that will be there until you select one of the options even if you restart the IDE.

Notification prompting to select how to treat
                    configuration files

List of non-shareable configuration files

IntelliJ IDEA identifies configuration files and adds them to the list of ignored files automatically. However, if you are sharing your project manually, we recommend that you avoid placing these files and folders under version control:

  • .idea/workspace.xml
  • .idea/usage.statistics.xml
  • .idea/dictionaries folder

  • .idea/shelf folder

  • .idea/libraries if they are generated from Gradle and Maven projects

  • *.iml and .idea/modules.xml files in Maven and Gradle projects

  • gradle.xml
  • *.iws file in file-based projects

  • out folder

For the full list of files, refer to How to manage projects under Version Control Systems and JetBrains.gitignore.

Copy global settings to the project level

Global (IDE) settings are stored separately from projects. That is why, these settings are not shared through version control together with the project.

Some settings, however, can be copied to the project level. For example, you can create a copy of your code style configuration, inspection profiles, the list of classes and packages excluded from code completion and auto-import. If you do so, the IDE creates the corresponding configuration files in the .idea directory that you can share together with the project through VCS.

IntelliJ IDEA also provides several ways of sharing settings between different IDE instances. See Share IDE settings for details.

Last modified: 03 August 2021