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.

Sign up for GitHub

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

Jump to bottom

Configure 2 TypeScript compile targets for ESM and CJS #1704

Merged

anniel-stripe merged 21 commits into master from anniel-dual-entrypoints

Mar 14, 2023

Contributor

anniel-stripe commented Mar 9, 2023 •

edited

Loading

Summary

Prepare to convert stripe-node to a dual package. This sets up the TypeScript build step to transpile into two separate ESM and CJS outputs, but we only expose the cjs entry point for now.

In this PR:

Configure 2 TypeScript builds for CJS and ESM, respectively, to cjs and esm (lib is removed)
Update entry points to point to the CommonJS entry point defined by src/stripe.cjs.*..ts, will add ESM entry point in a follow-up PR
Rename stripe.common.ts to stripe.core.ts because the naming is too similar to CommonJS
Add Stripe and default properties to Stripe object in stripe.core.ts for backwards compatibility
Update relative imports to specify .js file ending
Set package version directly in stripe.core.ts and add rule to update that version during releases.
Update paths in test files to point to cjs/ output

Testing

In addition to CI tests, verified that package works as expected in manual test projects

anniel-stripe and others added 11 commits

March 7, 2023 14:38


          works in test project

e17e31d


          tests run

5a00424


          Add version file

4c5377c


          Separate tsconfigs and update package.json

54e140e


          Passes tests

6164aa4


          [wip] exclude entry point files from cjs tsconfig

13a287e


          Separate source entry points, add Stripe and default properties

61ad09a


          Remove old references to lib

8ef002c


          Merge branch 'master' into anniel-dual-entrypoints

4a221eb


          lint

3d9d622


          Actually lint

b3a8711

anniel-stripe commented

View reviewed changes

package.json Outdated Show resolved Hide resolved

anniel-stripe commented

View reviewed changes

package.json Outdated Show resolved Hide resolved


          Rename stripe.common to createStripe

dec91ed

anniel-stripe force-pushed the anniel-dual-entrypoints branch from c5b3090 to dec91ed Compare

March 9, 2023 23:26

anniel-stripe commented

View reviewed changes

src/createStripe.ts Outdated Show resolved Hide resolved

anniel-stripe commented

View reviewed changes

src/createStripe.ts Outdated Show resolved Hide resolved

anniel-stripe commented

View reviewed changes

test/PlatformFunctions.spec.ts Show resolved Hide resolved

anniel-stripe requested a review from pakrym-stripe

March 9, 2023 23:39

anniel-stripe assigned pakrym-stripe

pakrym-stripe requested changes

View reviewed changes

Contributor

pakrym-stripe left a comment

Nice work! Mostly nits and discussions.

.eslintrc.js Outdated Show resolved Hide resolved

Makefile Outdated Show resolved Hide resolved

cjs/RequestSender.js Outdated Show resolved Hide resolved

tsconfig.esm.json Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

src/createStripe.ts Outdated Show resolved Hide resolved

test/utils.spec.ts Show resolved Hide resolved

src/stripe.esm.worker.ts Show resolved Hide resolved

src/createStripe.ts Outdated Show resolved Hide resolved

test/PlatformFunctions.spec.ts Show resolved Hide resolved

anniel-stripe added 6 commits

March 13, 2023 09:59


          Reviewer comments pt. 1

baf83c6


          lint

66844ff


          Reviewer comments pt. 2

623e4b7


          don't expose ESM entrypoint yet

642580a


          Remove 'use strict' from generated files (it's added by the TS compiler)

1f7f037


          extra space

7909a32

anniel-stripe changed the title ~~Add support for ESM~~ Configure 2 TypeScript compile targets for ESM and CJS


          remove nested package.json for now

c45f59d

anniel-stripe requested a review from pakrym-stripe

March 13, 2023 23:28

pakrym-stripe reviewed

View reviewed changes

configs/tsconfig.json Outdated Show resolved Hide resolved

pakrym-stripe reviewed

View reviewed changes

.npmignore Show resolved Hide resolved

pakrym-stripe reviewed

View reviewed changes

.eslintrc.js Outdated Show resolved Hide resolved

pakrym-stripe approved these changes

View reviewed changes

Contributor

pakrym-stripe left a comment

nits

anniel-stripe added 2 commits

March 14, 2023 09:27


          Have ESM tsconfig extend CJS tsconfig

91cc581


          more

d676050

anniel-stripe requested a review from pakrym-stripe

March 14, 2023 16:38

pakrym-stripe approved these changes

View reviewed changes

Contributor

pakrym-stripe left a comment

Great work!

anniel-stripe merged commit e14e183 into master

anniel-stripe deleted the anniel-dual-entrypoints branch

March 14, 2023 16:43

This was referenced Mar 14, 2023

Merge origin/master into beta #1708

Merged

Add ES module package entry point #1709

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet