fix: Add deprecated directive to enumsAsConst #10274
Open
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.
Description
When generating standard enums, the comments for enum values are created with deprecated directives transformed into jsdoc. This PR fixes an issue where using
enumsAsConst
results in an object with comments that have not included the deprecated directives where relevant.Related #9453 (fixes it)
Details
Use the BaseTypesVisitor getNodeComment to build the comment string (which uses transformComment under the hood) rather than just using the transform. The getNodeComment method already has support for intepreting and transforming deprecated directives correctly, as is seen in the default output for enums.
Approach
When looking at the
EnumTypeDefinition
withinTsVisitor
a special case is made for ifthis.config.enumsAsConst
where it was building the enum values with a less advanced comment generator (transformComment
utility). However in the default logic —when this config option is not enabled— thebuildEnumValuesBlock
method (fromBaseTypesVisitor
) is used which is implemented using thegetNodeComment
method.getNodeComment
added support for recognising deprecated directives a few years back, and does so before applyingtransformComment
to the result.Type of change
Bug fix (non-breaking change which fixes an issue) but changes output by including deprecated directive where it previously was not.
Screenshots/Sandbox (if appropriate/relevant):
Adding links to sandbox or providing screenshots can help us understand more about this PR and take action on it as appropriate
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Test Environment:
@graphql-codegen/...
:Checklist:
Further comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...