Add -e/--edit to neuron search. Resolves #43

Author: srid

CHANGELOG.md

@@ -5,6 +5,7 @@
 - New features
   - [Short links](https://neuron.srid.ca/2014501.html).
   - Full text search: `neuron search --full-text`
+  - #43: Add `neuron search -e` to open the matching zettel in $EDITOR
   - Allow customizing output directory
   - Added `neuron open` to open the locally generated Zettelkasten site.
 - CLI revamp

guide/2013501.md

@@ -14,10 +14,10 @@ neuron -d ~/notes search
 
 This command will allow you to search your Zettels by title, and then print the matching zettel's filepath at the end. 
 
-You may pipe the command to your text editor in order to directly edit the matching Zettel:
+You may pipe the command to your text editor in order to directly edit the matching Zettel, or simply pass the `-e` option which opens the zettel in your $EDITOR:
 
 ```bash
-neuron search | xargs -rt vim
+neuron search -e
 ```
 
 [![asciicast](https://asciinema.org/a/313358.png)](https://asciinema.org/a/313358)

src-script/neuron-search/default.nix

@@ -9,10 +9,12 @@ pkgs.writeShellScriptBin "neuron-search"
     NOTESDIR=''${1}
     FILTERBY=''${2}
     SEARCHFROMFIELD=''${3}
+    OPENCMD=`${pkgs.envsubst}/bin/envsubst -no-unset -no-empty <<< ''${4}`
     cd ''${NOTESDIR}
     ${pkgs.ripgrep}/bin/rg --no-heading --no-line-number --sort path "''${FILTERBY}" *.md \
       | ${pkgs.fzf}/bin/fzf --tac --no-sort -d ':' -n ''${SEARCHFROMFIELD}.. \
         --preview '${pkgs.bat}/bin/bat --style=plain --color=always {1}' \
         --bind 'ctrl-j:execute(xdg-open https://localhost:8080/(echo {1} | ${pkgs.gnused}/bin/sed "s/\.md/.html/g"))+abort' \
-      | ${pkgs.gawk}/bin/awk -F: "{printf \"''${NOTESDIR}/%s\", \$1}"
+      | ${pkgs.gawk}/bin/awk -F: "{printf \"''${NOTESDIR}/%s\", \$1}" \
+      | xargs -r ''${OPENCMD}
   ''

src/Neuron/Zettelkasten.hs

@@ -35,6 +35,16 @@ import System.Which
 neuronSearchScript :: FilePath
 neuronSearchScript = $(staticWhich "neuron-search")
 
+searchScriptArgs :: SearchCommand -> [String]
+searchScriptArgs SearchCommand {..} =
+  let searchByArgs =
+        case searchBy of
+          SearchByTitle -> ["title: ", "3"]
+          SearchByContent -> ["", "2"]
+      editArg =
+        bool "echo" "$EDITOR" searchEdit
+   in searchByArgs <> [editArg]
+
 run :: Action () -> IO ()
 run act = do
   defaultNotesDir <- (</> "zettelkasten") <$> getHomeDirectory
@@ -68,12 +78,8 @@ runWith act App {..} = do
         store <- Z.mkZettelStore =<< Rib.forEvery ["*.md"] pure
         let matches = Z.runQuery store queries
         putLTextLn $ Aeson.encodeToLazyText $ matches
-    Search searchBy -> do
-      let args =
-            case searchBy of
-              SearchByTitle -> ["title: ", "3"]
-              SearchByContent -> ["", "2"]
-      execScript neuronSearchScript $ notesDir : args
+    Search searchCmd -> do
+      execScript neuronSearchScript $ notesDir : searchScriptArgs searchCmd
   where
     execScript scriptPath args =
       -- We must use the low-level execvp (via the unix package's `executeFile`)

src/Neuron/Zettelkasten/CLI.hs

@@ -11,6 +11,7 @@ module Neuron.Zettelkasten.CLI
     Command (..),
     NewCommand (..),
     SearchBy (..),
+    SearchCommand (..),
     commandParser,
     runRib,
     runRibOnceQuietly,
@@ -37,6 +38,12 @@ data App = App
 data NewCommand = NewCommand {title :: Text, edit :: Bool}
   deriving (Eq, Show)
 
+data SearchCommand = SearchCommand
+  { searchBy :: SearchBy,
+    searchEdit :: Bool
+  }
+  deriving (Eq, Show)
+
 data SearchBy
   = SearchByTitle
   | SearchByContent
@@ -48,7 +55,7 @@ data Command
   | -- | Open the locally generated Zettelkasten
     Open
   | -- | Search a zettel by title
-    Search SearchBy
+    Search SearchCommand
   | -- | Run a query against the Zettelkasten
     Query [Z.Query]
   | -- | Delegate to Rib's command parser
@@ -116,7 +123,7 @@ commandParser defaultNotesDir = do
             command "rib" $ info ribCommand $ progDesc "Generate static site via rib"
           ]
     newCommand = do
-      edit <- switch (long "edit" <> short 'e' <> help "Open the newly-created file in $EDITOR")
+      edit <- switch (long "edit" <> short 'e' <> help "Open the newly-created zettel in $EDITOR")
       title <- argument str (metavar "TITLE" <> help "Title of the new Zettel")
       return (New NewCommand {..})
     openCommand =
@@ -129,7 +136,8 @@ commandParser defaultNotesDir = do
       searchBy <-
         fmap (bool SearchByTitle SearchByContent) $
           switch (long "--full-text" <> short 'a' <> help "Full-text search")
-      pure $ Search searchBy
+      edit <- switch (long "edit" <> short 'e' <> help "Open the matching zettel in $EDITOR")
+      pure $ Search $ SearchCommand searchBy edit
     ribCommand = fmap Rib $ do
       ribOutputDir <-
         optional $