[IMP] Makefile: make review optional early break

Author: samueljlieber

Makefile

@@ -86,3 +86,8 @@ static: $(HTML_BUILD_DIR)/_static/style.css
 
 test:
 	@python tests/main.py $(SOURCE_DIR)/administration $(SOURCE_DIR)/applications $(SOURCE_DIR)/contributing $(SOURCE_DIR)/developer $(SOURCE_DIR)/services redirects
+
+review:
+	@read -p "Enter file or folder path: " path; read -p "Enter max line length: " line_length; \
+	if [ -z "$$path" ]; then echo "Error: Path cannot be empty"; exit 1; fi; \
+	python tests/main.py -e line-too-long -e early-line-breaks --max-line-length=$$line_length $$path

tests/checkers/rst_style.py

@@ -16,7 +16,9 @@
     '^(' + '|'.join(rf'\{char}+' for char in FORBIDDEN_HEADING_CHARS) + ')\n$'
 )
 GIT_CONFLICT_MARKERS = ['<' * 7, '>' * 7]
-
+ALLOWED_EARLY_BREAK_CHARS_RE = re.compile(
+    r'^\s*(\.\. |:\S+:\s+)', re.IGNORECASE
+) # Matches lines containing directives ('.. directive::' or ':directive:'), allowed to break early.
 
 @sphinxlint.checker('.rst')
 def check_heading_delimiters_characters(file, lines, options=None):
@@ -109,3 +111,45 @@ def check_git_conflict_markers(file, lines, options=None):
     for lno, line in enumerate(lines):
         if any(marker in line for marker in GIT_CONFLICT_MARKERS):
             yield lno + 1, "the git conflict should be resolved"
+
+
+@sphinxlint.checker('.rst', enabled=False, rst_only=True)
+def check_early_line_breaks(file, lines, options=None):
+    """ Optional - Checks that all lines dont break early per options.max_line_length param """
+    def is_valid_line(line, type):
+        """ Allowed to break early - handle tables and bullets """
+        if type == 1:
+            return not ALLOWED_EARLY_BREAK_CHARS_RE.search(line) \
+                and not HEADING_DELIMITER_RE.search(line) \
+                and not line.startswith("\n") \
+                and not line.lstrip().startswith(("+", "|", "- ", "* ", "#. ")) \
+                and len(line) <= options.max_line_length
+        if type == 0:
+            return not ALLOWED_EARLY_BREAK_CHARS_RE.search(line) \
+                and not HEADING_DELIMITER_RE.search(line) \
+                and not line.startswith("\n") \
+                and not line.lstrip().startswith(("+", "|")) \
+                and len(line) <= options.max_line_length
+    def get_next_line_first_word(next_line):
+        """ Return the first word of the next line """
+        if next_line.startswith(" "):
+            next_line_dict = {
+                "*": lambda x: x.split("* ", 1)[0],
+                "-": lambda x: x.split("- ", 1)[0],
+                "#.": lambda x: x.split("#. ", 1)[0],
+                "default": lambda x: x.split(" ", 1)[0]
+            }
+            return next_line_dict.get(
+                next_line.lstrip()[:2], next_line_dict["default"]
+            )(next_line.lstrip())
+        else:
+            return next_line.split(" ", 1)[0]
+
+    for lno, current_line in enumerate(lines):
+        if lno + 1 < len(lines):
+            next_line = lines[lno + 1]
+            if is_valid_line(current_line, 0) and is_valid_line(next_line, 1):
+                current_line_remaining_space = options.max_line_length - len(current_line)
+                next_line_first_word = get_next_line_first_word(next_line)
+                if current_line_remaining_space > len(next_line_first_word):
+                    yield lno + 1, f"Consider moving \"{next_line_first_word}\" to line {lno + 1}."

tests/main.py

@@ -52,6 +52,7 @@ def run_additional_checks(argv=None):
 
 Optional checkers:
 - line-too-long: Check for line length; this checker is not run by default.
+- early-line-break: Check for early line breaks; this checker is not run by default.
 
 Custom checkers:
 - all the checkers defined in checkers/* files