specify-unknown-enum-value

v1.39.0

warning

effort: 4m

pro+

Warns when a field of the Enum type does not specify unknownEnumValue.

Specifying unknownEnumValue ensures backward compatibility if the enum values change. Not providing it can lead to runtime exceptions for older app versions if it relies on the same API.

Example

❌ Bad:

@JsonSerializable()
class MyEntity {
  // LINT: Fields of the Enum type must specify 'unknownEnumValue' to simplify backward compatibility.
  //  Try adding '@JsonKey' with 'unknownEnumValue'.
  final MyEnum myEnum;
}

@JsonSerializable()
class MyEntity {
  // LINT: Fields of the Enum type must specify 'unknownEnumValue' to simplify backward compatibility.
  //  Try adding '@JsonKey' with 'unknownEnumValue'.
  @JsonKey()
  final MyEnum myEnum;
}

✅ Good:

@JsonSerializable()
class MyEntity {
  @JsonKey(unknownEnumValue: MyEnum.a)
  final MyEnum myEnum;
}

@JsonSerializable()
class MyEntity {
  @JsonKey(unknownEnumValue: JsonKey.nullForUndefinedEnumValue)
  final MyEnum? myEnum;
}