Skip to content

fix(clerk-react,remix,shared): Make exports.types the first key in exports #1835

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

Merged
nikosdouvlis merged 3 commits into from
Oct 6, 2023
Merged

fix(clerk-react,remix,shared): Make exports.types the first key in exports #1835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
801a892
fix(clerk-react,remix,shared): Move `exports.types` to the top
nikosdouvlis Oct 6, 2023
3dc386a
Create dull-gifts-yawn.md
nikosdouvlis Oct 6, 2023
3f560d3
Update dull-gifts-yawn.md
LekoArts Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/dull-gifts-yawn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@clerk/clerk-react": patch
"@clerk/remix": patch
"@clerk/shared": patch
---

Make `types` the first key in all `exports` maps defined in our packages' `package.json`. The [TypeScript docs](https://www.typescriptlang.org/docs/handbook/esm-node.html#packagejson-exports-imports-and-self-referencing) recommends so, as the the `exports` map is order-based.
4 changes: 2 additions & 2 deletions packages/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
"types": "./dist/types/index.d.ts",
"exports": {
".": {
"types": "./dist/types/index.d.ts",
"import": "./dist/esm/index.js",
"require": "./dist/cjs/index.js",
"types": "./dist/types/index.d.ts"
"require": "./dist/cjs/index.js"
}
},
"files": [
Expand Down
15 changes: 12 additions & 3 deletions packages/remix/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,18 @@
"types": "dist/index.d.ts",
"sideEffects": false,
"exports": {
".": "./dist/index.js",
"./ssr.server": "./dist/ssr/index.js",
"./api.server": "./dist/api/index.js"
".": {

@nikosdouvlis nikosdouvlis Oct 6, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anagstef @LekoArts
Could you please verify that this is correct?

@LekoArts LekoArts Oct 6, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Looking at https://webpack.js.org/guides/package-exports/#conditional-syntax

The last condition in the object might be the special "default" condition, which is always matched.

I'm not 100% sure if we could use require here, but default seems like a safe bet for now

@nikosdouvlis nikosdouvlis Oct 6, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly - used default as it should mimic the exports behavior we had before. Thank you!

"types": "./dist/index.d.ts",
"default": "./dist/index.js"
},
"./ssr.server": {
"types": "./dist/ssr/index.d.ts",
"default": "./dist/ssr/index.js"
},
"./api.server": {
"types": "./dist/api/index.d.ts",
"default": "./dist/api/index.js"
}
},
"typesVersions": {
"*": {
Expand Down
8 changes: 4 additions & 4 deletions packages/shared/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
],
"exports": {
".": {
"types": "./dist/types/index.d.ts",
"import": "./dist/esm/index.js",
"require": "./dist/cjs/index.js",
"types": "./dist/types/index.d.ts"
"require": "./dist/cjs/index.js"
},
"./testUtils": {
"types": "./dist/types/testUtils/index.d.ts",
"import": "./dist/esm/testUtils/index.js",
"require": "./dist/cjs/testUtils/index.js",
"types": "./dist/types/testUtils/index.d.ts"
"require": "./dist/cjs/testUtils/index.js"
}
},
"scripts": {
Expand Down