feat: allow desc in ---@alias enum (#18)

numToStr · Jun 28, 2022 · d902592 · d902592
1 parent c906714
commit d902592
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/src/parser/tags/alias.rs b/src/parser/tags/alias.rs
@@ -13,7 +13,7 @@ pub struct TypeDef {
 #[derive(Debug, Clone)]
 pub enum AliasKind {
     Type(TypeDef),
-    Enum(Vec<TypeDef>),
+    Enum(Vec<String>, Vec<TypeDef>),
 }
 
 #[derive(Debug, Clone)]
@@ -35,14 +35,11 @@ parser!(Alias, {
             },
         },
         select! { TagType::Alias { name, .. } => name }
-            .then(
-                select! { TagType::Variant(ty, desc) => TypeDef { ty, desc } }
-                    .repeated()
-                    .map(AliasKind::Enum),
-            )
-            .map(|(name, kind)| Self {
+            .then(select! { TagType::Comment(x) => x }.repeated())
+            .then(select! { TagType::Variant(ty, desc) => TypeDef { ty, desc } }.repeated())
+            .map(|((name, desc), variants)| Self {
                 name,
-                kind,
+                kind: AliasKind::Enum(desc, variants),
                 prefix: Prefix::default(),
             }),
     ))
@@ -71,7 +68,8 @@ impl Display for Alias {
                 description!(f, "Type: ~")?;
                 writeln!(f, "{:>w$}", ty, w = 8 + ty.len())?;
             }
-            AliasKind::Enum(variants) => {
+            AliasKind::Enum(desc, variants) => {
+                description!(f, &desc.join("\n"))?;
                 writeln!(f)?;
                 description!(f, "Variants: ~")?;
 

diff --git a/tests/basic.rs b/tests/basic.rs
@@ -335,6 +335,7 @@ fn alias_and_type() {
     ---@alias Lines string[] All the lines in the buffer
 
     ---@alias VMode
+    ---Vim operator-mode motions. Read `:h map-operator`
     ---| 'line' Vertical motion
     ---| 'char' Horizontal motion
     ---| 'v'
@@ -379,6 +380,7 @@ Lines                                                                    *Lines*
 
 
 VMode                                                                    *VMode*
+    Vim operator-mode motions. Read `:h map-operator`
 
     Variants: ~
         ('line')  Vertical motion

diff --git a/tests/test.lua b/tests/test.lua
@@ -129,6 +129,7 @@ end
 -- You can define a (psuedo) enum using `alias`
 
 ---@alias VMode
+---Vim operator-mode motions. Read `:h map-operator`
 ---| 'line' Vertical motion
 ---| 'char' Horizontal motion
 ---| 'v'