Merge pull request #34 from primis/master

Added Ability to be extension agnostic

Author: pimterry

README.md

@@ -51,7 +51,13 @@ To get started with you'll want to set `$EDITOR` to your favourite text editor,
 
 There are also more complex options available. You can set any configuration properties either in the environment, or in a config file (stored in `~/.config/notes/config`), with settings in config overriding those in your environment. This allows you to configure a different `$EDITOR` for notes to everything else, if you like. The config file is a good choice for more complex set ups, but probably not worth worrying about to start with. We've included an example config in this repo for you ([config.example](config.example)) that you can copy if you like. 
 
-The only other configuration property right now is `$QUICKNOTE_FORMAT`, which changes the way that quicknote filenames are generated. The string is formatted by passing it to the `date` command, and defaults to `quicknote-%Y-%m-%d`.
+### 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?
 

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
@@ -99,7 +99,7 @@ generate_name() {
     local format_string="`date +$QUICKNOTE_FORMAT`"
     # Initial test has no append
     local 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
@@ -113,7 +113,7 @@ new_note() {
          note_name="$(generate_name)"
     fi
     mkdir -p "$(dirname "$notes_dir/$note_name")"
-    open_note "$note_name.md"
+    open_note "$note_name.$NOTES_EXT"
 }
 
 remove_note() {
@@ -126,8 +126,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"
 }
@@ -148,8 +148,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

@@ -33,3 +33,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"
+}