OpenAPITools / OpenAPITools/openapi-generator

[REQ] [Dart] Have names available using descriptions of cases in Effective Dart

Open
#3,827 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

I am working on a generator/cli-option and I've found that the maps created by the java codegen for the models don't have all the items for names I need.

Currently there is "name", "nameInCamelCase" and "nameInSnakeCase"

  • "nameInSnakeCase" has names that are in what Effective Dart calls SCREAMING_CAPS (I've seen it called SCREAMING_SNAKE_CASE elsewhere)
  • "nameInCamelCase" has names in what Effective Dart calls UpperCamelCase (also known as PascalCase)

Describe the solution you'd like

  • "nameInSnakeCase" to have names in the form lowercase_with_underscores
    • maybe rename to "nameInLowerCaseWithUnderscores" (lowercase_with_underscores is the term used in Effective Dart but I think snake_case is commonly used and unambiguous)
  • "nameInCamelCase" renamed to "nameInUpperCamelCase"
  • add a "nameInLowerCamelCase" item

Describe alternatives you've considered

Just putting this up for discussion at this stage, happy to have a go at implementing if it's agreed on.

Additional context

https://dart.dev/guides/language/effective-dart/style#identifiers

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 with the Java codegen maps for model names and compare the requested forms with the Effective Dart identifiers guidance linked in the issue. Done means agreeing on the naming and compatibility scope, then providing the requested lowercase_with_underscores, UpperCamelCase, and lowerCamelCase entries or renames.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart, java
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.