chore(root): add biome plugin to validate Record types in DTOs fixes NV-6905 #9517
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed? Why was the change needed?
This pull request introduces a new Biome plugin to help developers ensure proper OpenAPI configuration when using
Record<string, ...>types in DTO files. The plugin automatically warns developers to verify that@ApiPropertyincludes the correct settings for SDK generation. Additionally, the plugin is registered in the Biome configuration.Biome plugin addition and configuration:
biome-plugins/api-property-record-type.gritplugin to detect usage ofRecord<string, ...>types and warn developers to verify@ApiPropertyincludestype: 'object'andadditionalProperties: truefor SDK generation.biome.jsonby adding it to thepluginsarray.