[ ] Chore (a non-breaking change which is related to package maintenance)
[x] Bug fix (a non-breaking change which fixes an issue)
[ ] New feature (a non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Description
This PR removes the "DO NOT EDIT" header that was prepended to generated types when using generateTypes(). The header was included in the output of both generateTypes() and the CLI.
Before:
// Code generated by prismic-ts-codegen. DO NOT EDIT.
type PageDocument = {
// ...
};
After:
type PageDocument = {
// ...
};
Note: The header will continue to be included in CLI usage. It is removed from generateTypes() since the library has no opinion on how the output is used. It may or may not end up in a file. The message also likely would have required customization; we do not necessarily always want to expose prismic-ts-codegen as the generator.
Checklist:
[ ] My change requires an update to the official documentation.
[x] All TSDoc comments are up-to-date and new ones have been added where necessary.
Types of changes
Description
This PR removes the "DO NOT EDIT" header that was prepended to generated types when using
generateTypes()
. The header was included in the output of bothgenerateTypes()
and the CLI.Before:
After:
Note: The header will continue to be included in CLI usage. It is removed from
generateTypes()
since the library has no opinion on how the output is used. It may or may not end up in a file. The message also likely would have required customization; we do not necessarily always want to exposeprismic-ts-codegen
as the generator.Checklist:
🦮