Markdown-Checker 1.2.0__tar.gz → 1.2.1__tar.gz

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-checker
-Version: 1.2.0
+Version: 1.2.1
 Summary: A markdown link validation reporting tool.
 Author-email: John Aziz <johnaziz269@gmail.com>
 Maintainer-email: John Aziz <johnaziz269@gmail.com>
@@ -87,7 +87,7 @@ Run this tool within a GitHub workflow using the
 GitHub Action, which posts the report as a pull request comment:
 
 ```yaml
-- uses: john0isaac/action-check-markdown@v1.1.0
+- uses: john0isaac/action-check-markdown@v1.2.0
   with:
     github-token: ${{ secrets.GITHUB_TOKEN }}
     command: check_broken_paths

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/README.md

@@ -58,7 +58,7 @@ Run this tool within a GitHub workflow using the
 GitHub Action, which posts the report as a pull request comment:
 
 ```yaml
-- uses: john0isaac/action-check-markdown@v1.1.0
+- uses: john0isaac/action-check-markdown@v1.2.0
   with:
     github-token: ${{ secrets.GITHUB_TOKEN }}
     command: check_broken_paths

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/docs/howto/github-actions.rst

@@ -34,15 +34,15 @@ replacing ``guide-url`` with the URL of your own contribution guide:
           pull-requests: write
           contents: read
         steps:
-          - uses: actions/checkout@v4
-          - uses: john0isaac/action-check-markdown@v1.1.0
+          - uses: actions/checkout@v7
+          - uses: john0isaac/action-check-markdown@v1.2.0
             with:
               github-token: ${{ secrets.GITHUB_TOKEN }}
               command: check_broken_paths
               directory: ./
               guide-url: "https://github.com/<owner>/<repo>/blob/main/CONTRIBUTING.md"
 
-The ``command`` input selects which check to run. As of v1.1.0 the action
+The ``command`` input selects which check to run. As of v1.2.0 the action
 supports ``check_broken_paths``, ``check_paths_tracking``,
 ``check_urls_tracking``, and ``check_urls_locale`` - **not**
 ``check_broken_urls``. Add a separate job (or step) per command if you want
@@ -64,8 +64,8 @@ annotations on the PR diff, the same way the action's output does:
         permissions:
           contents: read
         steps:
-          - uses: actions/checkout@v4
-          - uses: actions/setup-python@v5
+          - uses: actions/checkout@v7
+          - uses: actions/setup-python@v6
             with:
               python-version: "3.11"
           - run: pip install markdown-checker

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/docs/reference/report-formats.rst

@@ -46,7 +46,7 @@ A structured document including both errors and warnings:
 .. code-block:: json
 
     {
-      "tool": {"name": "markdown-checker", "version": "1.2.0"},
+      "tool": {"name": "markdown-checker", "version": "1.2.1"},
       "check": "check_broken_urls",
       "summary": {
         "files_checked": 10,

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/pyproject.toml

@@ -88,7 +88,7 @@ default-groups = ["dev", "pre-commit", "tests", "typing"]
 
 [tool.ruff]
 line-length = 120
-target-version = "py310"
+target-version = "py311"
 src = ["src"]
 fix = true
 show-fixes = true

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/src/markdown_checker/__init__.py

@@ -2,7 +2,7 @@
 markdown-checker - a markdown link validation reporting tool.
 """
 
-__version__ = "1.2.0"
+__version__ = "1.2.1"
 
 from markdown_checker.cli import main
 from markdown_checker.models import Config

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/src/markdown_checker/models/url.py

@@ -2,7 +2,7 @@ import email.utils
 import time
 from dataclasses import dataclass
 from datetime import datetime
-from datetime import timezone
+from datetime import UTC
 from typing import Literal
 from urllib.parse import ParseResult
 from urllib.parse import urlparse
@@ -65,7 +65,7 @@ def _retry_after_delay(response: httpx2.Response, fallback: int) -> float | None
         # Try HTTP-date format (e.g. "Wed, 21 Oct 2015 07:28:00 GMT").
         try:
             dt: datetime = email.utils.parsedate_to_datetime(header)
-            now: datetime = datetime.now(timezone.utc)
+            now: datetime = datetime.now(UTC)
             delay: float = (dt - now).total_seconds()
             return max(0.0, delay)
         except Exception:

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/src/markdown_checker/reports/renderers/annotations.py

@@ -12,9 +12,10 @@ from markdown_checker.reports.model import ReportIssue
 
 def _annotation_line(issue: ReportIssue) -> str:
     level = "warning" if issue.level == "warning" else "error"
+    file_path = issue.file_path.as_posix()
     return (
-        f"::{level} file={issue.file_path},line={issue.line_number}::"
-        f"File {issue.file_path}, line {issue.line_number}, "
+        f"::{level} file={file_path},line={issue.line_number}::"
+        f"File {file_path}, line {issue.line_number}, "
         f"Link {issue.link} {issue.message}."
     )
 

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/src/markdown_checker/reports/renderers/markdown.py

@@ -69,7 +69,7 @@ class MarkdownRenderer(ReportRenderer):
     def _file_link(self, file_path: Path, context: ReportContext) -> str | None:
         if context.output_mode == "ci":
             return _repo_file_link(context.repo_url, file_path) if context.repo_url else None
-        return str(file_path)
+        return file_path.as_posix()
 
     def _format_issue_rows(self, issues: tuple[ReportIssue, ...], context: ReportContext) -> str:
         parts: list[str] = ["<table><thead><tr><th>#</th><th>Link</th><th>Line Number</th></tr></thead><tbody>"]
@@ -94,9 +94,9 @@ class MarkdownRenderer(ReportRenderer):
             file_link = self._file_link(file_report.file_path, context)
             issue_rows = self._format_issue_rows(file_report.errors, context)
             if file_link is None:
-                rows.append(f"| `{file_report.file_path}` |" + issue_rows)
+                rows.append(f"| `{file_report.file_path.as_posix()}` |" + issue_rows)
             else:
-                rows.append(f"| [`{file_report.file_path}`]({file_link}) |" + issue_rows)
+                rows.append(f"| [`{file_report.file_path.as_posix()}`]({file_link}) |" + issue_rows)
         return "| File Full Path | Issues |\n|--------|--------|\n" + "".join(rows)
 
     def render(self, report: Report) -> str:

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/tests/reports/conftest.py

@@ -32,5 +32,5 @@ def sample_report():
             ),
         ),
     )
-    context = ReportContext(check_name="check_broken_urls", tool_version="1.2.0")
+    context = ReportContext(check_name="check_broken_urls", tool_version="1.2.1")
     return Report(context=context, files=(file_report,), links_checked=2, files_checked=1)

markdown_checker-1.2.1/tests/reports/renderers/test_annotations.py

@@ -0,0 +1,35 @@
+from pathlib import PureWindowsPath
+
+from markdown_checker.reports.model import FileReport
+from markdown_checker.reports.model import Report
+from markdown_checker.reports.model import ReportContext
+from markdown_checker.reports.model import ReportIssue
+from markdown_checker.reports.renderers.annotations import GitHubAnnotationsRenderer
+
+
+def test_github_annotations_renderer_formats_errors_and_warnings(sample_report):
+    """GitHubAnnotationsRenderer emits one ::error/::warning line per issue."""
+    result = GitHubAnnotationsRenderer().render(sample_report)
+    assert "::error file=docs/usage.rst,line=42::" in result
+    assert "::warning file=docs/usage.rst,line=7::" in result
+
+
+def test_github_annotations_renderer_render_lines_levels(sample_report):
+    """render_lines returns (text, level) pairs matching issue levels."""
+    lines = GitHubAnnotationsRenderer().render_lines(sample_report)
+    levels = {level for _, level in lines}
+    assert levels == {"error", "warning"}
+
+
+def test_github_annotations_renderer_windows_path_uses_forward_slashes():
+    """A Windows-style file path is rendered with forward slashes in the `file=` annotation
+    field, so GitHub can correctly link the annotation back to the file."""
+    file_path = PureWindowsPath(r"content\6502_Assembly_Code\README.md")
+    issue = ReportIssue(link="./missing.md", line_number=3, file_path=file_path, message="is broken", level="error")
+    report = Report(
+        context=ReportContext(check_name="check_broken_paths", output_mode="ci"),
+        files=(FileReport(file_path=file_path, errors=(issue,)),),
+    )
+    result = GitHubAnnotationsRenderer().render(report)
+    assert "file=content/6502_Assembly_Code/README.md,line=3" in result
+    assert "\\" not in result

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/tests/reports/renderers/test_json.py

@@ -16,7 +16,7 @@ def test_json_renderer_produces_valid_json(sample_report):
 def test_json_renderer_includes_tool_version(sample_report):
     """JsonRenderer includes tool metadata from the report context."""
     data = json.loads(JsonRenderer().render(sample_report))
-    assert data["tool"]["version"] == "1.2.0"
+    assert data["tool"]["version"] == "1.2.1"
 
 
 def test_json_renderer_respects_custom_indent(sample_report):

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/tests/reports/renderers/test_markdown.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+from pathlib import PureWindowsPath
 
 import pytest
 
@@ -190,6 +191,28 @@ def test_issues_table_ci_mode_with_repo_url_has_clickable_links(two_errors):
     assert "[`file.md`](https://github.com/owner/repo/blob/sha/file.md)" in result
 
 
+def test_issues_table_local_mode_windows_path_uses_forward_slashes():
+    """A Windows-style file path is rendered with forward slashes, not backslashes, so the
+    link resolves correctly when viewed on GitHub (backslashes get percent-encoded there)."""
+    file_path = PureWindowsPath(r"content\6502_Assembly_Code\README.md")
+    issue = ReportIssue(link="./missing.md", line_number=1, file_path=file_path, message="is broken", level="error")
+    context = ReportContext(check_name="check_broken_paths", output_mode="local")
+    files = (_errors_file_report(file_path, (issue,)),)
+    result = MarkdownRenderer()._format_issues_table(files, context)
+    assert "[`content/6502_Assembly_Code/README.md`](content/6502_Assembly_Code/README.md)" in result
+    assert "\\" not in result
+
+
+def test_issue_rows_local_mode_windows_path_uses_forward_slashes():
+    """The per-issue line-number link also uses forward slashes for a Windows-style path."""
+    file_path = PureWindowsPath(r"content\6502_Assembly_Code\README.md")
+    issue = ReportIssue(link="./missing.md", line_number=5, file_path=file_path, message="is broken", level="error")
+    context = ReportContext(check_name="check_broken_paths", output_mode="local")
+    result = MarkdownRenderer()._format_issue_rows((issue,), context)
+    assert "content/6502_Assembly_Code/README.md#L5" in result
+    assert "\\" not in result
+
+
 def test_issues_table_skips_files_without_errors(two_errors):
     """Files with only warnings (no errors) are omitted from the table."""
     context = ReportContext(check_name="check_broken_urls")

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/tests/test_cli.py

@@ -138,7 +138,7 @@ def test_cli_version(runner):
     """Displays version information."""
     result = runner.invoke(main, ["--version"])
     assert result.exit_code == 0
-    assert "1.2.0" in result.output
+    assert "1.2.1" in result.output
 
 
 def test_cli_ci_mode(runner, resources_dir, monkeypatch, tmp_path):

markdown_checker-1.2.0/tests/reports/renderers/test_annotations.py

@@ -1,15 +0,0 @@
-from markdown_checker.reports.renderers.annotations import GitHubAnnotationsRenderer
-
-
-def test_github_annotations_renderer_formats_errors_and_warnings(sample_report):
-    """GitHubAnnotationsRenderer emits one ::error/::warning line per issue."""
-    result = GitHubAnnotationsRenderer().render(sample_report)
-    assert "::error file=docs/usage.rst,line=42::" in result
-    assert "::warning file=docs/usage.rst,line=7::" in result
-
-
-def test_github_annotations_renderer_render_lines_levels(sample_report):
-    """render_lines returns (text, level) pairs matching issue levels."""
-    lines = GitHubAnnotationsRenderer().render_lines(sample_report)
-    levels = {level for _, level in lines}
-    assert levels == {"error", "warning"}

{markdown_checker-1.2.0 → markdown_checker-1.2.1}/src/markdown_checker/utils/pyproject_config.py

@@ -3,11 +3,11 @@ Module to load CLI defaults from ``[tool.markdown-checker]`` in ``pyproject.toml
 """
 
 import difflib
+import tomllib
 from pathlib import Path
 from typing import Any
 
 import click
-import tomllib
 
 SECTION = "markdown-checker"