PaperMC / PaperMC/codebook

Add option to generate parameter names

Open
#30 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

For more consistent cross-version comparisons it would be useful for codebook to be able to name parameters similarly to how it names the lvt.

If we don't apply any parameter names, we will get a different mess depending on the version ($$x or snowman emoji names).

And when using parchment, we don't have mappings for every snapshot, so there is a large amount of redundant diff each version from the mappings getting more or less in sync/complete.

Having codebook generate parameter names in a consistent manner would solve this problem and give us much cleaner diffs.

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 locating the codebook paths that name local variables and parameters, then compare how those names are produced across versions and how parchment mappings are consumed. Define a consistent generated-parameter naming scheme and an option for enabling it; done means cross-version diffs no longer vary because of parameter names or incomplete mappings.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.