Change bootstrap to use standard stow functions
Removed the `autostow.sh` scipt. Its use was to call stow for every folder in base directory and ignore certain folders. Both those functions can be handled by stow on its own. Stow allows defining per-directory ignore patterns with `.stow-loca-ignore` files, which can be set to `.*` to completely ignore a folder, just as before. And Stow can be called with a glob pattern to automatically call it for every directory in the repository. `.stowrc` additionally makes sure that all operations take place targeting the home directory of the current user, since that is where the dotfiles will (generally) be stored. Of course, this can be overridden with the stow command-line options (see option precedence in stow manual). Finally, the bootstrap stow module adds an alias `dotlink` to the shell, which allows fast (re-)stowing of all directories in the dotfile repository. It uses a hard-coded location for the .dotfiles base directory, so if the dotfiles are cloned anywhere else this has to be customized.
This commit is contained in:
parent
1d28202f17
commit
71f9076846
11
README.md
11
README.md
|
|
@ -20,8 +20,15 @@
|
|||
The dotfiles use `GNU stow` to link themselves in the home directory. You can clone this repository anywhere (though I have mine in `~/.dotfiles` as it seemed most logical for me).
|
||||
|
||||
Once in the repository directory, when you then run `./install.sh` it will install many of the packages I use (though they are probably slightly out-of-date) and link the dotfiles into the home directory.
|
||||
Since it is based on `stow`, it will not overwrite anything already in the home directory.
|
||||
If you do not want to install any packages but only link the dotfiles run `./_bootstrap/autostow.sh -s`, once again from the main repository directory.
|
||||
Since it is based on `stow`, it will not overwrite anything already in the home directory (though you can force it to if you really want, using `stow --override='.*'` -- I do not recommend this).
|
||||
|
||||
If you do not want to install any packages, but only link the dotfiles run `stow -S */` from the main repository directory.
|
||||
|
||||
After all files are linked and you open a new shell session, the `dotlink` alias will allow you to re-link all dotfiles from anywhere on the system.[^1]
|
||||
|
||||
[^1]: This alias only works when the dotfiles are cloned into `~/.dotfiles` mirroring my setup.
|
||||
This is due to a hard-coded cd into this directory.
|
||||
If your dotfiles lie in another directory and you want to use the dotlink alias, simply change the corresponding line in `_bootstrap/.config/sh/alias.d/dotlink.sh`]
|
||||
|
||||
Both automatic installation paths are presumably somewhat brittle. In any case, I would suggest to manually look through the files for things you want instead of copying and activating everything.
|
||||
Dotfiles are too personal to be standardized like that.
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
^/.* # everything
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# relink all stowed files from anywhere
|
||||
# grepping is to remove meaningless stderr lines until this bug is fixed:
|
||||
# https://github.com/aspiers/stow/issues/65
|
||||
#
|
||||
# redirection is a neat way to filter stderr msgs by redirecting stderr
|
||||
# to stdout in a subshell, grepping in it, and redirecting back to stderr:
|
||||
# https://stackoverflow.com/a/15936384
|
||||
#
|
||||
# to customize this to your own needs, change the `push folder` to the
|
||||
# location of your dotfiles (stow) repository
|
||||
alias dotlink="pushd ~/.dotfiles;\
|
||||
stow -R */ 2> >(grep -v 'Absolute/relative mismatch between Stow dir' 1>&2) ;\
|
||||
popd"
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# TODO find a more generic way to express 'ignore any non-folder files'
|
||||
|
||||
^/install_packages.sh
|
||||
^/packages.csv
|
||||
|
|
@ -1,129 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
#
|
||||
# autostow.sh
|
||||
#
|
||||
# Stow automatic symlinking script
|
||||
#
|
||||
# Invokes stow for every folder within this repository, and that's it.
|
||||
|
||||
ignore="${AUTOSTOW_IGNORED_DIRS}"
|
||||
|
||||
main() {
|
||||
case "$1" in
|
||||
-s | --stow)
|
||||
have_stow
|
||||
stow_dirs
|
||||
exit 0
|
||||
;;
|
||||
-d | --delete)
|
||||
have_stow
|
||||
unstow_dirs
|
||||
exit 0
|
||||
;;
|
||||
-n | --dry-run)
|
||||
have_stow
|
||||
dryrun
|
||||
exit 0
|
||||
;;
|
||||
-v | --version)
|
||||
printf "System bootstrap script.\n\n©Marty Oehme\n\nVersion: 0.2.1\n"
|
||||
;;
|
||||
-h | --help | *)
|
||||
usage
|
||||
exit 0
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
}
|
||||
|
||||
stow_dirs() {
|
||||
printf "Creating dotfile symlinks .................................................\n"
|
||||
for d in */; do
|
||||
|
||||
if is_ignored "$d"; then
|
||||
printf "ignoring %s\n" "$d"
|
||||
continue
|
||||
fi
|
||||
|
||||
printf "stowing %s\n" "$d"
|
||||
stow -S -t ~ "$d"
|
||||
done
|
||||
printf "Done creating symlinks ....................................................\n"
|
||||
}
|
||||
|
||||
unstow_dirs() {
|
||||
printf "Removing dotfile symlinks .................................................\n"
|
||||
for d in */; do
|
||||
|
||||
if is_ignored "$d"; then
|
||||
printf "ignoring %s\n" "$d"
|
||||
continue
|
||||
fi
|
||||
|
||||
printf "unstowing %s\n" "$d"
|
||||
stow -D -t ~ "$d"
|
||||
done
|
||||
printf "Done removing symlinks ....................................................\n"
|
||||
}
|
||||
|
||||
dryrun() {
|
||||
printf "Printing processed directories ............................................\n"
|
||||
for d in */; do
|
||||
|
||||
if is_ignored "$d"; then
|
||||
printf "ignoring %s\n" "$d"
|
||||
continue
|
||||
fi
|
||||
|
||||
printf "processing %s\n" "$d"
|
||||
done
|
||||
printf "Done printing directories .................................................\n"
|
||||
}
|
||||
|
||||
is_ignored() {
|
||||
IFS=":"
|
||||
for ign in $ignore; do
|
||||
# it is either passed in through our environment variable
|
||||
if [ "$ign" = "$1" ] || [ "$ign/" = "$1" ]; then
|
||||
return 0
|
||||
fi
|
||||
done
|
||||
# or it starts with a _ which is ignored by default (that's the regex).
|
||||
# (using herestring to avoid cat>grep)
|
||||
if grep -q -e '^_[[:alnum:]]\{1,\}' <<<"$1"; then return 0; fi
|
||||
return 1
|
||||
}
|
||||
|
||||
have_stow() {
|
||||
if ! type stow >/dev/null 2>&1; then
|
||||
printf "GNU stow needs to be installed for this script to function. Please install stow through your package manager.\n"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
usage() {
|
||||
printf "%s\n" \
|
||||
"" \
|
||||
" autostow.sh - Automatically stow your dotfiles." \
|
||||
" Uses GNU stow to set up automatic links to any dotfiles in subdirectories of this directory." \
|
||||
"" \
|
||||
" Usage: stow.sh -dhsn" \
|
||||
"" \
|
||||
" Options:" \
|
||||
"" \
|
||||
" -h | --help Print out this help." \
|
||||
"" \
|
||||
" -s | --stow Install dotfiles, by symlinking any directory found next to stow.sh using GNU stow." \
|
||||
"" \
|
||||
" -d | --delete Remove dotfiles, by unlinking any directory found next to stow.sh using GNU stow." \
|
||||
"" \
|
||||
" -n | --dry-run Do not invoke any operation but print out directories affected, simulating a dry-run." \
|
||||
"" \
|
||||
" Note, by default any directory starting with an underscore _directoryname will be ignored." \
|
||||
" Additional folders to ignore can be set through the environment variable AUTOSTOW_IGNORED_DIRS " \
|
||||
" using a colon-separated string: AUTOSTOW_IGNORED_DIRS=\"directories:to:ignore\" " \
|
||||
"" \
|
||||
""
|
||||
}
|
||||
|
||||
main "$@"
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
#
|
||||
# Will first install yay, then all my used packages (read from bootstrap/packages.csv)
|
||||
#
|
||||
# Will symlink all my dotfiles into their correct places using autostow.sh
|
||||
# Finally, symlinks all dotfiles into their correct locations using stow
|
||||
|
||||
bootstrap_dir="${BOOTSTRAP_DIRECTORY:-./_bootstrap}"
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ install() {
|
|||
unset BOOTSTRAP_PACKAGES
|
||||
|
||||
echo "=================== BEGINNING DOTFILE MANAGEMENT =========================="
|
||||
"$bootstrap_dir"/autostow.sh -s
|
||||
stow -R ./*/
|
||||
|
||||
echo "====================== INSTALLATION FINISHED =============================="
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue