From 93940af1d456ec52f39cb2912b5ffb8445d26c98 Mon Sep 17 00:00:00 2001
From: James Trew <j.trew10@gmail.com>
Date: Thu, 2 May 2024 23:33:22 -0400
Subject: [PATCH] docs(luacats): support backtick captured generic type

Problem:
While LuaCATS's generics system are still considered WIP by luals, they
currently support type captured generics.

See "Capture with Backtick" example:
https://luals.github.io/wiki/annotations/#generic

Solution:
Add support for it in the LuaCATS grammar
---
 scripts/luacats_grammar.lua                     | 3 ++-
 test/functional/script/luacats_grammar_spec.lua | 7 +++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/scripts/luacats_grammar.lua b/scripts/luacats_grammar.lua
index ca26c70156..29f3bda5aa 100644
--- a/scripts/luacats_grammar.lua
+++ b/scripts/luacats_grammar.lua
@@ -170,7 +170,7 @@ local grammar = P {
   ltype = parenOpt(v.ty_union),
 
   ty_union = v.ty_opt * rep(Pf('|') * v.ty_opt),
-  ty = v.ty_fun + ident + v.ty_table + literal + paren(v.ty),
+  ty = v.ty_fun + ident + v.ty_table + literal + paren(v.ty) + v.ty_generic,
   ty_param = Pf('<') * comma1(v.ltype) * fill * P('>'),
   ty_opt = v.ty * opt(v.ty_param) * opt(P('[]')) * opt(P('?')),
   ty_index = (Pf('[') * (v.ltype + ident + rep1(num)) * fill * P(']')),
@@ -179,6 +179,7 @@ local grammar = P {
   ty_table = Pf('{') * comma1(v.table_elem) * fill * P('}'),
   fun_param = lname * opt(colon * v.ltype),
   ty_fun = Pf('fun') * paren(comma(lname * opt(colon * v.ltype))) * opt(colon * comma1(v.ltype)),
+  ty_generic = P('`') * letter * P('`'),
 }
 
 return grammar --[[@as nvim.luacats.grammar]]
diff --git a/test/functional/script/luacats_grammar_spec.lua b/test/functional/script/luacats_grammar_spec.lua
index 2dd3ad8a78..6d444e1888 100644
--- a/test/functional/script/luacats_grammar_spec.lua
+++ b/test/functional/script/luacats_grammar_spec.lua
@@ -152,4 +152,11 @@ describe('luacats grammar', function()
     name = '[1]',
     type = 'integer',
   })
+
+  test('@param type `T` this is a generic type', {
+    desc = 'this is a generic type',
+    kind = 'param',
+    name = 'type',
+    type = '`T`',
+  })
 end)