PaperMC / PaperMC/codebook

Output various reports

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

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
22
Forks
1
Avg merge
2m
Merged PRs (30d)
1

Description

There are several useful reports that could be generated from a run of codebook.

### Tasks
- [ ] Missing parameter mappings
- [ ] All locals assigned from methods that don't have a suggester match
- [ ] All locals assigned from fields that don't have a suggester match
- [ ] Any mapped param that is renamed due to a conflict

Contributor guide

No contributing guide indexed for this repository

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 a codebook run currently produces or exposes results; the issue does not name a file, test, or entry point. Define how each listed report should be represented and emitted, then verify that a run can produce missing parameter mappings, unmatched method and field assignments, and conflict-renamed parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
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.