dotfiles/.config/shell/bin/ned

143 lines
3.7 KiB
Text
Raw Normal View History

2022-04-08 02:32:05 -07:00
#!/bin/sh
# v1.0
2022-01-13 14:47:59 -08:00
# NEd: Note Editor (and your best friend!)
# Ned can edit and create notes in a folder you tell him to!
# Depends: fzf
2022-01-13 14:47:59 -08:00
# TODO: make it so the script assumes you are editing, and automatically creates a new document if the file to edit doesn't exist
# shellcheck disable=SC2068,SC2178,SC2128
2022-01-20 03:18:04 -08:00
# set default values if things are unset
2022-04-08 02:32:05 -07:00
BASE_DIR="${NOTES_DIR:-"$HOME/Documents/college/current"}"
EDITOR="nvim"
EDITOR_CMD="nvim -c :ZenMode"
DEFAULT_NEW_NOTE_EXT=.md
DEFAULT_NEW_NOTE_NAME="$(date +'%m-%d')$DEFAULT_NEW_NOTE_EXT"
2022-04-08 02:32:05 -07:00
# Some fzf commands
FZF="fzf -1 --layout=reverse --info=inline --height=10%"
FZF_SEARCH="$FZF -q "
2022-01-13 14:47:59 -08:00
usage() {
cat <<-EOF
Usage:
ned <verb>
new <folder> [note name] Create a new note in the matched folder
[edit|ed] [folder] <note name> Search for and edit a text document in a folder
ned Edit ned
help Print this message
cd [folder] Open a shell in a directory or the default directory
2022-01-13 14:47:59 -08:00
Notes:
Edit 'T' to get today's note
Folder and file names are searched with fuzzy search
2022-04-08 02:32:05 -07:00
ned will automatically activate the ZenMode neovim extension
Current repository path: '$BASE_DIR'
EOF
}
open_file() {
2022-04-08 02:32:05 -07:00
cd "$(dirname "$1")" || return
$EDITOR_CMD "$1"
}
2022-04-08 02:32:05 -07:00
# Usage:
# edit "unused param" ["search_directory"] "search_term"
edit() {
check_setup
2022-04-08 02:32:05 -07:00
# This logic is to allow the $2 to be optional
if [ -n "$3" ]; then
SEARCH_TERM="$3"
2022-04-08 02:32:05 -07:00
NOTE_DIR="$(cd "$BASE_DIR" && fd -t f | sed 's-\./--g' | $FZF_SEARCH "$2")" || exit
elif [ -n "$2" ]; then
SEARCH_TERM="$2"
fi
2022-04-08 02:32:05 -07:00
# Searching for 'T' will get you today's note
if [ "$SEARCH_TERM" = 'T' ]; then
2022-04-08 02:32:05 -07:00
SEARCH_TERM="$DEFAULT_NEW_NOTE_NAME"
fi
2022-04-08 02:32:05 -07:00
NOTE="$NOTE_DIR/$(cd "$NOTE_DIR" && $FZF_SEARCH "$SEARCH_TERM")" || exit
2022-01-29 22:53:29 -08:00
2022-04-08 02:32:05 -07:00
open_file "$NOTE"
}
2022-01-13 14:47:59 -08:00
2022-04-08 02:32:05 -07:00
# Usage: new "unused param" "save directory" ["note name"]
2022-01-20 03:18:04 -08:00
new() {
check_setup
2022-04-08 02:32:05 -07:00
# Note name
if [ -n "$3" ]; then
NEW_NOTE_NAME="$3"
else
2022-04-08 02:32:05 -07:00
NEW_NOTE_NAME="$DEFAULT_NEW_NOTE_NAME"
2022-01-20 03:18:04 -08:00
fi
2022-04-08 02:32:05 -07:00
# Note dir
NEW_NOTE_DIR="$BASE_DIR/$(cd "$BASE_DIR" && fd -d 1 | sed 's-\./--g' | $FZF_SEARCH "$2")" || exit
2022-04-08 02:32:05 -07:00
if [ -f "$NEW_NOTE_DIR/$NEW_NOTE_NAME" ]; then
open_file "$NEW_NOTE_DIR/$NEW_NOTE_NAME"
else
2022-04-08 02:32:05 -07:00
cd "$NEW_NOTE_DIR" || exit
# apply a template for notes
2022-04-08 02:32:05 -07:00
cat <<-EOF >> "$NEW_NOTE_DIR/$NEW_NOTE_NAME"
# ${NEW_NOTE_NAME%%$DEFAULT_NEW_NOTE_EXT}
<!-- vim: wrap nonu nornu
-->
EOF
2022-04-08 02:32:05 -07:00
STARTING_MD5="$(md5sum "$NEW_NOTE_DIR/$NEW_NOTE_NAME")"
open_file "$NEW_NOTE_DIR/$NEW_NOTE_NAME"
# Delete the file if no changes were made
if [ "$(md5sum "$NEW_NOTE_DIR/$NEW_NOTE_NAME")" = "$STARTING_MD5" ]; then
rm "$NEW_NOTE_DIR/$NEW_NOTE_NAME"
2022-01-30 17:14:55 -08:00
fi
fi
}
subshell() {
2022-03-02 05:21:45 -08:00
echo
echo 'entering subshell'
$SHELL
}
shell() {
if [ -n "${2+foo}" ]; then
DIR="$BASE_DIR/$(cd "$BASE_DIR" && fd -d 1 -t d | sed 's-\./--g' | $FZF_SEARCH "$2")" || exit
fi
if cd "$DIR"; then
subshell
else
exit
2022-04-08 02:32:05 -07:00
fi
}
check_setup() {
# perform preliminary checks to make sure the script can run properly
2022-04-08 02:32:05 -07:00
if ! [ -d "$BASE_DIR" ]; then
echo "Error: Notes directory ($BASE_DIR) does not exist or is not a directory"
exit 1
fi
2022-01-20 03:18:04 -08:00
}
# Parse arguments (first character only)
2022-01-30 17:19:00 -08:00
case "${1}" in
# help
'--help'|'-h'|'help'|'h') usage;;
2022-01-13 14:47:59 -08:00
# create and edit new note
2022-01-30 17:19:00 -08:00
'new') new $@;;
# edit an existing document or file
'edit'|'ed') edit $@;;
# run a shell (cd to) in the directory
2022-04-08 02:32:05 -07:00
'cd') shell $@;;
# edit ned (the file you are looking at right now)
'ned') $EDITOR "$(realpath "$0")";;
2022-01-13 14:47:59 -08:00
*) echo "no such option";;
esac
2022-04-08 02:32:05 -07:00
# vim: et sw=3 ts=3 ft=sh