Skip to content

Commit

Permalink
fix: luadoc defs
Browse files Browse the repository at this point in the history
  • Loading branch information
tris203 committed May 5, 2024
1 parent ee3f8a6 commit f1f6b48
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions lua/precognition/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,35 @@ local vm = require("precognition.vertical_motions")

local M = {}

---@alias SupportedHints "'^'" | "'b'" | "'w'" | "'$'"
---@alias SupportedHints "^" | "$" | "w" | "e" | "b"
---@alias SupportedGutterHints "G" | "gg" | "{" | "}"

---@class HintOpts
---@field text string
---@field prio integer

---@class HintConfig
---@field w HintOpts
---@field e HintOpts
---@field b HintOpts
---@field ["^"] HintOpts
---@field ["$"] HintOpts

---@class GutterHintConfig
---@field G HintOpts
---@field gg HintOpts
---@field ["{"] HintOpts
---@field ["}"] HintOpts

---@class Precognition.Config
---@field startVisible boolean
---@field hints { SupportedHints: { text: string, prio: integer } }
---@field gutterHints { SupportedGutterHints: { text: string, prio: integer } }
---@field hints HintConfig
---@field gutterHints GutterHintConfig

---@class Precognition.PartialConfig
---@field startVisible? boolean
---@field hints? { SupportedHints: { text: string, prio: integer } }
---@field gutterHints? { SupportedGutterHints: { text: string, prio: integer } }
---@field hints? HintConfig
---@field gutterHints? GutterHintConfig

---@alias Precognition.VirtLine { SupportedHints: integer | nil }

Expand Down

0 comments on commit f1f6b48

Please sign in to comment.