sphinx-lua-ls 3.0.0__tar.gz → 3.1.0__tar.gz

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v3.1.0
+
+- Added pygments lexer for Lua that highlights documentation tags.
+
+- Added option to control maximum signature length before wrapping.
+
+- Sphinx's nitpicky mode will no longer emit warnings
+  for cross-references in signatures.
+
+- Fixed generation of URL anchors to avoid duplicates.
+
+- Fixed some edge cases in parsing of type expressions.
+
 ## v3.0.0
 
 - **Breaking change:** changed how `apidoc` generates file names to avoid collisions.
@@ -15,7 +28,7 @@
   - it exports way more metadata, including function overloads and class constructors,
   - you don't have to annotate modules with `@class` and `!doctype` anymore.
 
-  I plan to use EmmyLua as the default language server since *v3.0.0*.
+  I plan to use EmmyLua as the default language server since *v4.0.0*.
 
 - Long object signatures are now broken into multiple lines.
 

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/PKG-INFO

@@ -1,30 +1,9 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.0.0
+Version: 3.1.0
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2018 Tamika Nomara
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
+License-Expression: MIT
 Project-URL: Documentation, https://taminomara.github.io/sphinx-lua-ls/
 Project-URL: Issues, https://github.com/taminomara/sphinx-lua-ls/issues
 Project-URL: Source, https://github.com/taminomara/sphinx-lua-ls/
@@ -34,7 +13,6 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Intended Audience :: Developers
 Classifier: Framework :: Sphinx
 Classifier: Framework :: Sphinx :: Domain

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/docs/source/index.rst

@@ -6,7 +6,7 @@ based on `EmmyLua`_ or `LuaLs`_ language servers.
 
 .. _Lua: https://lua.org
 .. _EmmyLua: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
-.. _LuaLs: https://lua_ls.github.io/
+.. _LuaLs: https://luals.github.io/
 
 See an example output: `logging`.
 

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/docs/source/installation.rst

@@ -130,28 +130,43 @@ You'll need a Python installation and a Sphinx project to start with Sphinx-LuaL
 
             lua_ls_backend = "emmylua"
 
-         .. note::
-
-            If you're on Linux x64, Windows x64, or MacOs arm, Sphinx-LuaLs will
-            download EmmyLua's documentation tool automatically. Otherwise,
-            you'll need to install ``emmylua_doc_cli`` manually,
-            see `instructions at github`_.
-
          .. tip::
 
-            Add the following settings to your ``.emmyrc.json`` to enable completion
-            of documentation tags specific to Sphinx-LuaLs:
-
-            .. code-block:: json
-
-               {
-                  "diagnostics": {
-                     "enables": ["unknown-doc-tag"]
-                  },
-                  "doc": {
-                     "knownTags": ["doctype", "doc"]
-                  }
-               }
+            Add the following settings to your ``.emmyrc.json`` to enable syntax
+            highlighting and Go To Definition for comments:
+
+            .. tab-set::
+               :sync-group: lang
+
+               .. tab-item:: RST
+                  :sync: rst
+
+                  .. code-block:: json
+
+                     {
+                        "diagnostics": {
+                           "enables": ["unknown-doc-tag"]
+                        },
+                        "doc": {
+                           "knownTags": ["doctype", "doc"],
+                           "syntax": "rst"
+                        }
+                     }
+
+               .. tab-item:: Markdown
+                  :sync: md
+
+                  .. code-block:: json
+
+                     {
+                        "diagnostics": {
+                           "enables": ["unknown-doc-tag"]
+                        },
+                        "doc": {
+                           "knownTags": ["doctype", "doc"],
+                           "syntax": "myst"
+                        }
+                     }
 
       .. tab-item:: LuaLs
          :sync: luals

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/docs/source/quickstart.rst

@@ -85,6 +85,46 @@ and others to document module's contents.
             A sound that can be played by the sound board.
             ```
 
+   .. dropdown:: Setting up primary domain in EmmyLua
+
+      To enable accurate Go To Definition behavior for comments,
+      add ``rstPrimaryDomain`` setting to your ``.emmyrc.json``:
+
+      .. tab-set::
+         :sync-group: lang
+
+         .. tab-item:: RST
+            :sync: rst
+
+            .. code-block:: json
+
+               {
+                  "diagnostics": {
+                     "enables": ["unknown-doc-tag"]
+                  },
+                  "doc": {
+                     "knownTags": ["doctype", "doc"],
+                     "syntax": "rst",
+                     "rstPrimaryDomain": "lua"
+                  }
+               }
+
+         .. tab-item:: Markdown
+            :sync: md
+
+            .. code-block:: json
+
+               {
+                  "diagnostics": {
+                     "enables": ["unknown-doc-tag"]
+                  },
+                  "doc": {
+                     "knownTags": ["doctype", "doc"],
+                     "syntax": "myst",
+                     "rstPrimaryDomain": "lua"
+                  }
+               }
+
 
 Cross-referencing objects
 -------------------------
@@ -152,6 +192,46 @@ and :rst:role:`lua:class` roles:
 
             Reference to a {lua}`logging.Logger.info`.
 
+   .. dropdown:: Setting up default role in EmmyLua
+
+      To enable accurate Go To Definition behavior for comments,
+      add ``rstDefaultRole`` setting to your ``.emmyrc.json``:
+
+      .. tab-set::
+         :sync-group: lang
+
+         .. tab-item:: RST
+            :sync: rst
+
+            .. code-block:: json
+
+               {
+                  "diagnostics": {
+                     "enables": ["unknown-doc-tag"]
+                  },
+                  "doc": {
+                     "knownTags": ["doctype", "doc"],
+                     "syntax": "rst",
+                     "rstDefaultRole": "lua:obj"
+                  }
+               }
+
+         .. tab-item:: Markdown
+            :sync: md
+
+            .. code-block:: json
+
+               {
+                  "diagnostics": {
+                     "enables": ["unknown-doc-tag"]
+                  },
+                  "doc": {
+                     "knownTags": ["doctype", "doc"],
+                     "syntax": "myst",
+                     "rstDefaultRole": "lua:obj"
+                  }
+               }
+
 
 Automatic documentation generation
 ----------------------------------

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/docs/source/settings.rst

@@ -188,3 +188,15 @@ Settings
    :type: str
 
    Format for generated files. Can be either ``"rst"`` or ``"md"``.
+
+.. py:data:: lua_ls_maximum_signature_line_length
+   :type: int | None
+
+   Controls maximum width after which long signatures will be wrapped.
+
+   Default value is ``50``, which is suitable for most Sphinx themes.
+
+   Setting this value to `None` will cause signature formatter
+   to use Sphinx's global setting ``maximum_signature_line_length``.
+   If ``maximum_signature_line_length`` is also ``None``,
+   signature wrapping will be disabled.

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ authors = [{name = "Tamika Nomara", email = "taminomara@gmail.com"}]
 description = "Automatic documentation generation via EmmyLua/LuaLs"
 dynamic = ["version"]
 readme = "README.md"
-license = {file = "LICENSE"}
+license = "MIT"
 requires-python = ">=3.12"
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -12,7 +12,6 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
-    "License :: OSI Approved :: MIT License",
     "Intended Audience :: Developers",
     "Framework :: Sphinx",
     "Framework :: Sphinx :: Domain",

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/sphinx_lua_ls/__init__.py

@@ -3,7 +3,9 @@ import pathlib
 import re
 from typing import Any, Type, TypeVar
 
+import sphinx.addnodes
 import sphinx.application
+import sphinx.domains
 import sphinx.errors
 from sphinx.errors import ConfigError
 from sphinx.util import logging
@@ -19,6 +21,7 @@ import sphinx_lua_ls.intersphinx
 import sphinx_lua_ls.lua_ls
 import sphinx_lua_ls.objtree
 from sphinx_lua_ls._version import __version__, __version_tuple__
+from sphinx_lua_ls.pygments import LuaLexer
 
 _logger = logging.getLogger("sphinx_lua_ls")
 
@@ -254,6 +257,18 @@ def check_options(app: sphinx.application.Sphinx):
         config["lua_ls_class_default_force_return_self"],
         bool,
     )
+    if config["lua_ls_maximum_signature_line_length"] is not None:
+        domain.config["maximum_signature_line_length"] = _type(
+            "lua_ls_maximum_signature_line_length",
+            config["lua_ls_maximum_signature_line_length"],
+            int,
+        )
+    else:
+        domain.config["maximum_signature_line_length"] = _type(
+            "maximum_signature_line_length",
+            config["maximum_signature_line_length"],
+            (int, type(None)),
+        )
 
 
 def run_lua_ls(app: sphinx.application.Sphinx):
@@ -375,6 +390,15 @@ def copy_asset_files(app: sphinx.application.Sphinx, exc: Exception | None):
         copy_asset_file(custom_file, static_dir)
 
 
+def suppress_auto_ref_warnings(
+    app: sphinx.application.Sphinx,
+    domain: sphinx.domains.Domain,
+    node: sphinx.addnodes.pending_xref,
+):
+    if node["refdomain"] == "lua" and node["reftype"] == "_auto":
+        return True
+
+
 def setup(app: sphinx.application.Sphinx):
     app.add_domain(sphinx_lua_ls.domain.LuaDomain)
 
@@ -395,6 +419,7 @@ def setup(app: sphinx.application.Sphinx):
     app.add_config_value("lua_ls_class_default_function_name", "", rebuild="env")
     app.add_config_value("lua_ls_class_default_force_non_colon", False, rebuild="env")
     app.add_config_value("lua_ls_class_default_force_return_self", False, rebuild="env")
+    app.add_config_value("lua_ls_maximum_signature_line_length", 50, rebuild="env")
 
     app.add_directive_to_domain(
         "lua", "autoobject", sphinx_lua_ls.autodoc.AutoObjectDirective
@@ -413,10 +438,13 @@ def setup(app: sphinx.application.Sphinx):
     app.connect("builder-inited", run_apidoc)
     app.connect("missing-reference", sphinx_lua_ls.intersphinx.resolve_std_reference)
     app.connect("build-finished", copy_asset_files)
+    app.connect("warn-missing-reference", suppress_auto_ref_warnings)
 
     app.add_post_transform(sphinx_lua_ls.autoindex.AutoIndexTransform)
     app.add_post_transform(sphinx_lua_ls.inherited.InheritedMembersTransform)
 
+    app.add_lexer("lua", LuaLexer)
+
     app.add_css_file("lua.css")
 
     return {

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/sphinx_lua_ls/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '3.0.0'
-__version_tuple__ = version_tuple = (3, 0, 0)
+__version__ = version = '3.1.0'
+__version_tuple__ = version_tuple = (3, 1, 0)
+
+__commit_id__ = commit_id = 'g26ca4bce6'

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/sphinx_lua_ls/domain.py

@@ -25,7 +25,7 @@ from sphinx.roles import XRefRole
 from sphinx.util import logging
 from sphinx.util.docfields import TypedField
 from sphinx.util.docutils import SphinxDirective
-from sphinx.util.nodes import make_refnode
+from sphinx.util.nodes import make_id, make_refnode
 
 from sphinx_lua_ls import utils
 
@@ -39,8 +39,13 @@ logger = logging.getLogger("sphinx_lua_ls")
 
 
 class _SigWriter:
-    def __init__(self, signode: addnodes.desc_signature) -> None:
+    def __init__(
+        self,
+        signode: addnodes.desc_signature,
+        maximum_signature_line_length: int | None,
+    ) -> None:
         self._signode = signode
+        self._maximum_signature_line_length = maximum_signature_line_length
         signode["is_multiline"] = True
 
         self._line = addnodes.desc_signature_line(add_permalink=True)
@@ -98,7 +103,10 @@ class _SigWriter:
         estimated_len = sum(
             len(p[0]) + len(p[1]) + (1 if p[0] and p[1] else 0) for p in params
         ) + len(params)
-        multiline = estimated_len > 50
+        multiline = (
+            self._maximum_signature_line_length is not None
+            and estimated_len > self._maximum_signature_line_length
+        )
 
         if multiline and not parens:
             parens = ("(", ")")
@@ -140,7 +148,10 @@ class _SigWriter:
         inliner,
     ):
         estimated_len = sum(len(p) for p in params) + len(params)
-        multiline = estimated_len > 50
+        multiline = (
+            self._maximum_signature_line_length is not None
+            and estimated_len > self._maximum_signature_line_length
+        )
 
         if multiline and not parens:
             parens = ("(", ")")
@@ -422,10 +433,10 @@ class LuaObject(
         signode: addnodes.desc_signature,
     ) -> None:
         fullname, modname, classname, objname = name
-        anchor = utils.make_anchor(fullname)
-        if anchor not in self.state.document.ids:
-            signode["names"].append(anchor)
-            signode["ids"].append(anchor)
+        id = make_id(self.env, self.state.document, "lua", fullname)
+        if id not in self.state.document.ids:
+            signode["names"].append(id)
+            signode["ids"].append(id)
             signode["first"] = not self.names
             self.state.document.note_explicit_target(signode)
 
@@ -446,6 +457,7 @@ class LuaObject(
                 docname=self.env.docname,
                 objtype=self.objtype,
                 deprecated="deprecated" in self.options,
+                id=id,
                 synopsis=self.options.get("synopsis", None),
             )
 
@@ -503,9 +515,7 @@ class LuaObject(
         if "no-index-entry" not in self.options:
             indextext = self.get_index_text(fullname, modname, classname, objname)
             if indextext:
-                self.indexnode["entries"].append(
-                    ("single", indextext, anchor, "", None)
-                )
+                self.indexnode["entries"].append(("single", indextext, id, "", None))
 
     def _object_hierarchy_parts(
         self, sig_node: addnodes.desc_signature
@@ -549,6 +559,10 @@ class LuaObject(
         if self.names and self.allow_nesting:
             self.pop_context()
 
+    @property
+    def maximum_signature_line_length(self) -> int | None:
+        return self.env.domaindata["lua"]["config"]["maximum_signature_line_length"]
+
 
 class LuaFunction(
     LuaObject[
@@ -599,7 +613,7 @@ class LuaFunction(
             (generics, args, returns),
         ) = self.handle_signature_prefix(sig, signode)
 
-        sw = _SigWriter(signode)
+        sw = _SigWriter(signode, self.maximum_signature_line_length)
 
         if generics:
             sw.params(generics, ("<", ">"), False, self.state.inliner)
@@ -662,7 +676,7 @@ class LuaData(LuaObject[str]):
             sig, signode
         )
 
-        sw = _SigWriter(signode)
+        sw = _SigWriter(signode, self.maximum_signature_line_length)
 
         if typ:
             sw.punctuation(":")
@@ -719,7 +733,7 @@ class LuaAlias(LuaObject[tuple[list[tuple[str, str]], str]]):
             (generics, typ),
         ) = self.handle_signature_prefix(sig, signode)
 
-        sw = _SigWriter(signode)
+        sw = _SigWriter(signode, self.maximum_signature_line_length)
 
         if generics:
             sw.params(generics, ("<", ">"), False, self.state.inliner)
@@ -815,7 +829,7 @@ class LuaClass(
             (generics, bases, params, returns),
         ) = self.handle_signature_prefix(sig, signode)
 
-        sw = _SigWriter(signode)
+        sw = _SigWriter(signode, self.maximum_signature_line_length)
 
         if generics:
             sw.params(generics, ("<", ">"), False, self.state.inliner)
@@ -962,10 +976,14 @@ class LuaModule(SphinxDirective):
                     "use :no-index: for one of them",
                     line=self.lineno,
                 )
+
+            id = make_id(self.env, self.state.document, "lua", fullname)
+
             objects[fullname] = LuaDomain.ObjectEntry(
                 docname=self.env.docname,
                 objtype="module",
                 deprecated="deprecated" in self.options,
+                id=id,
                 synopsis=self.options.get("synopsis", None),
             )
 
@@ -1002,17 +1020,13 @@ class LuaModule(SphinxDirective):
                     LuaDomain.Entry(fullname=fullname, docname=self.env.docname)
                 )
 
-            target_node = nodes.target(
-                "", "", ids=[utils.make_anchor(fullname)], ismod=True
-            )
+            target_node = nodes.target("", "", ids=[id], ismod=True)
             self.state.document.note_explicit_target(target_node)
             # the platform and synopsis aren't printed; in fact, they are only
             # used in the modindex currently
             ret.append(target_node)
             indextext = _("%s (module)") % fullname
-            inode = addnodes.index(
-                entries=[("single", indextext, utils.make_anchor(fullname), "", None)]
-            )
+            inode = addnodes.index(entries=[("single", indextext, id, "", None)])
             ret.append(inode)
         return ret
 
@@ -1079,18 +1093,18 @@ class LuaDomain(Domain):
     name = "lua"
     label = "Lua"
     object_types: dict[str, ObjType] = {
-        "function": ObjType(_("function"), "func", "obj", "lua"),
-        "data": ObjType(_("data"), "data", "obj", "lua"),
-        "const": ObjType(_("const"), "attr", "const", "obj", "lua"),
-        "class": ObjType(_("class"), "class", "obj", "lua"),
-        "alias": ObjType(_("alias"), "alias", "obj", "lua"),
-        "enum": ObjType(_("enum"), "enum", "obj", "lua"),
-        "method": ObjType(_("method"), "meth", "obj", "lua"),
-        "classmethod": ObjType(_("class method"), "meth", "obj", "lua"),
-        "staticmethod": ObjType(_("static method"), "meth", "obj", "lua"),
-        "attribute": ObjType(_("attribute"), "attr", "obj", "lua"),
-        "table": ObjType(_("data"), "attr", "data", "obj", "lua"),
-        "module": ObjType(_("module"), "mod", "obj", "lua"),
+        "function": ObjType(_("function"), "func", "obj", "lua", "_auto"),
+        "data": ObjType(_("data"), "data", "obj", "lua", "_auto"),
+        "const": ObjType(_("const"), "attr", "const", "obj", "lua", "_auto"),
+        "class": ObjType(_("class"), "class", "obj", "lua", "_auto"),
+        "alias": ObjType(_("alias"), "alias", "obj", "lua", "_auto"),
+        "enum": ObjType(_("enum"), "enum", "obj", "lua", "_auto"),
+        "method": ObjType(_("method"), "meth", "obj", "lua", "_auto"),
+        "classmethod": ObjType(_("class method"), "meth", "obj", "lua", "_auto"),
+        "staticmethod": ObjType(_("static method"), "meth", "obj", "lua", "_auto"),
+        "attribute": ObjType(_("attribute"), "attr", "obj", "lua", "_auto"),
+        "table": ObjType(_("data"), "attr", "data", "obj", "lua", "_auto"),
+        "module": ObjType(_("module"), "mod", "obj", "lua", "_auto"),
     }
 
     directives = {
@@ -1120,6 +1134,7 @@ class LuaDomain(Domain):
         "mod": LuaXRefRole(),
         "obj": LuaXRefRole(),
         "lua": LuaXRefRole(),
+        "_auto": LuaXRefRole(),
     }
 
     @dataclass(slots=True)
@@ -1127,6 +1142,7 @@ class LuaDomain(Domain):
         docname: str
         objtype: str
         deprecated: bool
+        id: str
         synopsis: str | None
 
     @dataclass(slots=True)
@@ -1320,7 +1336,7 @@ class LuaDomain(Domain):
                 builder,
                 fromdocname,
                 data.docname,
-                utils.make_anchor(name),
+                data.id,
                 contnode,
                 name,
             )
@@ -1347,7 +1363,7 @@ class LuaDomain(Domain):
                         builder,
                         fromdocname,
                         data.docname,
-                        utils.make_anchor(name),
+                        data.id,
                         contnode,
                         name,
                     ),

{sphinx_lua_ls-3.0.0 → sphinx_lua_ls-3.1.0}/sphinx_lua_ls/lua_ls.py

@@ -446,6 +446,7 @@ def _check_version(
                 system_version_text,
                 type="lua-ls",
             )
+            return False, system_version_text
     except (subprocess.SubprocessError, OSError, UnicodeDecodeError):
         _logger.debug(
             "%s failed to print its version", bin_path, exc_info=True, type="lua-ls"
@@ -484,6 +485,16 @@ def _check_and_install(
                 type="lua-ls",
             )
             return pathlib.Path(system_bin_path).expanduser().resolve(), path
+        elif not install and system_version == "<Unknown>":
+            _logger.warning(
+                "found %s at %s, but its version is %r; "
+                "trying to use it anyway because lua_ls_auto_install=False",
+                bin_name,
+                system_bin_path,
+                system_version,
+                type="lua-ls",
+            )
+            return pathlib.Path(system_bin_path).expanduser().resolve(), path
     else:
         _logger.debug("pre-installed %s not found", bin_name, type="lua-ls")
 

sphinx_lua_ls-3.1.0/sphinx_lua_ls/pygments.py

@@ -0,0 +1,21 @@
+from pygments.lexer import bygroups, inherit
+from pygments.lexers.scripting import LuaLexer as _LuaLexer  # type: ignore
+from pygments.token import *  # type: ignore
+
+
+class LuaLexer(_LuaLexer):
+    tokens = {
+        "ws": [
+            (
+                r"(--\[(?P<level>=*)\[\s*)(@\w+)(.*?\](?P=level)\])",
+                bygroups(
+                    Comment.Multiline, None, Keyword.Comment, Comment.Multiline, None
+                ),
+            ),
+            (
+                r"(---\s*)(@\w+)(.*)$",
+                bygroups(Comment.Multiline, Keyword.Comment, Comment.Multiline),
+            ),
+            inherit,
+        ],
+    }