jackfirth / jackfirth/resyntax

Test logging

Open
#346 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

testing
Dominant language
Racket
Stars
70
Forks
11
PR merge metrics
No merged PRs in 30d

Description

When test cases for complex rules fail, it can be tricky to tell why. Logging helps since the log messages show up in the test output. Going one step further, it would be nice to let tests expect log messages like so:

test: "should not refactor X because of comments"
expect-log: "my-rule: suggestion discarded because it does not preserve all comments"
----------
... code ...
----------

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how test cases are parsed and how log messages currently reach test output. Define how an expect-log entry should match emitted messages, then verify the example format with a focused test covering the rule name and expected message.

Written by the indexing model from the issue text.

Assessment

Domain
testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.