prismicio / prismic-ts-codegen

A Prismic model-to-TypeScript-type generator.
Apache License 2.0
18 stars 6 forks source link

feat(lib): remove "DO NOT EDIT" file header #34

Closed angeloashmore closed 2 years ago

angeloashmore commented 2 years ago

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 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:

🦮

github-actions[bot] commented 2 years ago

size-limit report 📦

Path Size
dist/index.js 1.07 MB (-0.14% 🔽)
dist/index.cjs 1.07 MB (-0.41% 🔽)