Added a new script that can be used to update the repo if bash is
available. Updated the README. Improved the theme by adding a bunch
of syntax highlighting definitions (mostly rooted in html, though
a bunch of other languages base their colours on it), as well as
tweaking visual selection to longer invert on the block with the cursor,
and parenthesis matching to look the same at both ends. Added a plugin
that improves the theme and adds some keyboard shortcuts to markdown,
which is what the README.md files in Github are written in. I realized
that the h,j,k,l shortcuts equivalent to the ones with arrow keys I'd
added were overwriting other shortcuts with the shift combinations, so
I removed those and the ctrl-ones for consistency. The diff shortcuts
weren't intuitive or easy on the hands, so I tried something else and
I think it works much better now (check vim/keyboard.vim). An update
script has also been added to simplify updating submodules; I'm not
completely clear as to whether following this method will properly
update the submodules in certain conditions like when one is removed,
but this should add new ones and update the existing ones after pulling
from the repo.
2014-04-01 00:03:52 -04:00
|
|
|
#!/usr/bin/env bash
|
|
|
|
|
2015-01-21 01:51:48 -05:00
|
|
|
#
|
2024-03-01 16:28:35 -05:00
|
|
|
# Darkcloud Neovim Config Update Tool
|
|
|
|
# https://github.com/prurigro/darkcloud-nvimconfig
|
2015-01-21 01:51:48 -05:00
|
|
|
#
|
|
|
|
# Written by Kevin MacMartin (prurigro@gmail.com)
|
|
|
|
# Released under the MIT license
|
|
|
|
#
|
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
#
|
|
|
|
# VARIABLES
|
|
|
|
#
|
|
|
|
|
|
|
|
user_vim_config=local/user.vim
|
|
|
|
local_bundle_dir=local/bundle
|
|
|
|
error_log=update-errors.log
|
|
|
|
|
2015-02-17 12:39:08 -05:00
|
|
|
script_name="${0//*\/}"
|
2024-03-04 14:39:06 -05:00
|
|
|
script_home="${0%"$script_name"}"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if [[ -z "$script_home" ]]; then
|
|
|
|
script_home="$PWD"
|
|
|
|
else
|
2018-03-11 22:55:51 -04:00
|
|
|
pushd "$script_home" >/dev/null || exit
|
2015-03-14 02:22:25 -04:00
|
|
|
script_home="$PWD"
|
2018-03-11 22:55:51 -04:00
|
|
|
popd >/dev/null || exit
|
2015-03-14 02:22:25 -04:00
|
|
|
fi
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2018-03-11 22:55:51 -04:00
|
|
|
if [[ -t 1 ]]; then
|
2015-02-17 12:39:08 -05:00
|
|
|
cbg_blue=$'\e[44m'
|
|
|
|
cbg_red_bold=$'\e[1;41m'
|
|
|
|
cbg_black=$'\e[40m'
|
|
|
|
cbg_yellow=$'\e[43m'
|
|
|
|
cfg_green_bold=$'\e[1;32m'
|
|
|
|
cfg_red_bold=$'\e[1;31m'
|
|
|
|
cfg_white_bold=$'\e[1;37m'
|
|
|
|
c_reset=$'\e[0m'
|
2018-03-11 22:55:51 -04:00
|
|
|
else
|
2015-02-17 12:39:08 -05:00
|
|
|
cbg_blue='#'
|
2018-03-11 22:55:51 -04:00
|
|
|
fi
|
2015-01-21 01:51:48 -05:00
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
#
|
|
|
|
# FUNCTIONS
|
|
|
|
#
|
|
|
|
|
2015-01-21 01:51:48 -05:00
|
|
|
# error: output and log error
|
2015-03-14 02:22:25 -04:00
|
|
|
function error {
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cbg_blue $c_reset$cbg_red_bold ! ERROR: $c_reset$cfg_red_bold $2 " >&2
|
|
|
|
printf '%s\n' "$cbg_blue $c_reset$cbg_red_bold ! COMMAND: $c_reset ${cfg_white_bold}=> $1$c_reset" >&2
|
2018-03-11 22:55:51 -04:00
|
|
|
[[ -n "$3" ]] && printf '%s\n' "$cbg_blue $c_reset$cbg_red_bold ! OUTPUT: $c_reset$cfg_white_bold $3" >&2
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n%s\n%s\n' "DATE: @ $(date)" "ERROR: $2" "COMMAND: $1" >> "$script_home/$error_log"
|
2018-03-11 22:55:51 -04:00
|
|
|
[[ -n "$3" ]] && printf '%s\n' "OUTPUT: $3" >> "$script_home/$error_log"
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n' >> "$script_home/$error_log"
|
2014-06-16 05:37:52 -04:00
|
|
|
}
|
|
|
|
|
2014-06-17 08:19:40 -04:00
|
|
|
# show_version: displays version information
|
2015-03-14 02:22:25 -04:00
|
|
|
function show_version {
|
2024-03-03 21:36:51 -05:00
|
|
|
repo_version="$(printf "%s.r%s" "$(git show -s --format=%ci master | sed 's/\ .*//g;s/-//g')" "$(git rev-list --count HEAD)")"
|
2024-03-01 16:28:35 -05:00
|
|
|
printf '%s\n' "$script_name: darkcloud-nvimconfig update tool (version: $repo_version)"
|
2014-06-17 01:49:46 -04:00
|
|
|
}
|
|
|
|
|
2014-06-17 08:19:40 -04:00
|
|
|
# show_help: this function displays help output
|
2015-03-14 02:22:25 -04:00
|
|
|
function show_help {
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n%s\n' 'USAGE'
|
|
|
|
printf ' %s\n\n' "./$script_name [OPTION]"
|
|
|
|
printf '%s\n' 'OPTIONS'
|
|
|
|
printf ' %s\t%s\n' '-v, --version' '| output version information and exit'
|
|
|
|
printf ' %s\t%s\n\n' '-h, --help' '| display this help and exit'
|
2024-03-01 16:28:35 -05:00
|
|
|
printf '%s\n' 'Run with no arguments to update darkcloud-nvimconfig'
|
2014-06-17 01:49:46 -04:00
|
|
|
}
|
2014-06-17 08:19:40 -04:00
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
#
|
|
|
|
# SETUP
|
|
|
|
#
|
|
|
|
|
2016-09-29 11:46:56 -04:00
|
|
|
if type -P timeout >/dev/null; then
|
|
|
|
timeout_command=timeout
|
|
|
|
elif type -P gtimeout >/dev/null; then
|
|
|
|
timeout_command=gtimeout
|
|
|
|
else
|
|
|
|
error 'type -P timeout' 'The timeout command could not be found (install coreutils)'
|
|
|
|
exit 1
|
|
|
|
fi
|
|
|
|
|
2016-09-06 12:24:56 -04:00
|
|
|
cd "$script_home" || exit
|
2014-06-17 01:49:46 -04:00
|
|
|
|
2014-06-17 08:19:40 -04:00
|
|
|
# delete old error log if it exists
|
2018-03-11 22:55:51 -04:00
|
|
|
[[ -f "$error_log" ]] && rm "$script_home/$error_log"
|
2014-06-17 08:19:40 -04:00
|
|
|
|
|
|
|
# parse for arguments (then handle them below)
|
2015-01-21 01:51:48 -05:00
|
|
|
[[ -n "$1" ]] && {
|
|
|
|
case "$1" in
|
|
|
|
-h|--help)
|
|
|
|
show_version
|
|
|
|
show_help
|
|
|
|
exit 0
|
|
|
|
;;
|
|
|
|
-v|--version)
|
|
|
|
show_version
|
|
|
|
exit 0
|
|
|
|
;;
|
|
|
|
*)
|
|
|
|
error "$ERROR" "$1 is not a valid option"
|
|
|
|
show_help
|
|
|
|
exit 1
|
|
|
|
;;
|
|
|
|
esac
|
|
|
|
}
|
2014-06-17 08:19:40 -04:00
|
|
|
|
2015-01-21 01:51:48 -05:00
|
|
|
# display script title
|
2024-03-01 16:28:35 -05:00
|
|
|
printf '\n%s\n' "$cbg_black ~~~ DarkCloud Neovim Config Update Tool ~~~ $c_reset"
|
2015-01-21 01:51:48 -05:00
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
# create the local bundle directory if it doesn't exist
|
|
|
|
[[ -d "$local_bundle_dir" ]] || {
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n%s' "$cbg_blue >> Creating user plugin directory:$c_reset"
|
2024-03-03 21:36:51 -05:00
|
|
|
process_status="$(install -d "$local_bundle_dir" 2>&1)"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cfg_green_bold SUCCESS! $c_reset"
|
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
2024-03-03 21:36:51 -05:00
|
|
|
error "install -d $local_bundle_dir" "User plugin directory couldn't be created" "$process_status"
|
2015-02-17 12:39:08 -05:00
|
|
|
fi
|
2015-01-21 01:51:48 -05:00
|
|
|
}
|
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
# create user.vim if it doesn't exist
|
|
|
|
[[ -e "$user_vim_config" ]] || {
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n%s' "$cbg_blue >> Creating user config file:$c_reset"
|
2024-03-03 21:36:51 -05:00
|
|
|
process_status="$(touch "$user_vim_config" 2>&1)"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
{
|
2024-03-01 21:59:23 -05:00
|
|
|
printf '%s\n%s\n\n' '"Auto-start syntax checking: (1:start toggled on | *0:start toggled off)' '"let g:autostartchecker = 1'
|
|
|
|
printf '%s\n%s\n\n' '"Enable Treesitter: (1:treesitter enabled | *0:treesitter disabled)' '"let g:enabletreesitter = 1'
|
|
|
|
printf '%s\n%s\n\n' '"Enable Auto-completion: (1:autocompletion enabled | *0:autocompletion disabled)' '"let g:enablecompletion = 1'
|
|
|
|
printf '%s\n%s\n\n' '"Enable automatic tag generation: (1:enable tag generation | *0:disable automatic tag generation)' '"let g:enableautotags = 1'
|
2024-03-01 22:23:28 -05:00
|
|
|
printf '%s\n%s\n' '"Enable Powerline: (1:use powerline characters | *0:use regular characters)' '"let g:enablepowerline = 1'
|
2024-03-03 21:36:51 -05:00
|
|
|
} >> "$user_vim_config"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
if [[ -e "$user_vim_config" ]]; then
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cfg_green_bold SUCCESS! $c_reset"
|
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
|
|
|
fi
|
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
2024-03-03 21:36:51 -05:00
|
|
|
error "touch $user_vim_config" "User config couldn't be created" "$process_status"
|
2015-02-17 12:39:08 -05:00
|
|
|
fi
|
2015-01-21 01:51:48 -05:00
|
|
|
}
|
2014-06-16 05:37:52 -04:00
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
#
|
|
|
|
# REPO UPDATE
|
|
|
|
#
|
|
|
|
|
2024-03-01 16:28:35 -05:00
|
|
|
printf '\n%s' "$cbg_blue >> Updating darkcloud-nvimconfig:$c_reset"
|
2015-02-17 12:39:08 -05:00
|
|
|
process_status="$(git pull origin master 2>&1)"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cfg_green_bold SUCCESS! $c_reset"
|
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
|
|
|
error 'git pull origin master' 'Git failed to sync the repo' "$process_status"
|
2014-06-16 05:37:52 -04:00
|
|
|
exit 1
|
2015-02-17 12:39:08 -05:00
|
|
|
fi
|
2014-06-17 08:19:40 -04:00
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
#
|
|
|
|
# SUBMODULE UPDATE
|
|
|
|
#
|
|
|
|
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n%s\n' "$cbg_blue >> Updating plugin submodules >> $c_reset"
|
|
|
|
printf '%s' "$cbg_blue $c_reset$cbg_yellow + Updating plugin URLs:$c_reset"
|
|
|
|
process_status="$(git submodule sync 2>&1)"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cfg_green_bold SUCCESS! $c_reset"
|
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
|
|
|
error 'git submodule sync' 'Git failed to sync the submodules' "$process_status"
|
|
|
|
fi
|
2014-06-16 05:37:52 -04:00
|
|
|
|
2014-06-17 08:19:40 -04:00
|
|
|
# update each submodule to the new head and run 'git fetch --all'
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s' "$cbg_blue $c_reset$cbg_yellow + Fetching updates:$c_reset"
|
2016-09-06 12:24:56 -04:00
|
|
|
git submodule foreach git reset --hard >/dev/null 2>&1
|
2015-02-17 12:39:08 -05:00
|
|
|
process_status="$(git submodule foreach git fetch --all 2>&1)"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
process_status=$(git submodule update --init --recursive 2>&1)
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cfg_green_bold SUCCESS! $c_reset"
|
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
|
|
|
error 'git submodule update --init --recursive' 'Git failed to update the submodules' "$process_status"
|
|
|
|
fi
|
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
|
|
|
error 'git submodule foreach git fetch --all' "Git failed to fetch the submodules from their respective remotes" "$process_status"
|
|
|
|
fi
|
2014-05-05 08:57:38 -04:00
|
|
|
|
2014-06-16 05:37:52 -04:00
|
|
|
# clean plugin directories and remove plugins no longer in the repo
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n%s\n' "$cbg_blue >> Clean plugin directories >> $c_reset"
|
|
|
|
printf '%s' "$cbg_blue $c_reset$cbg_yellow + Remove untracked files:$c_reset"
|
|
|
|
process_status="$(git submodule foreach git clean -dxf 2>&1)"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cfg_green_bold SUCCESS! $c_reset"
|
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
|
|
|
error 'git submodule foreach git clean -dxf' 'Git failed to remove untracked files' "$process_status"
|
|
|
|
fi
|
2015-01-21 01:51:48 -05:00
|
|
|
|
|
|
|
[[ -f '.gitmodules' ]] && {
|
|
|
|
for plugin in vim/bundle/*; do
|
|
|
|
[[ -f "$plugin/.git" ]] && {
|
2015-02-17 12:39:08 -05:00
|
|
|
plugin_dirname="${plugin/*\/}"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2024-03-05 21:09:56 -05:00
|
|
|
grep 'path = ' .gitmodules | grep -oe '[^\/]*$' | grep -qe "^$plugin_dirname$" || {
|
2015-02-17 12:39:08 -05:00
|
|
|
[[ -z "$first_found" ]] && {
|
|
|
|
first_found=1
|
|
|
|
printf '%s\n' "$cbg_blue $c_reset$cbg_yellow + Removing old plugins: $c_reset"
|
2015-01-21 02:17:09 -05:00
|
|
|
}
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-02-17 12:39:08 -05:00
|
|
|
process_status="$(rm -rf "${plugin:?}")"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2016-03-06 20:29:54 -05:00
|
|
|
printf '%s\n' "$cbg_blue $c_reset$cbg_yellow = $cfg_white_bold$plugin$c_reset"
|
2015-02-17 12:39:08 -05:00
|
|
|
else
|
|
|
|
error "rm -rf $plugin" "Folder couldn't be deleted" "$process_status"
|
2014-06-16 05:37:52 -04:00
|
|
|
exit 1
|
2015-02-17 12:39:08 -05:00
|
|
|
fi
|
2015-01-21 01:51:48 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
done
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n'
|
2015-01-21 01:51:48 -05:00
|
|
|
}
|
2014-06-17 08:19:40 -04:00
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
#
|
|
|
|
# USER PLUGIN UPDATE
|
|
|
|
#
|
|
|
|
|
|
|
|
[[ -d "$local_bundle_dir" ]] && find "$local_bundle_dir" -mindepth 3 -maxdepth 3 -name config | grep -q '.git/config' && {
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cbg_blue >> Updating user plugins >> $c_reset"
|
2024-03-03 21:36:51 -05:00
|
|
|
pushd "$local_bundle_dir" >/dev/null || exit
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-01-21 01:51:48 -05:00
|
|
|
for plugin in *; do
|
|
|
|
[[ -d "$plugin/.git" ]] && {
|
2018-03-11 22:55:51 -04:00
|
|
|
pushd "$plugin" >/dev/null || exit
|
2024-03-03 21:36:51 -05:00
|
|
|
printf '%s' "$cbg_blue $c_reset$cbg_yellow + Updating '$local_bundle_dir/$plugin':$c_reset"
|
2021-02-02 00:29:13 -05:00
|
|
|
process_status="$(git pull 2>&1)"
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
if ! grep -q "Already up-to-date" <<< "$process_status"; then
|
2015-02-17 12:53:32 -05:00
|
|
|
printf '%s\n' "$cfg_green_bold SUCCESS! $c_reset"
|
2015-02-17 12:39:08 -05:00
|
|
|
else
|
|
|
|
printf '%s\n' "$cfg_white_bold UP TO DATE $c_reset"
|
|
|
|
fi
|
|
|
|
else
|
2021-02-02 00:29:13 -05:00
|
|
|
error 'git pull' "Failed pulling changes for $plugin" "$process_status"
|
2015-02-17 12:39:08 -05:00
|
|
|
fi
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2018-03-11 22:55:51 -04:00
|
|
|
popd >/dev/null || exit
|
2015-01-21 01:51:48 -05:00
|
|
|
}
|
|
|
|
done
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2018-03-11 22:55:51 -04:00
|
|
|
popd >/dev/null || exit
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n'
|
2015-01-21 01:51:48 -05:00
|
|
|
}
|
2014-06-17 08:19:40 -04:00
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
#
|
|
|
|
# GENERATE PLUGIN HELP
|
|
|
|
#
|
|
|
|
|
2024-03-13 15:04:17 -04:00
|
|
|
type -P nvim >/dev/null && {
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s' "$cbg_blue >> Generating plugin help:$c_reset"
|
2024-03-13 15:01:11 -04:00
|
|
|
$timeout_command --preserve-status --foreground 1m nvim -c 'helptags ALL|qa!'
|
2016-09-29 11:46:56 -04:00
|
|
|
|
2015-03-14 02:22:25 -04:00
|
|
|
if (( ! $? )); then
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cfg_green_bold SUCCESS! $c_reset"
|
|
|
|
else
|
2014-06-17 08:19:40 -04:00
|
|
|
reset -I
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '%s\n' "$cfg_red_bold FAIL! $c_reset"
|
2024-03-13 15:01:11 -04:00
|
|
|
error "nvim -c 'helptags ALL|qa!'" 'Generating helpdocs for the submodules failed'
|
2023-08-22 21:13:52 -04:00
|
|
|
fi
|
|
|
|
}
|
|
|
|
|
2024-03-03 21:36:51 -05:00
|
|
|
#
|
|
|
|
# FINISH
|
|
|
|
#
|
|
|
|
|
2015-02-17 12:39:08 -05:00
|
|
|
printf '\n%s\n\n' "$cbg_black ~~~ Update Complete ~~~ $c_reset"
|