Made notes extension-agnostic

Author: primis

README.md

@@ -49,12 +49,19 @@ You'll need to open a new shell for this to take effect.
 
 You can set your favourite text editor and your notes directory by setting the `$EDITOR` and `$NOTES_DIRECTORY` environmental variables.
 
-You can also set `$QUICKNOTE_FORMAT` to change the way that quicknotes are generated. The string formatted using the `date` command. 
 
 Most users shouldn't need to do any more than that. If you're doing anything more complicated though, you can configure `notes` config directly in "~/.config/notes/config", including EDITOR and NOTES_DIRECTORY. We've included an example in this repo for you ([config.example](config.example)) that you can copy. Any values set in the config file override values in environment variables.
 
 Right now this mainly exists in case you want to use a different `EDITOR` for notes than the one you have set in your environment generally, but this is where all other config will be living in future.
 
+### What are the configuration options?
+
+* `QUICKNOTE_FORMAT` changes the way that quicknotes are generated. The string formatted using the `date` command. 
+* `NOTES_EXT` changes the default extension that notes are saved with.
+* `NOTES_DIRECTORY` changes the directory in which notes are stored.
+* `EDITOR` can also be overriden here, for `notes` only.
+
+
 ## How do I use it?
 
 ### `notes new <note-name>`

config.example

@@ -7,3 +7,6 @@ EDITOR=nano
 
 # Change the quicknote format to get rid of the word "quicknote"
 QUICKNOTE_FORMAT="%Y-%m-%d"
+
+# Set extension to plain txt instead of markdown
+NOTES_EXT="txt"

notes

@@ -2,7 +2,7 @@
 
 # Default Date string before config
 QUICKNOTE_FORMAT="quicknote-%Y-%m-%d"
-
+NOTES_EXT="md"
 # Look for configuration file at ~/.config/notes/config and use it
 if [ -f ~/.config/notes/config ]; then 
     . ~/.config/notes/config
@@ -76,7 +76,7 @@ generate_name() {
     local format_string="`date +$QUICKNOTE_FORMAT`"
     # Initial test has no append
     resolved_name=$format_string
-    while [[ -e "$notes_dir/$resolved_name.md" ]]
+    while [[ -e "$notes_dir/$resolved_name.$NOTES_EXT" ]]
     do
         append_num=$[$append_num+1]
         resolved_name=$format_string.$append_num
@@ -90,7 +90,7 @@ new_note() {
          note_name=$resolved_name
     fi
     mkdir -p "$(dirname "$notes_dir/$note_name")"
-    open_note "$note_name.md"
+    open_note "$note_name.$NOTES_EXT"
 }
 
 remove_note() {
@@ -103,8 +103,8 @@ remove_note() {
     local note_name="$*"
     local to_remove="$notes_dir/$note_name"
 
-    if [ -f "$notes_dir/$note_name.md" ]; then
-        to_remove="$notes_dir/$note_name.md"
+    if [ -f "$notes_dir/$note_name.$NOTES_EXT" ]; then
+        to_remove="$notes_dir/$note_name.$NOTES_EXT"
     fi
     rm "${rm_args[@]}" "$to_remove"
 }
@@ -125,8 +125,8 @@ open_something() {
 open_note() {
     local note_path=$1
 
-    if [[ "$note_path" != *.md ]]; then
-        note_path="$note_path.md"
+    if [[ "$note_path" != *.$NOTES_EXT ]]; then
+        note_path="$note_path.$NOTES_EXT"
     fi
     if [ ! -f "$note_path" ]; then
         note_path="$notes_dir/$note_path"

test/test-config.bats

@@ -32,3 +32,12 @@ notes="./notes"
   assert_success
   assert_line "$NOTES_DIRECTORY/test.md"
 }
+
+@test "Configuration should override file extension" {
+  mkdir -p $HOME/.config/notes
+  echo "NOTES_EXT=txt" > $HOME/.config/notes/config
+  run $notes new test
+
+  assert_success
+  assert_exists "$NOTES_DIRECTORY/test.txt"
+}