feat: add XDG Base Directory support for config files - #560
Open
EliteCracker wants to merge 1 commit into
Open
EliteCracker wants to merge 1 commit into
EliteCracker wants to merge 1 commit into
Conversation
- Implemented get_hstr_configuration_file_path in hstr_utils to handle XDG resolution. - Updated blacklist and favorites to use XDG_CONFIG_HOME/hstr/ or ~/.config/hstr/. - Added legacy fallback to ~/.hstr_favorites and ~/.hstr_blacklist. - Ensure config directories are created automatically.
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Resolve filename, write-error, relative-path, and documentation issues before approval.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 3
Open (3)
What changed in this PR
Adds XDG Base Directory support for favorites and blacklist files while preserving legacy-file precedence.
Changes:
- Adds centralized XDG path resolution and directory creation.
- Updates favorites and blacklist persistence.
- Adds filesystem support declarations.
| File | Description |
|---|---|
src/include/hstr_utils.h |
Declares XDG configuration support. |
src/hstr_utils.c |
Resolves and creates configuration paths. |
src/hstr_favorites.c |
Uses XDG-aware favorites persistence. |
src/hstr_blacklist.c |
Uses XDG-aware blacklist persistence. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| if(!fwrite(keys[i], sizeof(char), strlen(keys[i]), outputFile)) { | ||
| if(ferror(outputFile)) { | ||
| exit(EXIT_FAILURE); | ||
| if (outputFile) { |
| if(!fwrite(favorites->items[i], sizeof(char), strlen(favorites->items[i]), outputFile)) { | ||
| if(ferror(outputFile)) { | ||
| exit(EXIT_FAILURE); | ||
| if (outputFile) { |
Comment on lines
+234
to
+236
| if (xdg_config_home_env && strlen(xdg_config_home_env) > 0) { | ||
| xdg_path_dir = malloc(strlen(xdg_config_home_env) + 1 + strlen("hstr") + 1); | ||
| sprintf(xdg_path_dir, "%s/hstr", xdg_config_home_env); |
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds support for the XDG Base Directory specification.
Changes
$XDG_CONFIG_HOME/hstr/(usually~/.config/hstr/).~/.hstr_favoritesor~/.hstr_blacklistexist, they are used instead of XDG paths.Testing
Verified in a clean Arch Linux chroot:
~/.config/hstr/when no legacy files existed.XDG_CONFIG_HOMEenvironment variable.Disclaimer
I did use Google Gemini 3 for assistance during this. I noticed this program had an old issue (#461), and I highly prefer a minimal $HOME. Therefore, I used the Arch Wiki to implement Gemini's changes, tested those changes, and here we are.