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

fix(build): switch to esbuild #82

Merged
merged 2 commits into from
Jun 1, 2023
Merged

fix(build): switch to esbuild #82

merged 2 commits into from
Jun 1, 2023

Conversation

kfcampbell
Copy link
Member

Replicating octokit/request.js#584 to another repo.


Pika has been deprecated for a while now, and the project has now been archived, and because of that the released npm package is missing most of the files generated by the build step.

Uses esbuild to transpile the TS source code into an ESM source, NodeJs bundle, and a browser bundle

Uses the TypeScript compiler to generate the types.

Behavior

Before the change?

  • Uses pika for the build system
  • The released npm package is missing most of the files generated by the build step. dist-node, dist-types, dist-web... even though they are generated correctly.

After the change?

  • Uses esbuild to generate the JS bundles
  • Uses the TypeScript compiler to generate the type definitions
  • The correct file matching patterns are used so we publish all the necessary files again.

Additional info

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Added the appropriate label for the given change

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes (Please add the Type: Breaking change label)
  • No

If Yes, what's the impact:

  • N/A

Pull request type

Please add the corresponding label for change this PR introduces:

  • Bugfix: Type: Bug
  • Dependencies/code cleanup: Type: Maintenance

@kfcampbell kfcampbell added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Jun 1, 2023
@kfcampbell
Copy link
Member Author

I can reproduce these build errors...I'm not sure what's going wrong in the build process yet.

@kfcampbell kfcampbell changed the title fix(ci): switch to esbuild fix(build): switch to esbuild Jun 1, 2023
@wolfy1339
Copy link
Member

Is it a type that's imported? That would probably be the best guess

@kfcampbell kfcampbell requested a review from wolfy1339 June 1, 2023 23:02
@kfcampbell
Copy link
Member Author

Interestingly, the type is exported correctly from the .ts file as far as I can tell, but upon build, those types aren't present in the corresponding .js file. There may be an issue with the build process that's preventing the proper artifacts from being emitted.

@wolfy1339
Copy link
Member

You need to explicitly mark the import for types.

Like so:

import type { Foo } from "bar";

@wolfy1339
Copy link
Member

export { PageInfoForward, PageInfoBackward } from "./page-info";

That should be marked explicitly for type exports, the same way as for imports as listed above

@kfcampbell
Copy link
Member Author

🤦 🤦 🤦 Thank you so much! I had clearly missed that.

@kfcampbell kfcampbell marked this pull request as ready for review June 1, 2023 23:13
@kfcampbell kfcampbell merged commit 184513a into main Jun 1, 2023
@kfcampbell kfcampbell deleted the switch-to-esbuild branch June 1, 2023 23:13
@github-actions
Copy link

github-actions bot commented Jun 1, 2023

🎉 This PR is included in version 2.0.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants