Skip to content

chore!: better emmylua grammar support - #37

Merged
numToStr merged 1 commit into
masterfrom
grammar
Sep 11, 2022
Merged

chore!: better emmylua grammar support#37
numToStr merged 1 commit into
masterfrom
grammar

Conversation

@numToStr

@numToStr numToStr commented Sep 7, 2022 •
edited
Loading

Copy link
Copy Markdown
Owner

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

@numToStr
numToStr marked this pull request as draft September 7, 2022 08:49
@numToStr
numToStr marked this pull request as ready for review September 11, 2022 14:11
@numToStr
numToStr merged commit c430652 into master Sep 11, 2022
@numToStr
numToStr deleted the grammar branch September 11, 2022 14:17
@numToStr numToStr mentioned this pull request Sep 27, 2022
Merged
numToStr added a commit that referenced this pull request Sep 27, 2022
@numToStr
fix: bring back [desc] support in ---@type (#43)
d65f2a5 
This PR brings back `[desc]` support in `---@type` which was removed in
#37
@numToStr numToStr mentioned this pull request Oct 1, 2022
Closed
rmagatti added a commit to rmagatti/auto-session that referenced this pull request Nov 17, 2022
@rmagatti
Update docstrings to abide by new class syntax
6b42533 
Re:
numToStr/lemmy-help#37
@rmagatti rmagatti mentioned this pull request Nov 17, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

breaking!: grammar improvements and other changes

1 participant

@numToStr