bug#59945: [PATCH] Fix empty pairs in js tree-sitter imenu alist

["Charl P. Botha" <cpbotha@vxlabs.com>]

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

Dear Yuan,

On Fri, Dec 16, 2022, at 03:40, Yuan Fu wrote:
> "Charl P. Botha" <cpbotha@vxlabs.com> writes:
>> In the meantime, I've sent my signed copyright assignment, and my employer's docusigned disclaimer of rights, to the FSF.
>>
>> I would be super grateful if you could add the commit when you can make the time.
>
> Thanks. Unless I’m missing something, your patch is a diff file rather
> than a patch file. You can generate one with
>
> git format-patch -1 --stdout >~/mypatch.patch
>
> Don’t worry about commit message this time, I’ll reword your commit and
> add it. But if you want to submit more patches in the future I recommend
> you to read CONTRIBUTE file under repo root, which describes the commit
> message format Emacs uses.

I followed the instructions at https://www.gnu.org/software/emacs/manual/html_node/emacs/Sending-Patches.html which said to use "git format-patch master" and include either inline (which I did) or as a mime attachment.

I have now re-done it using your advice above, and included the patch file as attachment to this email.

Next time (would be great if it happens), I'll attach by default.

Kind regards,
Charl

[-- Attachment #2: cpb-fix-empty-pairs-js-ts.patch --]
[-- Type: application/octet-stream, Size: 1859 bytes --]

From 01c4f3ade5c61b96718bbf36b2ed7b4b1ed84aa0 Mon Sep 17 00:00:00 2001
From: "Charl P. Botha" <cpbotha@vxlabs.com>
Date: Sat, 10 Dec 2022 19:09:38 +0200
Subject: [PATCH] Fix empty pairs in js tree-sitter imenu alist

The current js--treesit-imenu, used by the JavaScript, TypeScript and
TSX tree-sitter modes, would return empty pairs in the imenu alist if
there were none of that type of symbol.

This would break both the built in imenu and also packages like
consult-imenu.

See https://github.com/minad/consult/issues/697 for the discussion there.
---
 lisp/progmodes/js.el | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/lisp/progmodes/js.el b/lisp/progmodes/js.el
index e0625951b65..8fd0386e6ae 100644
--- a/lisp/progmodes/js.el
+++ b/lisp/progmodes/js.el
@@ -3738,10 +3738,17 @@ js--treesit-imenu
          (func-tree (treesit-induce-sparse-tree
                      node "function_declaration" nil 1000))
          (var-tree (treesit-induce-sparse-tree
-                    node "lexical_declaration" nil 1000)))
-    `(("Class" . ,(js--treesit-imenu-1 class-tree))
-      ("Variable" . ,(js--treesit-imenu-1 var-tree))
-      ("Function" . ,(js--treesit-imenu-1 func-tree)))))
+                    node "lexical_declaration" nil 1000))
+         (imenu-alist nil))
+    ;; when a sub-tree is empty, we should not return that pair at all
+    ;; https://github.com/minad/consult/issues/697#issuecomment-1345302734
+    (when func-tree
+      (setq imenu-alist (cons `("Function" . ,(js--treesit-imenu-1 func-tree)) imenu-alist)))
+    (when var-tree
+      (setq imenu-alist (cons `("Variable" . ,(js--treesit-imenu-1 var-tree)) imenu-alist)))
+    (when class-tree
+      (setq imenu-alist (cons `("Class" . ,(js--treesit-imenu-1 class-tree)) imenu-alist)))
+    imenu-alist))
 
 ;;; Main Function
 
-- 
2.25.1