Skip to content

Add scalafmt (plugin) to scala-sttp4 client#23273

Merged
wing328 merged 2 commits intomasterfrom
scalafmt
Mar 17, 2026
Merged

Add scalafmt (plugin) to scala-sttp4 client#23273
wing328 merged 2 commits intomasterfrom
scalafmt

Conversation

@wing328
Copy link
Member

@wing328 wing328 commented Mar 17, 2026

cc @clasnake (2017/07), @shijinkui (2018/01), @ramzimaalej (2018/03), @chameleon82 (2020/03), @Bouillie (2020/04) @Fish86 (2023/06)

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Adds Scalafmt to the Scala STTP v4 client generator to ensure consistent formatting. The generator now outputs a .scalafmt.conf and enables the sbt-scalafmt plugin.

  • New Features

    • Generates .scalafmt.conf (Scalafmt 3.10.6, Scala 2.13 dialect).
    • Adds project/plugins.sbt with org.scalameta sbt-scalafmt 2.5.6.
    • Updates Scala STTP v4 samples to include these files.
  • Refactors

    • Stops generating DateSerializers.scala.

Written for commit 5579d82. Summary will update on new commits.

@wing328 wing328 added this to the 7.21.0 milestone Mar 17, 2026
@wing328 wing328 marked this pull request as ready for review March 17, 2026 03:23
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 issues found across 6 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="modules/openapi-generator/src/main/resources/scala-sttp4/scalafmt.mustache">

<violation number="1" location="modules/openapi-generator/src/main/resources/scala-sttp4/scalafmt.mustache:4">
P1: `project.git = true` makes formatting depend on Git-tracked files, so a freshly generated client outside a Git repo won't be formatted.</violation>

<violation number="2" location="modules/openapi-generator/src/main/resources/scala-sttp4/scalafmt.mustache:63">
P2: This failure message tells users to run `./scalafmt`, but scala-sttp4 clients don't generate that script.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@wing328 wing328 merged commit 4fdc919 into master Mar 17, 2026
31 of 32 checks passed
@wing328 wing328 deleted the scalafmt branch March 17, 2026 03:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant