Add automatic execution of the orphan lua file check, config and docs

Author: Olical

README.md

@@ -76,6 +76,10 @@ fine!) will default to these values that should work fine for most people.
  ;; Intended for users who wish to write shebang comments at the top of their .lua for easier execution.
  :header-comment true
 
+ ;; Automatically invoke :NfnlFindOrphans whenever you write to a .fnl file. This acts as a passive garbage collection check and will warn you about dangling .lua files left over from .fnl deletions or renames.
+ ;; If an orphan is found, you can use :NfnlDeleteOrphans to delete all of the files listed automatically. This command will NOT prompt you, so make sure you check the list first!
+ :find-orphan-lua-files true
+
  ;; Passed to fennel.compileString when your code is compiled.
  ;; See https://fennel-lang.org/api for more information.
  :compiler-options {;; Disables ansi escape sequences in compiler output.

fnl/nfnl/api.fnl

@@ -9,14 +9,15 @@
 
 (local M (define :nfnl.api))
 
-(fn M.find-orphans []
-  "Find orphan Lua files that were compiled from a Fennel file that no longer exists. Display them with notify."
+(fn M.find-orphans [opts]
+  "Find orphan Lua files that were compiled from a Fennel file that no longer exists. Display them with notify. Set opts.passive? to true if you don't want it to tell you that there are no orphans."
   (let [dir (vim.fn.getcwd)
         {: config : root-dir : cfg} (config.find-and-load dir)]
     (if config
       (let [orphan-files (gc.find-orphan-lua-files {: root-dir : cfg})]
         (if (core.empty? orphan-files)
-            (notify.info "No orphan files detected.")
+            (when (not (core.get opts :passive?))
+              (notify.info "No orphan files detected."))
             (notify.warn
               "Orphan files detected, delete them with :NfnlDeleteOrphans.\n"
               (->> orphan-files

fnl/nfnl/callback.fnl

@@ -22,6 +22,10 @@
        : cfg
        :path (fs.full-path (. ev :file))
        :source (nvim.get-buf-content-as-string (. ev :buf))})
+
+    (when (cfg [:find-orphan-lua-files])
+      (api.find-orphans {:passive? true}))
+
     nil))
 
 (fn supported-path? [file-path]

fnl/nfnl/config.fnl

@@ -64,6 +64,7 @@
 
     {:verbose false
      :header-comment true
+     :find-orphan-lua-files true
      :compiler-options {:error-pinpoint false}
 
      :root-dir root-dir