add figma.ts with bun #36
Open
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
|
@takanorip Can you please share the motivations behind rewriting the script in TypeScript? |
|
@jmblog |
takanorip
commented
May 5, 2024
| 'X-FIGMA-TOKEN': TOKEN, | ||
| }, | ||
| }); | ||
| const { meta }: GetFileComponentsResponse = await response.json(); |
There was a problem hiding this comment.
Typed with @figma/rest-api-spec
takanorip
commented
May 5, 2024
| 'X-FIGMA-TOKEN': TOKEN, | ||
| }, | ||
| }); | ||
| const { images }: GetImagesResponse = await svgResponse.json(); |
There was a problem hiding this comment.
Typed with @figma/rest-api-spec
jmblog
reviewed
May 6, 2024
package.json
Outdated
| @@ -27,6 +27,7 @@ | |||
| ], | |||
| "scripts": { | |||
| "figma": "node ./scripts/figma.js", | |||
There was a problem hiding this comment.
Should we keep the old one yet?
There was a problem hiding this comment.
I thought this is using it in GitHub Actions, but I noticed the file was deleted recently.
Since it seems unnecessary, I will remove it and add a section about Bun in the README.
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.
I have rewritten the script for downloading SVGs from Figma in TypeScript, and made it runnable on Bun.
https://bun.sh/
While Bun has some problems of making it difficult to check differences in the lock file, there are means provided to check differences on Git, and since this repository only contains small scripts, I consider it not to be a problem.
https://bun.sh/docs/install/lockfile
motivation
Although the values are obtained from Figma's API, I feel that maintainability is low because we have to read the documentation to find out what structure of data is returned from the API.
Figma has published typescript types for its REST API, which will allow API responses to be typed, making them easier to develop.
https://github.com/figma/rest-api-spec
The reasons for adopting Bun are the following 3 points: