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

Revert exports to match 0.6.4 TS definitions #820

Merged
merged 1 commit into from
Nov 26, 2019
Merged

Revert exports to match 0.6.4 TS definitions #820

merged 1 commit into from
Nov 26, 2019

Conversation

crutchcorn
Copy link
Member

@crutchcorn crutchcorn commented Nov 21, 2019

What's Changing and Why

Many developers using TypeScript have reported that 0.6.4 was the last time that they were able to use the TypeScript definition files. This is because in 0.6.5 the export format was modified to more accurately fall inline with ESModule export syntax.

While TypeScript compiler, with some settings, allow you to handle this export and have the correct results, if the project feels it better to use the same exports as 0.6.4, this is how it would be done without removing the additional types from missing plugins, removing the TS type tests, and more

What else might be affected

This would be a breaking change from the current (or even the version 0.6.5) definition files as we no longer export interfaces such as Bitmap or others. This is because this export = Object does not allow for any other exports to be named in a definition file. Needless to say, someone is not going to be happy with the typings regardless of what we do. I'm just opening this PR per #803 (comment) as it seems like this is the direction we want to go in

Tasks

  • Add tests
  • Update Documentation
  • Update jimp.d.ts
  • Add SemVer Label

@crutchcorn
Copy link
Member Author

Pinging @hipstersmoothie as the release for this version seems to've failed for unrelated reasons

@hipstersmoothie hipstersmoothie added the minor Increment the minor version when merged label Nov 26, 2019
@hipstersmoothie hipstersmoothie merged commit f5d5167 into jimp-dev:master Nov 26, 2019
@hipstersmoothie
Copy link
Collaborator

🚀 PR was released in v0.9.0 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor Increment the minor version when merged released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants