Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking! Rename credit field in output manifest to meta, and deprecate types. #5

Merged
merged 8 commits into from
Nov 4, 2023

Conversation

brev
Copy link
Owner

@brev brev commented Nov 3, 2023

Breaking changes! Versions bumped to 2.0.0.

Rename credit field in output object to meta, and deprecate types.

  • Generalizing the metadata field so developer can use whatever they want. No longer tied to our "credit" usage.
  • Deprecated web-image-gen-common public package, now private, and used via symlinks instead of workspaces or npm. Can't figure out ideal solution to have shared types in a monorepo (usually workspaces or typescript project references), but where those types are also to be exported out to the world.
  • Deprecated Credit and Meta types. Developer can type on their side.
  • ImageSet type is available from both cli and svelte packages.
  • Dependency Updates.
  • Switch ESM loader from --loader to new --import/register() usage.
  • Renaming for sanity.

Fixes Issue #4

brev added 6 commits October 30, 2023 19:14
- Move code to pkgs that use it.
- Move types to pkgs that use them.
- Only thing remains is truly common types.
- `common` dir no longer used as pkg, but via symlinks.
- `ImageSet` type is re-exported by other pkgs.
- `Credit` and `Meta` types deprecated, user can type their own
  metadata json.

Issue #4
- Move core defines and helpers over from `common`.
- Move some types over from `common`, and symlink the shared remnants.
  - Symlink `ImageSet` type from `common`.
- Add new example non-credit metadata field to docs and test stubs.
- Renamed some test libs for sanity.
- Dependency updates.

Issue #4.
- Get and re-export `ImageSet` type via symlink to `common`
- Drop `Credit` and `Meta` types, developer can type metadata on their side.
- Add example non-credit `description` metadata field to docs and test stubs.
- Use `mime` package to get `Content-Type` strings, remove hard-coded list.
- Exclude tests in tsconfig. Test files still getting copied to output
  `dist/` though, I think a bug/feature of `svelte-package`, @todo
  later.
- Add sveltekit aliases to tsconfig.
- Dependecy updates.

Fixes Issue #4.
@brev brev changed the title Issue #4 credit to metadata Rename credit output field to meta and deprecate types. Nov 3, 2023
@brev brev changed the title Rename credit output field to meta and deprecate types. Rename credit field in output manifest to meta, and deprecate types. Nov 3, 2023
@brev brev changed the title Rename credit field in output manifest to meta, and deprecate types. Breaking! Rename credit field in output manifest to meta, and deprecate types. Nov 4, 2023
@brev brev self-assigned this Nov 4, 2023
@brev brev added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 4, 2023
@brev brev merged commit c7b769d into main Nov 4, 2023
@brev brev deleted the issue-4-credit-to-metadata branch November 4, 2023 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant