Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make default args snake-case #16

Closed
koertkuipers opened this issue Jan 11, 2022 · 0 comments · Fixed by #101
Closed

Make default args snake-case #16

koertkuipers opened this issue Jan 11, 2022 · 0 comments · Fixed by #101
Milestone
0.6.0

Comments

@koertkuipers
Copy link

i see a lot of:

  @arg(name = "my-num", ...)
  myNum: Int = 2,

  @arg(name = "no-default-predef", ...)                                                                                                                                       
  noDefaultPredef: Flag,

  @arg(name = "predef-code", ...)                                                                                                                                             
  predefCode: String = "",

clearly the preferred command-line arguments are snake-case, not camelCase. so why not make that the default (so by default convert case class camelCase parameters to cmdline snake-case arguments)? it would remove a lot of boilerplate i think. and if someone doesn't like it they can still override the names back to camelCase using @arg(name = "...")
@lihaoyi lihaoyi mentioned this issue Jan 24, 2024
Merged
lihaoyi added a commit that referenced this issue Jan 26, 2024
@lihaoyi
Add configurable automatic name mapping from camelCase to `kebab-ca…
8982303 
…se` (#101)

Fixes #16

* We maintain backwards compatibility by continuing to allow the
`camelCase` names in addition to the `kebab-case` names during argument
parsing.

* When a an explicit `name = ???` is given to the `@main` or `@arg`
annotation, that takes precedence over everything, and is not affected
by the name mapping,

* Name mapping is configurable by passing in `nameMapper =
mainargs.Util.snakeCaseNameMapper` or `nameMapper =
mainargs.Util.nullNameMapper` when you call `ParserForClass` or
`ParserForMethods`

* I had to add a whole bunch of annoying shims to maintain binary
compatibility when threading the new `nameMapper` through all our method
signatures. That would be resolved by a proposal like
https://contributors.scala-lang.org/t/can-we-make-adding-a-parameter-with-a-default-value-binary-compatible/6132/3,
which alas does not exist yet in the Scala implementation

* The duplication in method argument lists is getting very annoying.
Again, this would be solved by a proposal like
https://contributors.scala-lang.org/t/unpacking-classes-into-method-argument-lists/6329,
which still doesn't exist in the language

* Bumping to 0.6.0 since we cannot maintain bincompat for Scala 3 and
Scala 2 simultaneously
* There is no way to continue to evolve the `case class`es that is
compatible with both Scala 2 and Scala 3, due to differing method
signature requirements. e.g. `def unapply(x: MyCaseClass):
Option[Tuple]` vs `def unapply(x: MyCaseClass): MyCaseClass`.
* The choice is either to break bincompat in Scala 2 or break bincompat
in Scala 2, and I ended up choosing to do so in Scala 2 since those
would have the larger slower-moving codebases with more of a concern for
binary compatibility

* Updated the docs and added coverage in the unit tests

* I intend to release this as 0.5.5 once it lands
@lefou lefou added this to the 0.6.0 milestone Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.6.0
Development

Successfully merging a pull request may close this issue.

Add configurable automatic name mapping from camelCase to kebab-case com-lihaoyi/mainargs
2 participants
@koertkuipers @lefou