Re: Suggestion of enhancement by adding a hyphen to sh-imenu-generic-expression

[James Cherti <contact@jamescherti.com>]

[-- Attachment #1: Type: text/plain, Size: 894 bytes --]

Hello Eli,

Attached is the patch you requested for sh-script.el.

The patch enables the use of hyphens in Bash function names by adding a 
regular expression for Bash to `sh-imenu-generic-expression`.

--
James Cherti
GitHub: https://github.com/jamescherti
Website: https://www.jamescherti.com/

On 2024-11-24 04:41, Eli Zaretskii wrote:
>> Date: Sat, 23 Nov 2024 16:04:17 -0500
>> From: James Cherti <contact@jamescherti.com>
>>
>> Hello,
>>
>> While editing a Bash shell script today, I discovered that imenu does
>> not include functions with hyphens in their names.
>>
>> While it is true that sh does not allow hyphens in function names, Bash
>> does permit them.
>>
>> My suggestion is to add a hyphen '-' to the sh-imenu-generic-expression
>> (sh-script.el) regular expression to make imenu include these functions,
> 
> Would you like to submit a patch along these lines?
> 
> Thanks.

[-- Attachment #2: bash-imenu-hyphen.patch --]
[-- Type: text/x-patch, Size: 1092 bytes --]

From 6f4d453e0eafe1e081d7f1dbef7d128497840dc0 Mon Sep 17 00:00:00 2001
From: James Cherti <contact@jamescherti.com>
Date: Sun, 24 Nov 2024 12:09:33 -0500
Subject: [PATCH] Add hyphen to Bash function names in
 `sh-imenu-generic-expression`

---
 lisp/progmodes/sh-script.el | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el
index 8ba64100203..04d995d0404 100644
--- a/lisp/progmodes/sh-script.el
+++ b/lisp/progmodes/sh-script.el
@@ -300,6 +300,18 @@ sh-imenu-generic-expression
 	(nil
 	 "^\\s-*\\([[:alpha:]_][[:alnum:]_]*\\)\\s-*()"
 	 1)))
+    ;; The difference between the Bash regular expression and the sh regular
+    ;; expression is that Bash also allows hyphens (-).
+    (bash
+     . ((nil
+         ;; function FOO
+         ;; function FOO()
+         "^\\s-*function\\s-+\\([[:alpha:]_][[:alnum:]_-]*\\)\\s-*\\(?:()\\)?"
+         1)
+        ;; FOO()
+        (nil
+         "^\\s-*\\([[:alpha:]_][[:alnum:]_-]*\\)\\s-*()"
+         1)))
     (mksh
      . ((nil
          ;; function FOO
-- 
2.39.5