GitLens creates a `.gk` folder in the home dir.

[lgarron]

Description

1. Use the extension like normal?

GitLens Version

v15.6.0

VS Code Version

Version: 1.94.0
Commit: d78a74bcdfad14d5d3b1b782f87255d802b57511
Date: 2024-10-02T13:08:12.626Z (6 days ago)
Electron: 30.5.1
ElectronBuildId: 10262041
Chromium: 124.0.6367.243
Node.js: 20.16.0
V8: 12.4.254.20-electron.0
OS: Darwin arm64 24.0.0

Git Version

git version 2.45.0

Logs, Screenshots, Screen Captures, etc

A .gk folder has started appearing in my home directory, containing a repoMapping.json file. This seems to be due to:

vscode-gitlens/src/env/node/pathMapping/sharedGKDataFolder.ts

Line 60 in b99d045

return Uri.file(path.join(os.homedir(), sharedGKDataFolder, 'repoMapping.json'));

Creating a folder directly in the home dir is not a great practice. The appropriate thing would be to use the XDG conventions, possibly supplemented by platform-specific conventions.

VS Code may provide an API for this to extensions, else there are a bunch of libraries for this: https://www.npmjs.com/search?q=xdg

Alternatively, creating repoMapping.json inside e.g. ~/.data/gitlens would be much, much better than the current behaviour.

[eamodio]

This is by-design as that folder and its configuration is shared between our (GitKraken) tools (GitLens, GitKraken Desktop, and GitKraken CLI)

[EXHades]

“This is by-design”，thank you for openSource work

now just run code --uninstall-extension 'eamodio.gitlens' fix issue

[lgarron]

This is by-design as that folder and its configuration is shared between our (GitKraken) tools (GitLens, GitKraken Desktop, and GitKraken CLI)

Does this mean you are not open to any changes to moving the default location for that folder? 😕

[eamodio]

Correct, our tools use that as a well-known location. It is also quite a common location for many tools.

[lgarron]

Correct, our tools use that as a well-known location. It is also quite a common location for many tools.

This is disappointing to hear, but is there anything that would change your mind? I would be happy to send a PR that uses an updated location when the old location is not present.

Many projects already use XDG-compatible conventions, and many have transitioned after listening to their community. Some of us see openness to this kind of improvement as a litmus for how a project is willing to listen to feedback.

[eamodio]

Can you point me to other tools (vs code in particular) that do this? What would it look like?

But as I said this isn't just a change that GitLens can make because our other tools rely on these same files.

[lgarron]

Unfortunately I don't have a large list of tools that follow the XDG conventions, as by definition I will not notice folders from them.

However, https://wiki.archlinux.org/title/XDG_Base_Directory lists a large number of projects that used to have this issue but many of which have either moved their default folder or added a configuration option to change the location.

Here is a selection based on a quick search of my GitHub notification history:

• Change default storage dir to match $XDG_CONFIG_HOME. chromium/trickuri#18 (comment)
• Use xdg config home convention pqrs-org/Karabiner-Elements#114 (comment)
• Support XDG specification ruby/rubygems#3545 (comment)
• Cache dir loader: Prefer $BUN_INSTALL and $XDG_CACHE_HOME to $HOME. oven-sh/bun#1351

[untainsYD]

Correct, our tools use that as a well-known location. It is also quite a common location for many tools.

no it's not quite common, you are violating XDG DESKTOP PATH, you should google "common" folders before writing this nonsense
@eamodio