updated README
[bash-notes.git] / notes.sh
index 68feaf9..eba388f 100644 (file)
--- a/notes.sh
+++ b/notes.sh
@@ -1,5 +1,8 @@
 #! /bin/bash
 
+# bash-notes © 2023 by danix is licensed under CC BY-NC 4.0. 
+# To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/
+
 # set -ex
 
 PID=$$
@@ -9,6 +12,9 @@ set_defaults() {
 # Binaries to use
 EDITOR=${EDITOR:-/usr/bin/vim}
 TERMINAL=${TERMINAL:-/usr/bin/alacritty}
+# add options for your terminal. Remember to add the last option to execute
+# your editor program, otherwise the script will fail.
+# see example in the addnote function
 TERM_OPTS="--class notes --title notes -e "
 JQ=${JQ:-/usr/bin/jq}
 
@@ -91,18 +97,23 @@ __NOWCONF__
     echo "${BASENAME} parameters are:"
     echo "  -h | --help                        : This help text"
     echo "  -p | --plain                       : Output is in plain text"
-    echo "                               (without this option the output is colored)"
+    echo "                               (without this option the output is formatted)"
+    echo "                               (this option must precede all others)"
     echo "  -l | --list                        : List existing notes"
-    echo "  -a | --add <title>         : Add new note"
-    echo "  -m | --modify <note>               : Modify note"
-    echo "  -d | --date <note>                 : Modify date for note"
-    echo "  -r | --remove <note>               : Remove note"
+    echo "  -a | --add [\"<title>\"]   : Add new note"
+    echo "  -e | --edit [<note>]               : Edit note"
+    echo "  -d | --delete [<note> | all]       : Delete single note or all notes at once"
     echo "  -v | --version             : Print version"
     echo "  --userconf                 : Export User config file"
     echo ""
 }
 
 function addnote() {
+       # remove eventually existing temp DB file
+       if [[ -f $TMPDB ]]; then
+               rm $TMPDB
+       fi
+
        NOTETITLE="$1"
        echo "adding new note - \"$NOTETITLE\""
        LASTID=$($JQ '.notes[-1].id // 0 | tonumber' $DB)
@@ -111,21 +122,25 @@ function addnote() {
        touch ${NOTESDIR}/${NOW}
        $JQ --arg i "$NOTEID" --arg t "$NOTETITLE" --arg f "$NOW" '.notes += [{"id": $i, "title": $t, "file": $f}]' "$DB" > $TMPDB
        mv $TMPDB $DB
+       # example for alacritty:
+       # alacritty --class notes --title notes -e /usr/bin/vim ...
        $(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${NOW})
 }
 
 function listnotes() {
        # [ $PLAIN == true ] && echo "output is plain text" || echo "output is colored"
        if [[ $(ls -A $NOTESDIR) ]]; then
-               echo "listing all notes"
-               echo ""
-               echo "[ID]      [TITLE]         [SIZE]"
+               if [ $PLAIN == false ]; then
+                       echo "listing all notes"
+                       echo ""
+               fi
+               [ $PLAIN == false ] && echo "[ID]       [TITLE]         [CREATED]"
                for i in ${NOTESDIR}/*; do
-                       SIZE=$(du -k $i |cut -f 1)
+                       local fname=$(basename $i)
+                       DATE=$(date -d @${fname} +"%d/%m/%Y %R %z%Z")
                        TITLE=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .title' $DB)
                        ID=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .id' $DB)
-
-                       echo "[${ID}]   ${TITLE}        ${SIZE}kb"
+                       [ $PLAIN == false ] && echo "[${ID}]    ${TITLE}        ${DATE}" || echo "${ID} - ${TITLE} - ${DATE}"
                done
        else
                echo "no notes yet. You can add your first one with: ${BASENAME} -a \"your note title\""
@@ -144,25 +159,54 @@ function editnote() {
        FILE=$($JQ -r --arg i $OK '.notes[] | select(.id == $i) | .file' $DB)
        if [ "$TITLE" ]; then
                echo "editing note $TITLE"
-               $(${TERMINAL} --class notes --title notes -e ${EDITOR} ${NOTESDIR}/${FILE})
+               $(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${FILE})
        else
                 echo "note not found"
                 exit 1
        fi
 }
 
-function datenote() {
-       NOTE=$1
-       local OK=$(check_noteID $NOTE)
-       [ $OK ] && echo "editing date for note $OK" || echo "invalid note \"$NOTE\""
-       # FILEDATE=$(date -d @$NOW +%d/%m/%Y_%T)
-
-}
-
 function rmnote() {
+       # remove eventually existing temp DB file
+       if [[ -f $TMPDB ]]; then
+               rm $TMPDB
+       fi
+
        NOTE=$1
-       local OK=$(check_noteID $NOTE)
-       [ $OK ] && echo "removing note $OK" || echo "invalid note \"$NOTE\""
+       if [ "all" == $NOTE ]; then
+               echo "You're going to delete all notes."
+               read -r -p "Do you wish to continue? (y/N) " ANSWER
+               case $ANSWER in
+                       y|Y )
+                               $JQ 'del(.notes[])' $DB > $TMPDB
+                               mv $TMPDB $DB
+                               rm $NOTESDIR/*
+                               echo "Deleted all notes"
+                               ;;
+                       * )
+                               echo "Aborting, no notes were deleted."
+                               exit 1
+                               ;;
+               esac
+       else
+               local OK=$(check_noteID $NOTE)
+               if [ ! $OK ]; then
+                       echo "invalid note \"$NOTE\""
+                       exit 1
+               fi
+
+               TITLE=$($JQ --arg i $OK '.notes[] | select(.id == $i) | .title' $DB)
+               FILE=$($JQ -r --arg i $OK '.notes[] | select(.id == $i) | .file' $DB)
+               if [ "$TITLE" ]; then
+               $JQ -r --arg i $OK 'del(.notes[] | select(.id == $i))' $DB > $TMPDB
+               mv $TMPDB $DB
+               rm $NOTESDIR/$FILE
+               echo "Deleted note $TITLE"
+               else
+                        echo "note not found"
+                        exit 1
+               fi
+       fi
 }
 
 function export_config() {
@@ -231,7 +275,7 @@ fi
 
 # NOTE: This requires GNU getopt.  On Mac OS X and FreeBSD, you have to install this
 # separately; see below.
-GOPT=`getopt -o hvpla:m:d:r: --long help,version,list,plain,userconf,add:,modify:,date:,remove:,editor:,storage: \
+GOPT=`getopt -o hvpla:e:d: --long help,version,list,plain,userconf,add:,edit:,delete:,editor:,storage: \
              -n 'bash-notes' -- "$@"`
 
 if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
@@ -264,17 +308,12 @@ while true; do
                        shift 2
                        addnote "$TITLE"
                ;;
-               -m | --modify )
+               -e | --edit )
                        NOTE="$2"
                        shift 2
                        editnote "$NOTE"
                        ;;
-               -d | --date )
-                       NOTE="$2"
-                       shift 2
-                       datenote "$NOTE"
-                       ;;
-               -r | --remove )
+               -d | --delete )
                        NOTE="$2"
                        shift 2
                        rmnote "$NOTE"
@@ -285,7 +324,8 @@ while true; do
                        exit
                        ;;
                -- )
-                       shift; break
+                       shift
+                       break
                        ;;
                * )
                        break