typelevel / typelevel/sbt-typelevel

Shared scalafmt config?

Open
#103 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

core enhancement question
Dominant language
Scala
Stars
185
Forks
62
PR merge metrics
No merged PRs in 30d

Description

Possibly a good idea, or a very bad one. But I am tired of copying variations of this file around my repos, and scalafmt updates change stuff all the time which means settings can get stale quickly.

This is a bit annoying to implement: it seems the correct way to do it would be to check-in a generated .scalafmt-common.conf (it would have to be managed/validated in CI like the ci.yml generated workflow).

Then every repo would have a .scalafmt.conf with the following contents:

include ".scalafmt-common.conf"

I believe this would give a repo the freedom to overwrite settings and/or completely ignore the common ones.

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 how the generated ci.yml workflow is managed and validated, then inspect the repository's current scalafmt configuration handling. The proposed result is a generated .scalafmt-common.conf that is checked and validated in CI, with each repository including it through .scalafmt.conf while retaining the ability to override or ignore shared settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.