feat: add checker for role with extra backtick (#139)

feat: add checker for detecting role with extra backtick

Author: mattwang44

sphinxlint/checkers.py

@@ -322,6 +322,19 @@ def check_role_with_double_backticks(file, lines, options=None):
             )
 
 
+@checker(".rst", ".po")
+def check_role_with_extra_backtick(filename, lines, options):
+    """Check for extra backtick in roles.
+
+    Bad:  :func:`foo``
+    Bad:  :func:``foo`
+    Good: :func:`foo`
+    """
+    for lno, line in enumerate(lines, start=1):
+        for match in rst.ROLE_WITH_EXTRA_BACKTICK_RE.finditer(line):
+            yield lno, f"Extra backtick in role: {match.group(0).strip()!r}"
+
+
 @checker(".rst", ".po")
 def check_missing_space_before_role(file, lines, options=None):
     """Search for missing spaces before roles.

sphinxlint/rst.py

@@ -252,6 +252,13 @@ def inline_markup_gen(start_string, end_string, extra_allowed_before=""):
 # :const:`None`
 DOUBLE_BACKTICK_ROLE_RE = re.compile(rf"(?<!``){ROLE_HEAD}``")
 
+# Find roles with extra backtick like:
+# :mod:`!cgi`` (extra backtick at the end)
+# :mod:``!cgi` (extra backtick at the beginning)
+ROLE_WITH_EXTRA_BACKTICK_RE = re.compile(
+    rf"({ROLE_HEAD}(?:``[^`\s]+`(?!\S)|`[^`\s]+``))(?!`)"
+)
+
 START_STRING_PREFIX = f"(^|(?<=\\s|[{OPENERS}{DELIMITERS}|]))"
 END_STRING_SUFFIX = f"($|(?=\\s|[\x00{CLOSING_DELIMITERS}{DELIMITERS}{CLOSERS}|]))"
 

tests/fixtures/xfail/role-with-extra-backtick.rst

@@ -0,0 +1,15 @@
+.. expect: Extra backtick in role: ':mod:`!cgi``' (role-with-extra-backtick)
+.. expect: Extra backtick in role: ':mod:``!cgitb`' (role-with-extra-backtick)
+.. expect: Extra backtick in role: ':func:`foo``' (role-with-extra-backtick)
+.. expect: Extra backtick in role: ':class:`MyClass``' (role-with-extra-backtick)
+.. expect: Extra backtick in role: ':meth:``method`' (role-with-extra-backtick)
+
+This file contains roles with extra backtick that should be detected.
+
+* :pep:`594`: Remove the :mod:`!cgi`` and :mod:``!cgitb` modules
+
+* :func:`foo`` should be :func:`foo`
+
+* :class:`MyClass`` is wrong
+
+* :meth:``method` should be fixed