3 # bash-notes © 2023 by danix is licensed under CC BY-NC 4.0.
4 # To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/
6 # to debug the script run it like:
7 # DEBUG=true notes.sh ...
8 # and check /tmp/debug_bash-notes.log
9 if [[ $DEBUG == true
]]; then
10 exec 5> /tmp
/debug_bash-notes.log
17 BASENAME
=$
( basename "$0" )
21 DBVERSION
=${VERSION}_
${NOW}
26 EDITOR
=${EDITOR:-/usr/bin/vim}
27 TERMINAL
=${TERMINAL:-/usr/bin/alacritty}
28 # Git binary only used if $USEGIT is true - See below
29 GIT
=${GIT:-/usr/bin/git}
30 # add options for your terminal. Remember to add the last option to execute
31 # your editor program, otherwise the script will fail.
32 # see example in the addnote function
33 TERM_OPTS
="--class notes --title notes -e "
34 # Setting PAGER here overrides whatever is set in your default shell
35 # comment this option to use your default pager if set in your shell.
36 PAGER
=${PAGER:-/usr/bin/more}
38 # set this to true to have output in plain text
39 # or use the -p option on the command line before every other option
41 # base directory for program files
42 BASEDIR
=${BASEDIR:-~/.local/share/bash-notes}
43 # notes database in json format
45 # directory containing the actual notes
46 NOTESDIR
=${BASEDIR}/notes
50 # If you want to store your notes in a git repository set this to true
52 # Address of your remote repository
53 GITREMOTE
=${GITREMOTE:-""}
55 } # end set_defaults, do not change this line.
59 # Do not edit below this point
60 RCFILE
=${RCFILE:-~/.config/bash-notes.rc}
63 if [ ! -x "$JQ" ]; then
64 echo "jq not found in your PATH"
65 echo "install jq to continue"
69 # IMPORT USER DEFINED OPTIONS IF ANY
70 if [[ -f $RCFILE ]]; then
71 # shellcheck disable=SC1090
75 # We prevent the program from running more than one instance:
76 PIDFILE
=/var
/tmp
/$
(basename "$0" .sh
).pid
78 # Make sure the PID file is removed when we kill the process
79 trap 'rm -f $PIDFILE; exit 1' TERM INT
81 if [[ -r $PIDFILE ]]; then
82 # PIDFILE exists, so I guess there's already an instance running
83 # let's kill it and run again
84 # shellcheck disable=SC2046,SC2086
85 kill -s 15 $
(cat $PIDFILE) > /dev
/null
2>&1
86 # should already be deleted by trap, but just to be sure
91 echo $PID > "$PIDFILE"
93 # Export config to file
94 function export_config
() {
95 if [ -r ${RCFILE} ]; then
96 echo "Backing up current '${RCFILE}'...."
97 mv -f ${RCFILE} ${RCFILE}.$
(date +%Y
%m
%d_
%H
%M
)
99 echo "Writing '${RCFILE}'...."
100 sed -n '/^set_defaults() {/,/^} # end set_defaults, do not change this line./p' $0 \
101 |
grep -v set_defaults \
102 |
sed -e 's/^\([^=]*\)=\${\1:-\([^}]*\)}/\1=\2/' \
104 if [ -r ${RCFILE} ]; then
105 echo "Taking no further action."
108 echo "Could not write '${RCFILE}'...!"
113 # we should expand on this function to add a sample note and explain a little bit
114 # how the program works.
115 function firstrun
() {
116 [ -f $RCFILE ] && RC
=$RCFILE || RC
="none"
119 echo "${BASENAME} configuration:
121 base directory: ${BASEDIR}/
122 notes archive: ${NOTESDIR}/
123 notes database: ${DB}
125 text editor: ${EDITOR}
126 terminal: ${TERMINAL}
130 echo "Now I'll create the needed files and directories."
131 read -r -p "Do you wish to continue? (y/N) " ANSWER
135 cat << __EOL__ > ${DB}
138 "version": "${VERSION}",
139 "dbversion": "${DBVERSION}"
144 echo; echo "All done, you can now write your first note."
147 echo "No changes made. Exiting"
153 # check for notes dir existance and create it in case it doesn't exists
154 if [[ ! -d $NOTESDIR ]]; then
155 # we don't have a directory. FIRST RUN?