Add check for dangling hyphens (#56)

Co-authored-by: Jelle Zijlstra <[email protected]>

Author: hugovk

sphinxlint/checkers.py

@@ -447,3 +447,12 @@ def check_block(block_lineno, block):
 
     list(hide_non_rst_blocks(lines, hidden_block_cb=check_block))
     yield from errors
+
+
+@checker(".rst", rst_only=True)
+def check_dangling_hyphen(file, lines, options):
+    """Check for lines ending in a hyphen."""
+    for lno, line in enumerate(lines):
+        stripped_line = line.rstrip("\n")
+        if re.match(r".*[a-z]-$", stripped_line):
+            yield lno + 1, f"Line ends with dangling hyphen"

sphinxlint/rst.py

@@ -71,7 +71,7 @@
     'cmdoption', 'cmember', 'confval', 'cssclass', 'ctype',
     'currentmodule', 'cvar', 'data', 'decorator', 'decoratormethod',
     'deprecated-removed', 'deprecated(?!-removed)', 'describe', 'directive',
-    'doctest', 'envvar', 'event', 'exception', 'function', 'glossary',
+    'envvar', 'event', 'exception', 'function', 'glossary',
     'highlight', 'highlightlang', 'impl-detail', 'index', 'literalinclude',
     'method', 'miscnews', 'module', 'moduleauthor', 'opcode', 'pdbcommand',
     'program', 'role', 'sectionauthor', 'seealso',
@@ -86,7 +86,7 @@
     'restructuredtext-test-directive', 'role', 'rubric', 'sectnum', 'table',
     'target-notes', 'title', 'unicode',
     # Sphinx and Python docs custom ones
-    'productionlist', 'code-block',
+    'code-block', 'doctest', 'productionlist',
 ]
 
 # fmt: on

tests/fixtures/xfail/dangling-hyphen.rst

@@ -0,0 +1,5 @@
+.. expect: Line ends with dangling hyphen (dangling-hyphen)
+
+Additionally, this PEP requires that the default class definition
+namespace be ordered (e.g. ``OrderedDict``) by default.  The long-
+lived class namespace (``__dict__``) will remain a ``dict``.

tests/fixtures/xpass/dangling-hyphen.rst

@@ -0,0 +1,22 @@
+Additionally, this PEP requires that the default class definition
+namespace be ordered (e.g. ``OrderedDict``) by default.  The
+long-lived class namespace (``__dict__``) will remain a ``dict``.
+
+::
+
+    Traceback (most recent call last):
+        File "<pyshell#6>", line 1, in -toplevel-
+            d.pop()
+    IndexError: pop from an empty deque
+
+.. doctest::
+
+   >>> setcontext(ExtendedContext)
+   >>> Decimal(1) / Decimal(0)
+   Decimal('Infinity')
+   >>> getcontext().traps[DivisionByZero] = 1
+   >>> Decimal(1) / Decimal(0)
+   Traceback (most recent call last):
+     File "<pyshell#112>", line 1, in -toplevel-
+       Decimal(1) / Decimal(0)
+   DivisionByZero: x / 0

tests/test_filter_out_literal.py

@@ -28,6 +28,11 @@ def enumerate(sequence, start=0):
    Yet this line should not be dropped.
 
 This one neither.
+
+.. doctest::
+
+   >>> # This should be dropped
+   >>> setcontext(ExtendedContext)
 """
 
 
@@ -58,6 +63,11 @@ def enumerate(sequence, start=0):
    Yet this line should not be dropped.
 
 This one neither.
+
+.. doctest::
+
+
+
 """
 
 

tests/test_xpass_friends.py

@@ -1,6 +1,6 @@
 """This test needs `download-more-tests.sh`.
 
-This is usefull to avoid a sphinx-lint release to break many CIs.
+This is useful to avoid a sphinx-lint release to break many CIs.
 """
 
 from pathlib import Path
@@ -16,7 +16,7 @@
 
 @pytest.mark.parametrize(
     "file",
-    [str(f) for f in (FIXTURE_DIR / "friends").iterdir()]
+    [str(f) for f in (FIXTURE_DIR / "friends").iterdir() if f.name != ".DS_Store"]
     if (FIXTURE_DIR / "friends").is_dir()
     else [],
 )