typelevel / typelevel/weaver-test

Inline Expecty and improve macros on long/wide outputs

Open
#19 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
85
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Expecty macro libary has been historically maintained by @Baccata, me, and Eugene Yokota, the current maintainer of the fork.

The code from it has been inlined and improved in the Verify testing framework maintained by Eugene.
Inlining the dependency makes release cycles obviously easier.

I believe it's time we design the assertion macros from scratch, as part of this repo, not separate dependency, and address multiple issues related to how Expecty renders assertion failures. See screenshot for an example of an unusable output.

Once we inline the dependency, this issue can be broken down into actionable, smaller issues.

image

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 reviewing the current Expecty dependency and the corresponding implementation in Eugene Yokota's Verify framework. Break the broad inlining and assertion-macro redesign into smaller, independently actionable issues, with improved long or wide assertion output as the completion target.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
testing-qa
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.