Add CLI options to disable exports

[obeone]

Summary

• add --no-markdown and --no-json flags
• skip export calls when those flags are set
• show file paths only when exports occur
• test CLI export disabling

Testing

• pytest -q

---

https://chatgpt.com/codex/tasks/task_e_686af837fe20832e93c04535e8b51e9f

Summary by CodeRabbit

• New Features
  • Added command-line options to disable generation of Markdown (--no-markdown) and JSON (--no-json) output files.
• Tests
  • Introduced tests to verify that the new export-disabling options work as expected.

[coderabbitai]

Walkthrough

Two new command-line flags, --no-markdown and --no-json, were added to the CLI to allow users to selectively disable Markdown and JSON output generation. Corresponding logic was implemented to conditionally execute export steps. A new test module verifies that these flags work as intended by checking which export functions are called.

Changes

Files/Paths	Change Summary
crawler_to_md/cli.py	Added --no-markdown and --no-json CLI flags; conditional export logic for Markdown/JSON.
tests/test_cli.py	New test module; tests CLI export enabling/disabling via the new flags.

Poem

In the warren of code, two flags now appear,
“No Markdown!” “No JSON!”—the CLI will hear.
With tests that ensure exports obey,
The bunny can hop in whichever way.
Hooray for new options, so tidy and neat—
More ways to make output, or none, as a treat!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

tests/test_cli.py (1)

36-46: Consider adding mixed scenario tests for better coverage.

The current tests cover the two extremes (all exports enabled vs. all disabled) but don't test mixed scenarios where only one export is disabled.

Consider adding these test cases to improve coverage:

+def test_cli_disable_markdown_only(monkeypatch, tmp_path):
+    calls = _run_cli(monkeypatch, tmp_path, ["--no-markdown"])
+    assert calls["md"] is False
+    assert calls["json"] is True
+
+
+def test_cli_disable_json_only(monkeypatch, tmp_path):
+    calls = _run_cli(monkeypatch, tmp_path, ["--no-json"])
+    assert calls["md"] is True
+    assert calls["json"] is False

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3102b6d and a868c8a.

📒 Files selected for processing (2)

• crawler_to_md/cli.py (3 hunks)
• tests/test_cli.py (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

crawler_to_md/cli.py (1)

crawler_to_md/export_manager.py (2)

• export_to_markdown (100-110)
• export_to_json (112-137)

🔇 Additional comments (4)

crawler_to_md/cli.py (3)

91-102: LGTM! Clean implementation of the CLI flags.

The new command-line arguments are properly defined with clear help text and appropriate defaults. The implementation follows the existing pattern in the codebase.

---

189-195: LGTM! Conditional export logic is correct.

The implementation properly checks the negation of the flags before executing the export methods. This ensures that exports are only performed when the corresponding flags are not set.

---

207-210: LGTM! Consistent conditional output display.

The print statements are appropriately made conditional, ensuring that file paths are only displayed when the corresponding exports actually occur. This provides a better user experience by avoiding confusion about non-existent files.

tests/test_cli.py (1)

7-33: LGTM! Well-structured test helper function.

The _run_cli helper function effectively monkeypatches the necessary methods to avoid actual file operations while tracking whether export methods are called. The approach is clean and follows good testing practices.