If you decide to share IDE project files with other developers, follow these guidelines:
Directory based project format (.idea directory)
This format is used by all the recent IDE 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
- All the .iml module files that can be located in different module directories (applies to IntelliJ IDEA)
Be careful about sharing the following:
- Android artifacts that produce a signed build (will contain keystore passwords)
- In IDEA 13 and earlier dataSources.ids, datasources.xml can contain database passwords. IDEA 14 solves this problem.
You may consider not to share the following:
- gradle.xml file, see this discussion
- user dictionaries folder (to avoid conflicts if other developer has the same name)
- XML files under .idea/libraries in case they are generated from Gradle project
Legacy project format (.ipr/.iml/.iws files)
- Share the project .ipr file and all the .iml module files, don't share the .iws file as it stores user specific settings
Comments
What is misc.xml? What sort of config does IDEA stores in it?
and why does it get changed every time i rebase the source base from remote GIT repo.
Could you please point a doc where we can read more about what files needs to be shared across VCS
IDEA changes paths in compiler.xml for sourceOutputDir and sourceTestOutputDir under windows to use backward slash and on Mac to use forward slash. Why?
Jimmy, it looks like a bug. Please report at http://youtrack.jetbrains.com/issues/IDEA .
Done. https://youtrack.jetbrains.com/issue/IDEA-144112
We have a problem with the PHP module in IntelliJ: the php.xml contains the PhpUnit load_method, which differs from developer to developer (especially with different platforms):
<component name="PhpUnit">
<phpunit_settings>
<PhpUnitSettings load_method="PHPUNIT_PHAR" configuration_file_path="$PROJECT_DIR$/src/tests/php/phpunit.dist.xml" custom_loader_path="" phpunit_phar_path="/usr/local/bin/phpunit" use_configuration_file="true" />
</phpunit_settings>
</component>
Is that a known issue?
@Patrick Do you mean that there are different PHPUnit's setup options (through phar or composer) or that there are different paths to PHPUnit?
@Liubov Melnikova Exactly. The load_method differs from device to device (some users have phpunit in their PATH, some have it in an arbitrary location). also the exact path (specified in phpunit_phar_path differs on the differing machines.
We considered excluding the php.xml from our VCS, but the version number specified in the PhpProjectSharedConfiguration component is very important, as we do not have the latest PHP version available in our production environment.
A good source for a .gitignore file can be found here:
https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore
Nevertheless I miss the exclusion of build artifacts:
...
*/build/tmp/
*/build/test-results/
*/build/resources/
*/build/reports/
*/build/libs/
*/build/docs/
...