jatcwang / jatcwang/difflicious

UI for viewing diffs

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

Nobody has claimed this yet.

Dominant language
Scala
Stars
108
Forks
13
Avg merge
13h 7m
Merged PRs (30d)
34

Description

For diffs from larger data structures, users need a more interactive way to explore the diff as text diffs can get too overwhelming.

Requirements

  • Explore difflicious diff output
  • Parts of the diff can be expanded and minimise. This applies to both parts that are the same (no diff) or different

Architecture

  • Frontend in scala.js
  • Backend (server) will register new diffs from failed tests, and serve the frontend via an API.

Reporting diff errors

Ideally, we want minimal code change in the tests to enable reporting to the backend.

Possible approaches:

  • Using Implicits/givens, the "diff server reporter" is brought in via an import
  • Use some sort of ServiceLoader mechanism to automatically load the reporter if it's on the classpath, activated if an env var / system property is set.
    • Does not require code modification
    • Not cross platform

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 mapping the Scala.js frontend, the backend API, and the existing difflicious output path; no specific files or tests are named in the issue. Compare the proposed reporting approaches and define how users expand or minimise unchanged and changed parts. Done means interactive diff viewing works and failed-test diffs can be reported with minimal test changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
api, backend, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.