Markdown-Checker 1.0.0__tar.gz → 1.0.1__tar.gz

{markdown_checker-1.0.0/src/markdown_checker.egg-info → markdown_checker-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-checker
-Version: 1.0.0
+Version: 1.0.1
 Summary: A markdown link validation reporting tool.
 Author-email: John Aziz <johnaziz269@gmail.com>
 Maintainer-email: John Aziz <johnaziz269@gmail.com>

{markdown_checker-1.0.0 → markdown_checker-1.0.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "markdown-checker"
 description= "A markdown link validation reporting tool."
-version = "1.0.0"
+version = "1.0.1"
 authors = [{ name = "John Aziz", email = "johnaziz269@gmail.com" }]
 maintainers = [{ name = "John Aziz", email = "johnaziz269@gmail.com" }]
 license = {file = "LICENSE"}
@@ -86,7 +86,7 @@ filterwarnings = ["ignore::DeprecationWarning"]
 show_missing = true
 
 [project.scripts]
-markdown-checker = "markdown_checker:main_with_spinner"
+markdown-checker = "markdown_checker:main"
 
 [build-system]
 requires = ["setuptools", "wheel"]

markdown_checker-1.0.1/src/markdown_checker/__init__.py

@@ -0,0 +1,10 @@
+"""
+markdown-checker — a markdown link validation reporting tool.
+"""
+
+__version__ = "1.0.1"
+
+from markdown_checker.cli import main
+from markdown_checker.models import Config, MarkdownLinkBase, MarkdownPath, MarkdownURL
+
+__all__ = ["Config", "main", "MarkdownLinkBase", "MarkdownPath", "MarkdownURL", "__version__"]

{markdown_checker-1.0.0 → markdown_checker-1.0.1}/src/markdown_checker/checker.py

@@ -1,3 +1,4 @@
+from collections.abc import Callable
 from dataclasses import dataclass, field
 from pathlib import Path
 
@@ -51,6 +52,7 @@ def run_check_on_files(
     func: str,
     files_paths: list[Path],
     config: Config,
+    progress_callback: Callable[[], None],
 ) -> CheckResult:
     """
     Run a named check across multiple files.
@@ -59,6 +61,7 @@ def run_check_on_files(
         func: Name of the check to run (must be a key in REGISTRY).
         files_paths: List of markdown file paths to check.
         config: Runtime configuration for the check.
+        progress_callback: Callback invoked after each file is checked.
 
     Returns:
         A CheckResult with per-file issues and total links checked.
@@ -74,5 +77,6 @@ def run_check_on_files(
         result.links_checked += links_count
         if detected_issues:
             result.issues.append((file_path, detected_issues))
+        progress_callback()
 
     return result

{markdown_checker-1.0.0 → markdown_checker-1.0.1}/src/markdown_checker/cli.py

@@ -9,7 +9,6 @@ from markdown_checker.models.config import Config
 from markdown_checker.reports.format_output import format_issues_table
 from markdown_checker.reports.markdown import MarkdownGenerator
 from markdown_checker.utils.list_files import get_files_paths_list
-from markdown_checker.utils.spinner import spinner
 
 
 class ListOfStrings(click.Option):
@@ -32,12 +31,19 @@ class ListOfStrings(click.Option):
 
 
 @click.command()
+@click.argument(
+    "src",
+    nargs=-1,
+    type=click.Path(path_type=Path, exists=True, file_okay=True, dir_okay=True, readable=True),
+    metavar="SRC ...",
+    required=False,
+)
 @click.option(
     "-d",
     "--dir",
     type=click.Path(path_type=Path, exists=True, file_okay=False, dir_okay=True, readable=True),
     help="Path to the root directory to check.",
-    required=True,
+    required=False,
 )
 @click.option(
     "-f",
@@ -113,7 +119,7 @@ class ListOfStrings(click.Option):
     "-to",
     "--timeout",
     type=click.IntRange(0, 50),
-    default=15,
+    default=20,
     help="Timeout in seconds for the requests.",
     required=False,
 )
@@ -139,7 +145,8 @@ class ListOfStrings(click.Option):
 @click.pass_context
 def main(
     ctx: click.Context,
-    dir: Path,
+    src: tuple[Path, ...],
+    dir: Path | None,
     func: str,
     guide_url: str | None,
     extensions: list[str],
@@ -152,7 +159,18 @@ def main(
     output_file_name: str,
 ) -> None:
     """A markdown link validation reporting tool."""
-    _, files_paths = get_files_paths_list(dir, extensions)
+    if src:
+        files_paths = []
+        for p in src:
+            if p.is_dir():
+                _, dir_files = get_files_paths_list(p, extensions)
+                files_paths.extend(dir_files)
+            elif p.suffix.lower() in extensions:
+                files_paths.append(p)
+    elif dir is not None:
+        _, files_paths = get_files_paths_list(dir, extensions)
+    else:
+        raise click.UsageError("Either SRC or --dir must be provided.")
 
     # remove files from skip_files list
     files_paths = [file_path for file_path in files_paths if file_path.name not in skip_files]
@@ -166,11 +184,13 @@ def main(
         output_mode="ci" if os.getenv("CI", "false") == "true" else "local",
     )
 
-    check_result = run_check_on_files(
-        func=func,
-        files_paths=files_paths,
-        config=config,
-    )
+    with click.progressbar(length=len(files_paths), label="Checking", hidden=config.output_mode == "ci") as bar:
+        check_result = run_check_on_files(
+            func=func,
+            files_paths=files_paths,
+            config=config,
+            progress_callback=lambda: bar.update(1),
+        )
 
     click.echo(
         click.style(f"\n🔍 Checked {check_result.links_checked} links in {len(files_paths)} files.", fg="blue"),
@@ -209,8 +229,3 @@ def main(
 
     click.echo(click.style("All files are compliant with the guidelines. 🎉", fg="green"), err=False)
     ctx.exit(0)
-
-
-def main_with_spinner() -> None:
-    with spinner():
-        main()

{markdown_checker-1.0.0 → markdown_checker-1.0.1/src/markdown_checker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-checker
-Version: 1.0.0
+Version: 1.0.1
 Summary: A markdown link validation reporting tool.
 Author-email: John Aziz <johnaziz269@gmail.com>
 Maintainer-email: John Aziz <johnaziz269@gmail.com>

markdown_checker-1.0.1/src/markdown_checker.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+markdown-checker = markdown_checker:main

{markdown_checker-1.0.0 → markdown_checker-1.0.1}/tests/test_checker.py

@@ -144,6 +144,7 @@ def test_run_check_on_files(tmp_path):
         func="check_broken_paths",
         files_paths=[md1, md2],
         config=Config(),
+        progress_callback=lambda: None,
     )
     assert len(result.issues) == 1
     assert result.issues[0][0] == md1

{markdown_checker-1.0.0 → markdown_checker-1.0.1}/tests/test_cli.py

@@ -140,7 +140,7 @@ def test_cli_version(runner):
     """Displays version information."""
     result = runner.invoke(main, ["--version"])
     assert result.exit_code == 0
-    assert "1.0.0" in result.output
+    assert "1.0.1" in result.output
 
 
 def test_cli_ci_mode(runner, resources_dir, monkeypatch, tmp_path):
@@ -152,3 +152,66 @@ def test_cli_ci_mode(runner, resources_dir, monkeypatch, tmp_path):
         ["-d", str(resources_dir), "-f", "check_broken_paths", "-o", str(tmp_path / "ci_output")],
     )
     assert result.exit_code == 0
+
+
+# --- SRC positional argument ---
+
+
+def test_cli_src_single_file(runner, resources_dir):
+    """Runs check on a single file passed as SRC."""
+    sample = resources_dir / "sample1.md"
+    result = runner.invoke(main, [str(sample), "-f", "check_broken_paths"])
+    assert result.exit_code == 0
+    assert "Checked" in result.output
+    assert "1 files" in result.output
+
+
+def test_cli_src_multiple_files(runner, resources_dir):
+    """Runs check on multiple files passed as SRC."""
+    s1 = resources_dir / "sample1.md"
+    s2 = resources_dir / "sample2.md"
+    result = runner.invoke(main, [str(s1), str(s2), "-f", "check_broken_paths"])
+    assert result.exit_code == 0
+    assert "Checked" in result.output
+    assert "2 files" in result.output
+
+
+def test_cli_src_directory(runner, resources_dir):
+    """Passing a directory as SRC recursively discovers files."""
+    result = runner.invoke(main, [str(resources_dir), "-f", "check_broken_paths"])
+    assert result.exit_code == 0
+    assert "Checked" in result.output
+
+
+def test_cli_src_mixed_file_and_dir(runner, resources_dir, tmp_path):
+    """Passing both a file and a directory as SRC combines results."""
+    extra = tmp_path / "extra.md"
+    extra.write_text("# Extra\n[link](https://example.com)\n")
+    result = runner.invoke(main, [str(extra), str(resources_dir), "-f", "check_broken_paths"])
+    assert result.exit_code == 0
+    assert "Checked" in result.output
+
+
+def test_cli_src_filters_by_extension(runner, tmp_path):
+    """SRC files not matching --extensions are ignored."""
+    md_file = tmp_path / "valid.md"
+    md_file.write_text("# Hello\n")
+    txt_file = tmp_path / "ignored.txt"
+    txt_file.write_text("# Not checked\n")
+    result = runner.invoke(main, [str(md_file), str(txt_file), "-f", "check_broken_paths", "-ext", ".md"])
+    assert result.exit_code == 0
+    assert "1 files" in result.output
+
+
+def test_cli_src_takes_precedence_over_dir(runner, resources_dir, tmp_path):
+    """When SRC is provided, --dir is ignored."""
+    sample = resources_dir / "sample1.md"
+    result = runner.invoke(main, [str(sample), "-d", str(resources_dir), "-f", "check_broken_paths"])
+    assert result.exit_code == 0
+    assert "1 files" in result.output
+
+
+def test_cli_no_src_no_dir_fails(runner):
+    """Fails when neither SRC nor --dir is provided."""
+    result = runner.invoke(main, ["-f", "check_broken_paths"])
+    assert result.exit_code != 0

markdown_checker-1.0.0/src/markdown_checker/__init__.py

@@ -1,10 +0,0 @@
-"""
-markdown-checker — a markdown link validation reporting tool.
-"""
-
-__version__ = "1.0.0"
-
-from markdown_checker.cli import main, main_with_spinner
-from markdown_checker.models import Config, MarkdownLinkBase, MarkdownPath, MarkdownURL
-
-__all__ = ["Config", "main", "main_with_spinner", "MarkdownLinkBase", "MarkdownPath", "MarkdownURL", "__version__"]

markdown_checker-1.0.0/src/markdown_checker.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-markdown-checker = markdown_checker:main_with_spinner