INRIA/spoon

feat: add SpoonCheckstyleCompliantPrettyPrinter to be compliant with Spoon's own formatting rules

Open

#3,623 opened on Oct 1, 2020

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Java (383 forks)github user discovery
featuregood first issue

Repository metrics

Stars
 (1,933 stars)
PR merge metrics
 (Avg merge 19d 11h) (49 merged PRs in 30d)

Description

We want to use Spoon to transform the code of Spoon. For this, we need a Spoon pretty-printer that is compliant with Spoon's checkstyle.

The idea is to create a class SpoonCheckstyleCompliantPrettyPrinter which extends DefaultJavaPrettyPrinter

Here are the rules with the number of violations in src/main/java today:

2 [modifierorder]
2 [rightcurly]
2 [unusedimports]
5 [regexpsinglelinejava]
77 [whitespaceafter]
99 [nowhitespacebefore]
167 [parenpad]
237 [regexpsingleline]
1629 [whitespacearound]

Contributor guide

Research direction
Examine the DefaultJavaPrettyPrinter class and Spoon's checkstyle configuration to override formatting methods.
Tech stack
java
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaSpoon API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55