cd-bookmark icon indicating copy to clipboard operation
cd-bookmark copied to clipboard

Support XDG Base Directory Specification

Open erikw opened this issue 4 years ago • 0 comments

First of all, thanks for this really great shell enhancer. I use it every day!

Background

Lately the XDG Base Directory Specification has been gaining quite a steady popularity, even though it's been around for a long time already. The basic idea is to standardize where programs put their files e.g. all config files in a certain directory. The benefits for end users are many, including:

  • No polluted $HOME/
  • Can easily grep for only config files in $XDG_CONFIG_HOME
  • Can decide where to store configurations in more complex setups (multi system setup e.g.)
  • Easily wipe state by removing $XDG_STATE_HOME or even $XDG_DATA_HOME, but without destroying and configuration files.

The first point is maybe what most end users enjoy the most though.

How

Specifically for this project, this should mean that the search for the configuration file should be done like:

  1. If $CD_BOOKMARK_FILE is set, use this directly
  2. NEW If $XDG_CONFIG_HOME is set, look for $XDG_CONFIG_HOME/cd-bookmark/bookmarks
  3. NEW elseIf $XDG_CONFIG_HOME is unset, use the default value for the envvar which is $HOME/.config. Thus, the config file to look for is at $HOME/.config/cd-bookmark/bookmarks
  4. else fall-back to current legacy $HOME/.cdbookmark

The first two new steps to can be codifed in bash like: ${XDG_CONFIG_HOME:-$HOME/.config}/cd-bookmark/bookmarks

erikw avatar Oct 28 '21 16:10 erikw