Support commonjs default export #1225
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🚀 PR was released in |
This was referenced May 24, 2024
This was referenced May 25, 2024
This was referenced May 29, 2024
This was referenced Aug 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What's Changing and Why
Adjusted the add-module-exports babel-plugin configuration to create a synthetic default export for CommonJS modules.
In partice, it only appends a
module.exports.default = exports.default;to every packages/*/dist/index.js.It would be required to support the custom modular configuration of Jimp for CommonJS Typescript projects, where the
esModuleInteropcompiler-option cannot be turned on.With those settings, the
import Jimp from 'jimp';resolves toconst Jimp = require('jimp').default;.This will result in a runtime error, as previously the packages didn't have
defaultproperty on their CommonJS export.For the main distribution of Jimp, this could have been bypassed by using namespace import (
import * as Jimp from 'jimp';). This is possible as the CommonJS module export for thejimppackage is an object.However the namespace importing wouldn't work for the modular packages, as their CommonJS export is a function, which is not supported by the ES6.
What else might be affected
This change shouldn't have any side-effects, as it is only affecting the method of distribution and is completely additive.
Tasks
jimp.d.ts