Merge pull request #90 from allank-fd/feature/add-short-hand-cat-alias

feat: Add shorthand cat alias c

Author: pimterry

README.md

@@ -147,8 +147,7 @@ Renames a given note to destination or moves the note to directory. Name can be
 Removes the given note if it exists. If `-r` or `--recursive` is given, deletes the folders/notes recursively.
 
 ### `notes cat <note-name>`
-
-Displays the note
+Displays the note. Shorthand alias also available with `notes c`.
 
 ### `notes grep/find <pattern> | notes open`
 

notes

@@ -294,7 +294,7 @@ Usage:
     $name append|a <name> [message]       # Appends a note. Will use stdin if no message is given
     $name mv <source> <dest>|<directory>  # Rename a note, or move a note when a directory is given
     $name rm [-r | --recursive] <name>    # Remove note, or folder if -r or --recursive is given
-    $name cat <name>                      # Display note
+    $name cat|c <name>                    # Display note
     echo <name> | $name open|o            # Open all note filenames piped in
     echo <name> | $name cat               # Display all note filenames piped in
     $name --help                          # Print this usage information
@@ -358,7 +358,7 @@ main() {
             cmd="remove_note"
             modified=1
             ;;
-        "cat" )
+        "cat" | "c" )
             cmd="handle_multiple_notes cat"
             ;;
         --help | -help | -h )

test/test-cat.bats

@@ -21,6 +21,15 @@ notes="./notes"
   assert_output $'line1\nline2'
 }
 
+@test "Should show created note when using the cat shorthand alias" {
+  echo line1 >> "$NOTES_DIRECTORY/note.md"
+  echo line2 >> "$NOTES_DIRECTORY/note.md"
+  run $notes c note.md
+
+  assert_success
+  assert_output $'line1\nline2'
+}
+
 @test "Accepts names without .md to show" {
   echo line1 >> "$NOTES_DIRECTORY/note.md"
   echo line2 >> "$NOTES_DIRECTORY/note.md"