Configure fieldRename for enums in build.yaml

[ookami-kb]

We have now support for fieldRename on a per-enum basis (rather than per-value), which simplifies the setup.

In our case, all enums coming from the backend are serialized in PascalCase, so it would be great to have an option to configure it in build.yaml, the same as we can do for other fields with field_rename.

[Aqluse]

I need it too

[JPM84]

Seems to work or am I missing something? Just add the following to build.yaml -->

targets:
  $default:
    builders:
      json_serializable:
        options:
          field_rename: snake

[kevmoo]

@JPM84 – nope. This does fields within a class. The request here is for enum values.

[lohnn]

I'm looking into this and I'm taking a stab at it. I I've got it more or less working now but I do have a big question mark to solve left.
Currently I've implemented it so the JsonEnum config is read from the same place as JsonSerializable, but that would mean that field_rename would always be shared between the two.

For example this:

targets:
  $default:
    builders:
      json_serializable:
        options:
          field_rename: kebab

would result in kebab-case as fallback for all Enums and classes annotated with JsonSerializable.

Any ideas or recommendations on how we should solve this properly?

[lohnn]

Ping @kevmoo 😊

[lucavenir]

I just stumbled upon this. It was a bit of a paper cut, I didn't expect field_rename not to work for JsonEnum (indeed build.yaml configurations are documented as "global").

It also felt more like a bug, rather than a missing feature, or a lack of documentation.

[alexobviously]

Any progress on this? Just encountered this when adding the constant_identifier_names lint on a project with a bunch of notCamelCase enum fields.
Is there any particular reason why field_rename in build.yaml shouldn't affect enums? If there is, we could also have json_field_rename or something.

[ChaseGuru]

Yeah, particularly where dart is particular about casing for fields, it's odd that enum doesn't support field_rename as a project wide configuration. Just like field_rename applies to classes, you'd almost always want the same for enums.

Dart will make you make everything be like 'someThing' and if your backend is using 'some_thing' that's usually true for both enums and fields..

[ChaseGuru]

It's also sometimes easy to forget fieldRename applies to one or the other when you look at build.yaml, so this is probably the second time I've looked into this over the years, and I spent several minutes double checking we aren't doing something wrong, and verifying we have the latest versions of the package, and verifying we're specifying the field in build.yaml correctly (by looking at code to ensure 'snake' is what your library expects, and not 'snake_case' or something), and so on, to remeber the field is working, but only for class members.

[ChaseGuru]

Overall, it's just easy to assume it's not necessary for enums to specify when it's not for classes. Seems to add a lot of room for developer error/wasting time.

[ChaseGuru]

It's made even more confusing by many enums sometimes being "fine" without it, if they happen to just have one word fields.