AppCode 2019.2 Help

Share project settings

For sharing project settings, .idea project configuration directory should be shared via version control.

If you decide to share AppCode project files with the other developers, follow these guidelines.

Directory based project format (.idea directory) is used by all the AppCode versions by default. Here is what you need to share:

  • All the files under .idea directory in the project root, except the workspace.xml and tasks.xml files, which store user-specific settings.

Be careful about sharing the following:

  • dataSources.ids, datasources.xml (can contain database passwords)

You may consider not to share the following:

  • user dictionaries folder (to avoid conflicts if another developer has the same name).

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. AppCode 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

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 or inspection profiles. 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.

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

Last modified: 10 October 2019