Changed type of add-node-modules-path-command from string to list-of-strings, so that multiple commands can be specified as list, not as comma-separated values in a string.

Author: Markus Seebauer

README.md

@@ -20,10 +20,10 @@ To automatically run it when opening a new buffer:
 
 ## Monorepo Support
 In a monorepo scenario it might make sense to add multiple directories.
-To achieve this, a comma-separated list of commands can be specified:
+To achieve this, additional commands can be specified:
 
 ```
 (use-package add-node-modules-path
   :custom
-  (add-node-modules-path-command "pnpm bin, pnpm bin -w")) 
+  (add-node-modules-path-command '("pnpm bin" "pnpm bin -w"))) 
 ```

add-node-modules-path.el

@@ -38,47 +38,52 @@
   :group 'environment)
 
 ;;;###autoload
-(defcustom add-node-modules-path-command "npm bin"
-  "Command to find the bin path. To add multiple bin paths, specify a
-comma-separated list of commands, e.g. 'pnpm bin, pnpm bin -w'"
-  :type 'string)
+(defcustom add-node-modules-path-command '("npm bin")
+  "Command(s) to find the bin path. To add multiple bin paths, simply add
+multiple commands to the list, e.g. \\='(\"pnpm bin\" \"pnpm bin -w\")"
+  :type '(repeat string)
+  :set (lambda (symbol value)
+	 "Converts a non-list value to a single-element list of the same value.
+This is necessary to be backward compatible, since previous versions of this
+custom var were of type string."
+	 (set-default symbol (if (listp value) value (list value)))))
 
 ;;;###autoload
 (defcustom add-node-modules-path-debug nil
   "Enable verbose output when non nil."
   :type 'boolean
   :group 'add-node-modules-path)
 
-(defun add-node-modules-path/split-comma-separated-list (list-as-string)
-  "Interprets the provided LIST-AS-STRING argument as comma-separated list of strings
-and returns the values as list. Values are trimmed and empty values are removed."
-  (if (stringp list-as-string)
-      (seq-filter 's-present? (mapcar 's-trim (s-split "," list-as-string t)))))
+(defun add-node-modules-path/trim-list-and-elements (list)
+  "Trims all string values in LIST and empty / non-string values are removed."
+  (if (listp list)
+      (seq-filter 's-present? (mapcar 's-trim (seq-filter 'stringp list)))))
 
 (defun add-node-modules-path/exec-command (command)
-  "Executes the given COMMAND and returns a plist containing the command, its shell execution result
-and a boolean indicating, whether the execution result denotes a valid directory"
+  "Executes the given COMMAND and returns a plist containing the command, 
+its shell execution result and a boolean indicating, whether the execution
+result denotes a valid directory"
   (if (and (stringp command) (s-present? command))
       (let ((result (s-chomp (shell-command-to-string command))))
 	(list 'command command 'result result 'directory-p (file-directory-p result)))))
 
 (defun add-node-modules-path/exec-command-list (command-list)
-  "Executes all commands in COMMAND-LIST and returns a list of plists containing the various
-comnand execution results. Elements in COMMAND-LIST which are not strings are ignored
-and will not appear in the result."
+  "Executes all commands in COMMAND-LIST and returns a list of plists
+containing the various command execution results. Elements in COMMAND-LIST which
+are not strings are ignoredand will not appear in the result."
   (if (listp command-list)
       (seq-filter 'consp (mapcar 'add-node-modules-path/exec-command command-list))))
 
 (defun add-node-modules-path/get-valid-directories (command-executions)
-  "Filters the provided COMMAND-EXECUTIONS for entries, whose execution result denotes
-an existing directory"
+  "Filters the provided COMMAND-EXECUTIONS for entries, whose execution result
+denotes an existing directory"
   (if (listp command-executions)
       (let ((filtered (seq-filter '(lambda (elt) (plist-get elt 'directory-p)) command-executions)))
 	(mapcar #'(lambda (elt) (plist-get elt 'result)) filtered))))
 
 (defun add-node-modules-path/get-invalid-executions (command-executions)
-  "Filters the provided COMMAND-EXECUTIONS for entries, whose execution result denotes
-an invalid or non-existing directory"
+  "Filters the provided COMMAND-EXECUTIONS for entries, whose execution result
+denotes an invalid or non-existing directory"
   (if (listp command-executions)
       (seq-filter #'(lambda (elt) (and (plist-member elt 'directory-p) (not (plist-get elt 'directory-p)))) command-executions)))
 
@@ -100,7 +105,7 @@ an invalid or non-existing directory"
   "Run `npm bin` command and add the path to the `exec-path`.
 If `npm` command fails, it does nothing."
   (interactive)
-  (let* ((commands (add-node-modules-path/split-comma-separated-list add-node-modules-path-command))
+  (let* ((commands (add-node-modules-path/trim-list-and-elements add-node-modules-path-command))
          (executions (add-node-modules-path/exec-command-list commands))
          (dirs (add-node-modules-path/get-valid-directories executions)))
     (if (length> dirs 0)

test/add-node-modules-path-test.el

@@ -2,15 +2,15 @@
 ;;
 ;;
 
-(ert-deftest add-node-modules-path/split-comma-separated-list-test ()
-  (should (equal (add-node-modules-path/split-comma-separated-list "pnpm bin, pnpm bin -w,  ls -al   ")
+(ert-deftest add-node-modules-path/trim-list-and-elements-test ()
+  (should (equal (add-node-modules-path/trim-list-and-elements '("pnpm bin" "pnpm bin -w" "ls -al   "))
 		 '("pnpm bin" "pnpm bin -w" "ls -al")))
-  (should (equal (add-node-modules-path/split-comma-separated-list "  pnpm bin -w") '("pnpm bin -w")))
-  (should (equal (add-node-modules-path/split-comma-separated-list ",,, ls -al ,  ,,") '("ls -al")))
-  (should (eq (add-node-modules-path/split-comma-separated-list "") nil))
-  (should (eq (add-node-modules-path/split-comma-separated-list "    ") nil))
-  (should (eq (add-node-modules-path/split-comma-separated-list "   ,  ,,  ,") nil)))
-
+  (should (equal (add-node-modules-path/trim-list-and-elements '("  pnpm bin -w")) '("pnpm bin -w")))
+  (should (equal (add-node-modules-path/trim-list-and-elements '(nil "" " ls -al " "" nil "" nil)) '("ls -al")))
+  (should (eq (add-node-modules-path/trim-list-and-elements "") nil))
+  (should (eq (add-node-modules-path/trim-list-and-elements "    ") nil))
+  (should (eq (add-node-modules-path/trim-list-and-elements 1701) nil))
+  (should (eq (add-node-modules-path/trim-list-and-elements "a string") nil)))
 
 (ert-deftest add-node-modules-path/exec-command-test ()
   (should (eq (add-node-modules-path/exec-command nil) nil))
@@ -78,10 +78,10 @@
   (kill-local-variable 'add-node-modules-path-command))
 
 (ert-deftest add-node-modules-path-single-command-test ()
-  (add-node-modules-path/exec-add-node-modules-path-test "echo \"/etc\"" '("/etc")))
+  (add-node-modules-path/exec-add-node-modules-path-test '("echo \"/usr\"") '("/usr")))
 
 (ert-deftest add-node-modules-path-multiple-commands-test ()
-  (add-node-modules-path/exec-add-node-modules-path-test "echo \"/etc\", echo \"/var\"" '("/etc" "/var")))
+  (add-node-modules-path/exec-add-node-modules-path-test '("echo \"/etc\"" "echo \"/var\"") '("/etc" "/var")))
 
 (ert-deftest add-node-modules-path-multiple-commands-with-failures-test ()
-  (add-node-modules-path/exec-add-node-modules-path-test "ls -al, echo \"/var\", date, echo \"/etc\", clear" '("/var" "/etc")))
+  (add-node-modules-path/exec-add-node-modules-path-test '("ls -al" "echo \"/var\"" "date" "echo \"/etc\"" "clear") '("/var" "/etc")))