chore!: better emmylua grammar support

[numToStr]

Resolve #34

Changes

These changes make lemmy-help compliant to https://github.com/sumneko/lua-language-server/wiki/Annotations

1. Removed [desc] from ---@type Reverted in fix: bring back [desc] support in ---@type #43

Details

• Prev

---@type <type> [desc]

• Now

---@type <type>

Alternative would be to write description above ---@type

2. Removed [desc] from ---@class

• Prev

---@class <name> [desc]

• Now

---@class <name>

See 3. for alternative

3. Treat comments above ---@class as description

• Emmylua

---This can be used as description for the class
---You can also have multiple lines
---@class HelloWorld
---@field msg string A message to the world

• Help

HelloWorld                                                          *HelloWorld*
    This can be used as description for the class
    You can also have multiple lines

    Fields: ~
        {msg}  (string)  A message to the world

4. Remove [desc] from ---@alias

• Prev

---@alias <name> <type> [desc]

• Now

---@alias <name> <type>

See 5. for alternative

5. Treat comments above ---@alias as description

• Emmylua

---This can be used as description for the alias
---You can also have multiple lines
---@alias HelloWorld string

• Help

HelloWorld                                                          *HelloWorld*
    This can be used as description for the alias
    You can also have multiple lines

    Type: ~
        string

6. Strict parsing of enum (---@alias) variants. Previously variants were loosely parsed and doesn't followed the LLS spec but now this has changed.

• Value should be defined inside single quotes i.e., '<value>'.

• Description should start with #<space>

• Syntax

---@alias <name>
---| '<value>' [# desc]

• Emmylua

---Vim operator-mode motions.
---Read `:h map-operator`
---@alias VMode
---| '"line"' # Vertical motion
---| '"char"' # Horizontal motion
---| 'v'
---| 'V' # Visual Line Mode

• Help

VMode                                                                    *VMode*
    Vim operator-mode motions.
    Read `:h map-operator`

    Variants: ~
        ("line")  Vertical motion
        ("char")  Horizontal motion
        (v)
        (V)       Visual Line Mode