spockframework / spockframework/spock

Create IntelliJ formatting configuration and reformat whole project

Open
#555 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new feature
Dominant language
Java
Stars
3.6k
Forks
483
PR merge metrics
No merged PRs in 30d

Description

Currently the formatting of Spocks sources is incoherent, which causes problems in pull requests.

The goal is to create a binding IntelliJ format definition and reformat the whole project to have a solid base for future PRs. Issue #74 already proposed adding the configuration via gradle, which should be done in conjunction with this issue.

Although these profiles could be exported to other IDEs, there are often subtle differences in the formatting engines. Due to these differences and since IntelliJ is already the de-facto IDE for Spock I propose that IntelliJ will be the required IDE from now on or the committer will have to fix all formatting problems manually.

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 reviewing issue #74 and the proposed Gradle integration, then inspect the project's existing formatting conventions. Create the binding IntelliJ format definition and reformat the whole project with it; done means the sources have a consistent baseline for future pull requests.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy, java
Domain
build-system, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.