fix(build): use typescript to produce declaration files

[kfcampbell]

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

---

[wolfy1339]

I'm not sure why there is a build system here. It isn't very useful here as there isn't any JavaScript code at all, it's only types.

I propose to instead remove the need for the build system instead and simply just use typescript to produce declaration filea.

[gr2m]

I propose to instead remove the need for the build system instead and simply just use typescript to produce declaration filea.

Agreed

[kfcampbell]

Hi, I'm just coming back to this now.

I propose to instead remove the need for the build system instead and simply just use typescript to produce declaration filea.

I'm happy to strip out esbuild, glob, and the current build system. Are there other actions I'm missing that are required to produce declaration files, or is the existence of the files themselves enough?

[wolfy1339]

I'm happy to strip out esbuild, glob, and the current build system. Are there other actions I'm missing that are required to produce declaration files, or is the existence of the files themselves enough?

• Strip out esbuild and glob.
• Keep the tsconfig.json just as it is in this PR
• Keep typescript in the build command

[wolfy1339]

We will still need a build script to generate the package.json, so don't completely remove the build script

[wolfy1339]

Indentation needs fixing

[kfcampbell]

npm run lint:fix reports correct indentation for me.

[kfcampbell]

I've added an Actions step to run npm run build, which wasn't previously being done here. I can reproduce the error locally, though I'm not sure why it's happening yet as the license file does exist in the repo. More troubleshooting is required here.

[wolfy1339]

This workflow is independent of any specific Node version, so use the latest LTS release available on GitHub actions. Like in other repositories

[wolfy1339]

I see why. The directory doesn't exist at the time we try to copy

[kfcampbell]

Ahh, yep! I've added a call to mkdir there. Now the generated files after building look like:

 sh$ ls -R pkg/
pkg/:
dist-types/  LICENSE  package.json  README.md

pkg/dist-types:
AuthInterface.d.ts                      RequestInterface.d.ts
EndpointDefaults.d.ts                   RequestMethod.d.ts
EndpointInterface.d.ts                  RequestOptions.d.ts
EndpointOptions.d.ts                    RequestParameters.d.ts
Fetch.d.ts                              RequestRequestOptions.d.ts
generated/                              ResponseHeaders.d.ts
GetResponseTypeFromEndpointMethod.d.ts  Route.d.ts
index.d.ts                              Signal.d.ts
OctokitResponse.d.ts                    StrategyInterface.d.ts
RequestError.d.ts                       Url.d.ts
RequestHeaders.d.ts                     VERSION.d.ts

pkg/dist-types/generated:
Endpoints.d.ts

which seems correct to me.

[wolfy1339]

Why target the beta branch? It would be fine in main

[kfcampbell]

Ahh, I was thinking to batch with the present changes there but I realize this shouldn't be a breaking change so there's no reason to do so. I've changed it back now.

[octokitbot]

🎉 This PR is included in version 9.3.2 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀