Makes GitLens XDG-compatible #3904
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sergeibbb
reviewed
Dec 23, 2024
eamodio
reviewed
Dec 23, 2024
|
|
||
| // export as a singleton | ||
| // eslint-disable-next-line import-x/no-default-export | ||
| export default new SharedGKDataFolderMapper(); |
nzaytsev
force-pushed
the
debt/3660-gitlens-creates-a-gk-folder-in-the-home-dir
branch
2 times, most recently
from
75caad1 to
3d08906
Compare
| } catch { | ||
| // File does not exist, so we can safely create it | ||
| break; | ||
| // Path does not exist, so we can safely use xdg paths it |
There was a problem hiding this comment.
Suggested change
| // Path does not exist, so we can safely use xdg paths it | |
| // Path does not exist, so we can safely use xdg paths |
| class SharedGKDataFolderMapper { | ||
| private _initPromise: Promise<void> | undefined; | ||
| constructor( | ||
| // do soft migration, use new folders only for new users (without existing folders) |
There was a problem hiding this comment.
We may want to inform users who have a .gk folder, and want to use the new location, like many of the users in the original issue, that they should delete the former. Otherwise GitLens will continue using it.
In fact, they may want to take the contents out of that folder, delete it, and then move it into the new XDG-friendly folder so they don't lose the data.
There was a problem hiding this comment.
Yeah, probably in the help center and on the issue, but I wouldn't say in the app
nzaytsev
force-pushed
the
debt/3660-gitlens-creates-a-gk-folder-in-the-home-dir
branch
2 times, most recently
from
851ddf4 to
4a10a5f
Compare
axosoft-ramint
approved these changes
Jan 10, 2025
nzaytsev
force-pushed
the
debt/3660-gitlens-creates-a-gk-folder-in-the-home-dir
branch
from
4a10a5f to
03d4ccf
Compare
LuckyWindsck
added a commit
to LuckyWindsck/xdg-ninja
that referenced
this pull request
May 31, 2025
References: - .gk - Issue: gitkraken/vscode-gitlens#3660 - PR: gitkraken/vscode-gitlens#3904 - Implementation (v17.1.1): https://github.com/gitkraken/vscode-gitlens/blob/v17.1.1/src/env/node/gk/localSharedGkStorageLocationProvider.ts#L33
b3nj5m1n
pushed a commit
to b3nj5m1n/xdg-ninja
that referenced
this pull request
Jun 7, 2025
* feat(git): add .gitk & .gitignore References: - .gitconfig: https://git-scm.com/docs/git-config#SCOPES - .git-credentials: https://git-scm.com/docs/git-credential-store#FILES - .gitignore: https://git-scm.com/docs/gitignore#_synopsis - .gitk: https://git-scm.com/docs/gitk#_files * feat(gitkraken): add .gk References: - .gk - Issue: gitkraken/vscode-gitlens#3660 - PR: gitkraken/vscode-gitlens#3904 - Implementation (v17.1.1): https://github.com/gitkraken/vscode-gitlens/blob/v17.1.1/src/env/node/gk/localSharedGkStorageLocationProvider.ts#L33 * feat(php): update .php_history References: - .php_history: https://www.php.net/manual/en/migration84.new-features.php#migration84.new-features.readline
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
All new installs files will be placed into platform specific folder
Existing installs data is placed at $HOME.gk directory. It can be changed manually by deleting .gk directory or moving to corresponding directory
https://github.com/sindresorhus/env-paths/tree/main could be used instead, it implements the logic
Checklist
Fixes $XXX -orCloses #XXX -prefix to auto-close the issue that your PR addresses