3 files changed, 320 insertions, 0 deletions
diff --git a/test/functional/script/luacats_grammar_spec.lua b/test/functional/script/luacats_grammar_spec.lua
new file mode 100644
index 0000000000..c3ac9fe722
--- /dev/null
+++ b/test/functional/script/luacats_grammar_spec.lua
@@ -0,0 +1,154 @@
+local helpers = require('test.functional.helpers')(after_each)
+local eq = helpers.eq
+
+local grammar = require('scripts/luacats_grammar')
+
+describe('luacats grammar', function()
+  --- @param text string
+  --- @param exp table<string,string>
+  local function test(text, exp)
+    it(string.format('can parse %q', text), function()
+      eq(exp, grammar:match(text))
+    end)
+  end
+
+  test('@param hello vim.type', {
+    kind = 'param',
+    name = 'hello',
+    type = 'vim.type',
+  })
+
+  test('@param hello vim.type this is a description', {
+    kind = 'param',
+    name = 'hello',
+    type = 'vim.type',
+    desc = 'this is a description',
+  })
+
+  test('@param hello vim.type|string this is a description', {
+    kind = 'param',
+    name = 'hello',
+    type = 'vim.type|string',
+    desc = 'this is a description',
+  })
+
+  test('@param hello vim.type?|string? this is a description', {
+    kind = 'param',
+    name = 'hello',
+    type = 'vim.type?|string?',
+    desc = 'this is a description',
+  })
+
+  test('@return string hello this is a description', {
+    kind = 'return',
+    {
+      name = 'hello',
+      type = 'string',
+    },
+    desc = 'this is a description',
+  })
+
+  test('@return fun() hello this is a description', {
+    kind = 'return',
+    {
+      name = 'hello',
+      type = 'fun()',
+    },
+    desc = 'this is a description',
+  })
+
+  test('@return fun(a: string[]): string hello this is a description', {
+    kind = 'return',
+    {
+      name = 'hello',
+      type = 'fun(a: string[]): string',
+    },
+    desc = 'this is a description',
+  })
+
+  test('@return fun(a: table<string,any>): string hello this is a description', {
+    kind = 'return',
+    {
+      name = 'hello',
+      type = 'fun(a: table<string,any>): string',
+    },
+    desc = 'this is a description',
+  })
+
+  test('@param ... string desc', {
+    kind = 'param',
+    name = '...',
+    type = 'string',
+    desc = 'desc',
+  })
+
+  test('@param level (integer|string) desc', {
+    kind = 'param',
+    name = 'level',
+    type = 'integer|string',
+    desc = 'desc',
+  })
+
+  test('@return (string command) the command and arguments', {
+    kind = 'return',
+    {
+      name = 'command',
+      type = 'string',
+    },
+    desc = 'the command and arguments',
+  })
+
+  test('@return (string command, string[] args) the command and arguments', {
+    kind = 'return',
+    {
+      name = 'command',
+      type = 'string',
+    },
+    {
+      name = 'args',
+      type = 'string[]',
+    },
+    desc = 'the command and arguments',
+  })
+
+  test('@param rfc "rfc2396" | "rfc2732" | "rfc3986" | nil', {
+    kind = 'param',
+    name = 'rfc',
+    type = '"rfc2396" | "rfc2732" | "rfc3986" | nil',
+  })
+
+  test('@param offset_encoding "utf-8" | "utf-16" | "utf-32" | nil', {
+    kind = 'param',
+    name = 'offset_encoding',
+    type = '"utf-8" | "utf-16" | "utf-32" | nil',
+  })
+
+  -- handle a : after the param type
+  test('@param a b: desc', {
+    kind = 'param',
+    name = 'a',
+    type = 'b',
+    desc = 'desc',
+  })
+
+  test(
+    '@field prefix? string|table|(fun(diagnostic:vim.Diagnostic,i:integer,total:integer): string, string)',
+    {
+      kind = 'field',
+      name = 'prefix?',
+      type = 'string|table|(fun(diagnostic:vim.Diagnostic,i:integer,total:integer): string, string)',
+    }
+  )
+
+  test('@field [integer] integer', {
+    kind = 'field',
+    name = '[integer]',
+    type = 'integer',
+  })
+
+  test('@field [1] integer', {
+    kind = 'field',
+    name = '[1]',
+    type = 'integer',
+  })
+end)
diff --git a/test/functional/script/luacats_parser_spec.lua b/test/functional/script/luacats_parser_spec.lua
new file mode 100644
index 0000000000..e10aa81003
--- /dev/null
+++ b/test/functional/script/luacats_parser_spec.lua
@@ -0,0 +1,106 @@
+local helpers = require('test.functional.helpers')(after_each)
+local eq = helpers.eq
+
+local parser = require('scripts/luacats_parser')
+
+--- @param name string
+--- @param text string
+--- @param exp table<string,string>
+local function test(name, text, exp)
+  exp = vim.deepcopy(exp, true)
+  it(name, function()
+    eq(exp, parser.parse_str(text, 'myfile.lua'))
+  end)
+end
+
+describe('luacats parser', function()
+  local exp = {
+    myclass = {
+      kind = 'class',
+      module = 'myfile.lua',
+      name = 'myclass',
+      fields = {
+        { kind = 'field', name = 'myclass', type = 'integer' },
+      },
+    },
+  }
+
+  test(
+    'basic class',
+    [[
+    --- @class myclass
+    --- @field myclass integer
+  ]],
+    exp
+  )
+
+  exp.myclass.inlinedoc = true
+
+  test(
+    'class with @inlinedoc (1)',
+    [[
+    --- @class myclass
+    --- @inlinedoc
+    --- @field myclass integer
+  ]],
+    exp
+  )
+
+  test(
+    'class with @inlinedoc (2)',
+    [[
+    --- @inlinedoc
+    --- @class myclass
+    --- @field myclass integer
+  ]],
+    exp
+  )
+
+  exp.myclass.inlinedoc = nil
+  exp.myclass.nodoc = true
+
+  test(
+    'class with @nodoc',
+    [[
+    --- @nodoc
+    --- @class myclass
+    --- @field myclass integer
+  ]],
+    exp
+  )
+
+  exp.myclass.nodoc = nil
+  exp.myclass.access = 'private'
+
+  test(
+    'class with (private)',
+    [[
+    --- @class (private) myclass
+    --- @field myclass integer
+  ]],
+    exp
+  )
+
+  exp.myclass.fields[1].desc = 'Field\ndocumentation'
+
+  test(
+    'class with field doc above',
+    [[
+    --- @class (private) myclass
+    --- Field
+    --- documentation
+    --- @field myclass integer
+  ]],
+    exp
+  )
+
+  exp.myclass.fields[1].desc = 'Field documentation'
+  test(
+    'class with field doc inline',
+    [[
+    --- @class (private) myclass
+    --- @field myclass integer Field documentation
+  ]],
+    exp
+  )
+end)
diff --git a/test/functional/script/text_utils_spec.lua b/test/functional/script/text_utils_spec.lua
new file mode 100644
index 0000000000..190c617e1d
--- /dev/null
+++ b/test/functional/script/text_utils_spec.lua
@@ -0,0 +1,60 @@
+local helpers = require('test.functional.helpers')(after_each)
+local exec_lua = helpers.exec_lua
+local eq = helpers.eq
+
+local function md_to_vimdoc(text, start_indent, indent, text_width)
+  return exec_lua(
+    [[
+    local text, start_indent, indent, text_width = ...
+    start_indent = start_indent or 0
+    indent = indent or 0
+    text_width = text_width or 70
+    local text_utils = require('scripts/text_utils')
+    return text_utils.md_to_vimdoc(table.concat(text, '\n'), start_indent, indent, text_width)
+  ]],
+    text,
+    start_indent,
+    indent,
+    text_width
+  )
+end
+
+local function test(what, act, exp, ...)
+  local argc, args = select('#', ...), { ... }
+  it(what, function()
+    eq(table.concat(exp, '\n'), md_to_vimdoc(act, unpack(args, 1, argc)))
+  end)
+end
+
+describe('md_to_vimdoc', function()
+  before_each(function()
+    helpers.clear()
+  end)
+
+  test('can render para after fenced code', {
+    '- Para1',
+    '  ```',
+    '  code',
+    '  ```',
+    '  Para2',
+  }, {
+    '• Para1 >',
+    '    code',
+    '<',
+    '  Para2',
+    '',
+  })
+
+  test('start_indent only applies to first line', {
+    'para1',
+    '',
+    'para2',
+  }, {
+    'para1',
+    '',
+    '          para2',
+    '',
+  }, 0, 10, 78)
+
+  test('inline 1', { '(`string`)' }, { '(`string`)', '' })
+end)