feat: support ---@{protected,package,public} (#71)

This adds support for `---@protected`, and `---@package` which act
precisely as `---@private`, which is already implemented, hiding any
node from the vimdoc. And `---@public` support, which gets parsed and
stripped away and doesn't affect vimdoc in any way.

Author: numToStr

emmylua.md

@@ -694,12 +694,18 @@ U.VMODE                                                                *U.VMODE*
 
 ### Private
 
-This tag can be used to discard any part of the code that is exported but it is not considered to be a part of the public API
+One of the following tags can be used to discard any part of the code that is not considered a part of the public API. All these tags behaves exactly same when it comes to vimdoc generation but have different use cases when used together with LLS.
+
+- Spec: [`---@private`](https://github.com/sumneko/lua-language-server/wiki/Annotations#private), [`---@protected`](https://github.com/sumneko/lua-language-server/wiki/Annotations#protected), [`---@package`](https://github.com/sumneko/lua-language-server/wiki/Annotations#package)
 
 - Syntax
 
 ```lua
 ---@private
+
+---@protected
+
+---@package
 ```
 
 - Input
@@ -719,9 +725,9 @@ function U.ok()
     print('Ok! I am exported')
 end
 
----@private
+---@protected
 function U.no_emmy()
-    print('Private func with no emmylua!')
+    print('Protected func with no emmylua!')
 end
 
 return U

src/lexer.rs

@@ -27,14 +27,15 @@ impl Lexer {
         let comment = till_eol.map(|(x, _)| x.iter().collect());
         let desc = space.ignore_then(comment).or_not();
 
-        let scope = choice((
-            keyword("public").to(Scope::Public),
-            keyword("protected").to(Scope::Protected),
-            keyword("private").to(Scope::Private),
-        ));
-
-        let private = just("private")
-            .then_ignore(newline())
+        let public = keyword("public").to(Scope::Public);
+        let private = keyword("private")
+            .to(Scope::Private)
+            .or(keyword("protected").to(Scope::Protected))
+            .or(keyword("package").to(Scope::Package));
+
+        let hidden = private
+            .clone()
+            .ignore_then(newline())
             .then_ignore(choice((
                 // eat up all the emmylua, if any, then one valid token
                 triple
@@ -181,7 +182,7 @@ impl Lexer {
         });
 
         let tag = just('@').ignore_then(choice((
-            private.to(TagType::Skip),
+            hidden.or(public.clone().ignored()).to(TagType::Skip),
             just("toc")
                 .ignore_then(space)
                 .ignore_then(comment)
@@ -226,7 +227,7 @@ impl Lexer {
                 .then(just(':').padded().ignore_then(ident()).or_not())
                 .map(|(name, parent)| TagType::Class(name, parent)),
             just("field")
-                .ignore_then(space.ignore_then(scope).or_not())
+                .ignore_then(space.ignore_then(private.or(public)).or_not())
                 .then_ignore(space)
                 .then(ident())
                 .then(optional)

src/lexer/token.rs

@@ -153,6 +153,7 @@ pub enum Scope {
     Public,
     Private,
     Protected,
+    Package,
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]

tests/basic.rs

@@ -676,9 +676,9 @@ fn private() {
         print('Ok! I am exported')
     end
 
-    ---@private
+    ---@protected
     function U.no_emmy()
-        print('Private func with no emmylua!')
+        print('Protected func with no emmylua!')
     end
 
     return U