[Feature] missing IntelliJ config files in worktree

[bboschrek]

Hello, I have suggesiton on nice feature which could increase usability and seamles working with plugin.
Should be a great have option for copy ignored .idea folder for keeping the settings of IDE across work-trees.

Thank you for considering.

[zielu]

Hi, nice idea. I'll look into it.

[bboschrek]

thank you it will make development flow simpler... Also, I found the next challenge when I opened more work trees - it was hard to recognize that I was in the correct window at first sight. I started working in an incorrect instance. If it is possible, it would be nice to have some postfix of work tree after project name in the window name

[zielu]

https://intellij-support.jetbrains.com/hc/en-us/community/posts/21646547266066-Coping-project-configuration

[ubuntudroid]

I'm using this post-checkout hook:

GIT_ROOT=$(git rev-parse --show-toplevel)
GIT_COMMON_DIR=$(git rev-parse --git-common-dir)

if [ "$GIT_COMMON_DIR" != ".git" ] && [ -d "$GIT_COMMON_DIR/../main" ]; then
  # likely in a worktree enabled setup
  echo "Copying .idea config from main worktree"
  cp -r "$GIT_COMMON_DIR/../main/.idea" "$GIT_ROOT/.idea"
fi

It needs an existing main worktree at the root of the bare repository though. Feel free to adapt.

[ubuntudroid]

Also, I found the next challenge when I opened more work trees - it was hard to recognize that I was in the correct window at first sight.

Enable breadcrumbs in IDE settings: Editor -> General -> Breadcrumbs

This will then show the root folder of your worktree at the top or bottom left of the window.

[Javaru]

I used @ubuntudroid's suggestion of a post-checkout hook. One caveat, and something that will need to be kept in mind when implementing this feature, is that if you copy over the .idea/workspace.xml file, you should delete the entry <component name="ProjectId" id="28KwMcsehO7OiG2uIY5OD9JhwwZ" /> (where the id varies) from the workspace.xml file before opening the project. If you keep the same Project ID in the worktree project(s), you may get strange behavior. For example when you open the primary project, it might have a file opened in the editor that exists in the worktree's path. You may also have indexing issues where things in the classpath show as not available in the editor. This is because there is some information stored at a system level by IntelliJ IDEA based on the project ID. So if two projects share an ID, they basically interfere with each other in maintaining state, and strange things (may) happen as a result.

I added the following, after the copy, to my post-checkout hook script to resolve this since I wanted the workspace file:

  # Delete the <component name="ProjectId" id="28KwMcsehO7OiG2uIY5OD9JhwwZ" /> entry from workspace.xml file.
  # Failure to do so may cause issues with IntelliJ IDEA "seeing" the two projects as the same.
  workspaces_file="$GIT_ROOT/.idea/workspace.xml"
  if [ -f "$workspaces_file" ]; then
    sed -i.bak '/<component name="ProjectId"[^>]*\/>/d' "$workspaces_file"
    rm -f "$workspaces_file.bak"
  fi

IntelliJ IDEA will then create a new Project ID and recreate the entry. (Although ti may not show in the file until you close the project.)