Support XDG directories for config and history files #1055
Conversation
This commit implements XDG directory support for this gem's history file in accordance with the rules outlined in ruby#1031: > For the history file: > > 1. prefer `~/.rdbg_history` if present, > 2. else, `$XDG_DATA_HOME/rdbg/history` if `$XDG_DATA_HOME` is set¹ > > ¹ There'd need to be a check for this file path. If it exists, great! > If not, create the path `$XDG_DATA_HOME/rdbg` and touch > `$XDG_DATA_HOME/rdbg/history`. See: ruby#1031 (comment)
This commit implements XDG directory support for this gem's `.rdbgrc` configuration file in accordance with the rules outlined in ruby#1031: > 1. prefer `~/.rdbgrc` if present, > 2. else, `$XDG_CONFIG_HOME/rdbg/config` if `$XDG_CONFIG_HOME` is set > and `$XDG_CONFIG_HOME/rdbg/config` is present, > 3. else, no customized user configuration See: ruby#1031 (comment)
| ] | ||
|
|
||
| if (xdg_home = ENV["XDG_CONFIG_HOME"]) | ||
| rc_file_paths << [File.expand_path(File.join(xdg_home, "rdbg", "config")), true] |
There was a problem hiding this comment.
don't you need config.rb here?
There was a problem hiding this comment.
Good catch. This change should support both ${XDG_CONFIG_HOME}/rdbg/config and ${XDG_CONFIG_HOME}/rdbg/config.rb. I'll make that update.
Launchable Report❌ Test session #2769253 failed ❌ Test session #2769258 failed ❌ Test session #2769260 failed Passed test sessions✅ Test session #2769168 passed Build: refs_pull_1055_merge_55f66240abf152a91a42df8aa4d05e2a25387bdd |
|
Hello! I don't have the ability to re-run the failed checks and it's not immediately clear to me why those failed (and why Ruby 3.2 and 3.3 passed). For someone more knowledgeable, do those failures look to be caused by changes in this pull request? Should I update this branch with a merge commit and have someone re-run the test suite? |
Description
Addresses #1031 by implementing support for XDG directories in accordance with the rules discussed in the issue and summarized in my comment here.
This change should be non-breaking in that the code continues to prefer existing default configuration files at
~/.rdbgrcand~/.rdbg_history.If those files do not exist and XDG environment variables are configured, then configuration and history files in the relevant XDG directories are used.
$XDG_CONFIG_HOME/rdbg/config(if file is present)$XDG_DATA_HOME/rdbg/historyNote that
$XDG_CONFIG_HOMEis typically$HOME/.configand that$XDG_DATA_HOMEis typically$HOME/.local/share. These are customizable by users, but I believe those are the customary/default paths.