autonomousapps / autonomousapps/gradle-best-practices-plugin

Baseline is not VCS friendly

Open
#16 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Kotlin
Stars
197
Forks
4
PR merge metrics
No merged PRs in 30d

Description

The baseline file is not VCS friendly, because it's a single-line JSON.
Please consider
* auto-formatting the file,
* ensuring the the contents are also sorted by something stable.

For example on the top level sort by their `name`, and the internal `trace` list should also be sorted by for example `traces.sort { "${it.owner}/${it.name}/${it.descriptor}" }`.

This will make multiple runs on the same project produce nice diffs/PRs as the project evolves.

Contributor guide

Open the contributing guide

Research direction

Locate the baseline file and inspect how it is produced and serialized. Make the output formatted and stable by sorting top-level entries by name and each internal trace list by owner, name, and descriptor; done means repeated runs produce readable, consistent VCS diffs.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
build-system
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.