softwaremill / softwaremill/tapir

codegen: underscores break schema names

Open
#5,415 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1.5k
Forks
468
Avg merge
5h 37m
Merged PRs (30d)
34

Description

I swear we used to support having underscores in schema names, but that doesn't work now (produces non-compiling code). I'm not sure when it happened, although I'd guess at some point during the name sanity refactor, but now the case class definition and the schema references to it drift apart (so a schema pet_1 could be created as case class Pet1(..) but referenced as Schema[pet_1]. Need to get that more principled so it doesn't happen again, and hopefully in so doing, fix the bug with _.

Contributor guide

No contributing guide indexed for this repository

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 tracing the name sanity refactor and the code generation paths that produce the case class definition and schema reference. Reproduce the issue with a schema named pet_1; it is done when the generated names agree and the resulting code compiles.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.