Skip to content

Document APPROVALTESTS_CONFIG for viewing test diffs #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nitsanavni
Copy link
Contributor

@nitsanavni nitsanavni commented May 27, 2025

Summary

• Documented the APPROVALTESTS_CONFIG environment variable for viewing approval test diffs directly in terminal
• Added to CLAUDE.md for future reference during development

Useful Command

APPROVALTESTS_CONFIG='{"reporter":"PythonNativeReporter"}' uv run python -m pytest tests/path/to/test.py -v -s

Benefits

• See approval test diffs directly in terminal output
• No need to manually check received files
• Faster development workflow for approval tests
• Uses PythonNativeReporter instead of external diff tools

This was discovered while working on the DateScrubber improvements and proved very useful for debugging approval test failures.

🤖 Generated with Claude Code

Summary by Sourcery

Add a new CLAUDE.md file with developer notes covering test & type-checking commands, code style guidelines, MyPy configuration, and instructions for using the APPROVALTESTS_CONFIG environment variable to view approval test diffs directly in the terminal.

Documentation:

  • Introduce CLAUDE.md with development setup and workflow instructions.
  • Document the APPROVALTESTS_CONFIG environment variable for in-terminal approval test diffs.

Added documentation for the APPROVALTESTS_CONFIG environment variable
that allows viewing approval test diffs directly in the terminal using
PythonNativeReporter instead of external diff tools.

Useful command:
APPROVALTESTS_CONFIG='{"reporter":"PythonNativeReporter"}' uv run python -m pytest tests/path/to/test.py -v -s

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link

sourcery-ai bot commented May 27, 2025

Reviewer's Guide

This PR introduces a new CLAUDE.md file containing developer-facing notes—test runs, type checking, code style—and specifically documents the APPROVALTESTS_CONFIG environment variable for viewing approval test diffs directly in the terminal.

File-Level Changes

Change Details Files
Add CLAUDE.md with development notes
  • Create CLAUDE.md as a new reference for developer workflows
  • Include sections on running tests, type checking, and code style
CLAUDE.md
Document APPROVALTESTS_CONFIG for in-terminal diffs
  • Add 'Approval Tests' section with command snippet
  • Show how to set APPROVALTESTS_CONFIG to use PythonNativeReporter
CLAUDE.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @nitsanavni - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant