IntellectualSites / IntellectualSites/PlotSquared

Proposal for further annotation cleanup

Open
#3,413 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement
Dominant language
Java
Stars
653
Forks
975
Avg merge
2m
Merged PRs (30d)
6

Description

In https://github.com/IntellectualSites/PlotSquared/commit/3eb485e90043ee64df78fbecaa83686e3b27b598 I dropped informational Guava and JB annotations and reduced our overall annotation library count from 6 to 5. This is a proposal to determine which frameworks are needed still or can be removed or transitioned to checkerqual, our core annotation framework.
All annotation frameworks mentioned are shaded and provided at runtime.

  • JB (org.jetbrains)
    Used only in Fawe classes and a single time in ClickStripTransform, looks like a wrong import. To match with upstream, Fawe switched to javax some months ago. We can adapt the changes and remove JB overall.

  • IJ Lang (org.intellij.lang)
    I couldn't find a single use case in the code, it provides @Language, @Pattern and @RegExp at runtime, do we need it for some third party dependency?

  • JavaX (javax.annotation)
    Used in a few injectable classes. Originally introduced when we switched to Guice 4, because Guice didn't recognize nullability provided by qual. We are now using Guice 5 and should evaluate again whether that is still true. It is used in PlotTitle as well, which is non injectable.
    Edit: Taking a look at the Guice documentation, checkerqual nullability is supported.

  • JSR 305 (com.google.code.findbugs)
    Required for cloud until the JavaX scenario from above has been evaluated.

  • JSR 330 (javax.inject)
    We don't use that a single time in our codebase, our @Inject and @Singleton is provided by Guice. To my knowledge, JSR 330 has been published in 2009, do we really have dependencies that demand such ancient libraries?

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 with commit 3eb485e90043ee64df78fbecaa83686e3b27b598 and inspect annotation usage in Fawe classes, ClickStripTransform, PlotTitle, and the cloud dependencies. Check the Guice 5 documentation and dependency declarations to determine which annotation frameworks remain necessary; done means documenting and applying an agreed cleanup without breaking required runtime annotations.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.