Detect roles that start with !~ (#146)

* Detect roles that start with `!~`

* Fixup to detect `~!`

* Add preprocessing for regex

Co-authored-by: Hugo van Kemenade <[email protected]>

* Fix indent

Author: mushitoriami

sphinxlint/checkers.py

@@ -556,3 +556,20 @@ def check_unnecessary_parentheses(filename, lines, options):
     for lno, line in enumerate(lines, start=1):
         for match in rst.ROLE_WITH_UNNECESSARY_PARENTHESES_RE.finditer(line):
             yield lno, f"Unnecessary parentheses in {match.group(0).strip()!r}"
+
+
+@checker(".rst", ".po")
+def check_exclamation_and_tilde(file, lines, options):
+    """Check for roles that start with an exclamation mark and tilde (`!~`).
+
+    Bad:  :meth:`!~list.pop`
+    Good: :meth:`!pop`
+    """
+    for lno, line in enumerate(lines, start=1):
+        if not ("~" in line and "!" in line and "`" in line):
+            continue
+        for match in rst.ROLE_WITH_EXCLAMATION_AND_TILDE_RE.finditer(line):
+            yield (
+                lno,
+                f"Found a role with both `!` and `~` in {match.group(0).strip()!r}.",
+            )

sphinxlint/rst.py

@@ -291,3 +291,5 @@ def inline_markup_gen(start_string, end_string, extra_allowed_before=""):
 ROLE_MISSING_CLOSING_BACKTICK_RE = re.compile(rf"({ROLE_HEAD}`[^`]+?)[^`]*$")
 
 ROLE_WITH_UNNECESSARY_PARENTHESES_RE = re.compile(r"(^|\s):(func|meth):`[^`]+\(\)`")
+
+ROLE_WITH_EXCLAMATION_AND_TILDE_RE = re.compile(rf"{ROLE_HEAD}`[!~]{{2}}[^`]*`")

tests/fixtures/xfail/role-with-exclamation-and-tilde.rst

@@ -0,0 +1,7 @@
+.. expect: Found a role with both `!` and `~` in ':meth:`!~list.pop`'. (exclamation-and-tilde)
+.. expect: Found a role with both `!` and `~` in ':meth:`~!list.pop`'. (exclamation-and-tilde)
+
+:meth:`!~list.pop` cannot be used to display ``pop()`` and avoid
+reference warnings; instead, it renders as ``~list.pop()``.
+We should instead write :meth:`!pop` to correctly display ``pop()``.
+:meth:`~!list.pop` doesn’t work either.