Skip to content

Use XDG_CONFIG_HOME if available #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MrDowntempo wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Use XDG_CONFIG_HOME if available #369

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
44166c5
Use XDG_CONFIG_HOME if available
MrDowntempo May 5, 2025
e29aa7b
discard file extension when creating directory
MrDowntempo May 7, 2025
386a30c
handle cases with multiple extensions
MrDowntempo May 7, 2025
79b4b8c
Update nb docs to mention new defaults
MrDowntempo Jun 13, 2025
9686f24
Make nbrc in XDG_CONFIG_HOME not a dotfile by default
MrDowntempo Jun 13, 2025
e22285b
Update nb
MrDowntempo Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions nb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,10 +438,30 @@ _option_value_is_present() {

# $NBRC_PATH
#
# Default: `$HOME/.nbrc`
#
# The location of the .nbrc configuration file.
export NBRC_PATH="${NBRC_PATH:-"${HOME}/.${_ME}rc"}"
# Default: `$HOME/.nbrc`, or `$XDG_CONFIG_HOME/nb/config` if `XDG_CONFIG_HOME`
# is defined and `$HOME/.nbrc` does not already exist

# This is the old way of determining the global nbrc path, to preserve
# backwards compatibility. I propose deprecating it.
_deprec_default_nbrc="${HOME}/.${_ME}rc"

# This is the new, XDG-compliant default location
_xdg_default_nbrc="${XDG_CONFIG_HOME:-${HOME}/.config}/${_ME%%.*}/${_ME}rc"

# Choose a default path to use
if [[ -e "${_deprec_default_nbrc}" ]]; then
# If the old default nbrc file exists, use it
_nbrc_path="${_deprec_default_nbrc}"
# TODO: Potentially output a warning here that this location is deprecated.
else
# Otherwise, use the new, XDG-compliant default path
_nbrc_path="${_xdg_default_nbrc}"
fi

# In either case, defer to a potential external definition of NBRC_PATH
export NBRC_PATH="${NBRC_PATH:-${_nbrc_path}}"
# TODO: Create the path to the nbrc file if it does not exist yet. Perhaps do
# this in the _init_create_rc_file function.

# Handle symlinked NBRC_PATH.
if [[ -L "${NBRC_PATH}" ]]
Expand Down