feat: ✨ add enum value-level descriptions and deprecation me… #243
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enhances the `registerEnum` function to include per-enum-value descriptions and deprecation reasons when registering enums using `registerEnumType`. - Introduces a `valuesMap` generated from the `SchemaEnum` value documentation (e.g., comments in schema.prisma). - Deprecation reasons are parsed from `@deprecated` annotations. - Regular comments are used as descriptions for enum values. - Values without comments are skipped in the `valuesMap`. - Includes a helper `extractEnumValueDocs` to isolate parsing logic. Example: /// @deprecated Use USER instead ADMIN → becomes: ADMIN: { deprecationReason: "Use USER instead" } This allows richer metadata in GraphQL schema introspection and enhances tooling and client generation. Usage remains backward compatible for enums without documentation.
|
// @generated/prisma/role.enum.ts import { registerEnumType } from '@nestjs/graphql'; export enum Role { registerEnumType(Role, { name: 'Role', description: "user access control", valuesMap: { |
|
🎉 This PR is included in version 21.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This update enhances the registerEnum function to support richer metadata for enum values using registerEnumType from @nestjs/graphql.
✅ Features
• Adds a valuesMap derived from SchemaEnum value documentation (e.g., comments in schema.prisma)
• Parses @deprecated annotations to set deprecationReason
• Uses regular comments as description
• Skips enum values without comments
• Introduces extractEnumValueDocs helper to encapsulate parsing logic