fix napi double .d.ts formatting #9238
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
8 Skipped Deployments
|
dimitropoulos
commented
Oct 9, 2024
|
|
||
| # Unfortunately, when napi generates a .d.ts file, it doesn't match our formatting rules (it doesn't have semicolons). | ||
| # Since there's now way to configure this from napi itself, so we need to run prettier on it after generating it. | ||
| node_modules/.bin/prettier --write js/index.d.ts |
There was a problem hiding this comment.
we could really min/max this by switching the script around a bit and only running prettier when not in release mode (we don't generate the file in release mode for some reason), but I thought it'd be simpler to leave it as-is and just always format.
dimitropoulos
commented
Oct 9, 2024
| @@ -5,8 +5,8 @@ | |||
| "bugs": "https:/vercel/turborepo/issues", | |||
| "homepage": "https://turbo.build/repo", | |||
| "scripts": { | |||
| "build": "napi build --platform -p turborepo-napi --cargo-cwd ../../ --cargo-name turborepo_napi native --js false --dts ../js/index.d.ts && mkdir -p js/dist && cp js/index.js js/dist/index.js && cp js/index.d.ts js/dist/index.d.ts", | |||
| "build:release": "napi build --release --platform -p turborepo-napi --cargo-cwd ../../ --cargo-name turborepo_napi native --js false", | |||
There was a problem hiding this comment.
was it intentional that we, previously, didn't generate the dts file when in release mode?
There was a problem hiding this comment.
Probably not, the release process for this package is far more ad-hoc than the primary turbo release workflow.
chris-olszewski
approved these changes
Oct 9, 2024
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.
Description
napi-rsgenerates a .d.ts file for us inturbo-repository. Unfortunately, this file doesn't match our project's formatting (the generated file doesn't include semicolons). This means that every time we locally run a command (for example,pnpm test) that courses through this generation we jiggle this file, creating a lot of noise when developing.This small PR fixes this by simplifying the script and running prettier on it.
Testing Instructions
run
pnpm buildfrompackages/turbo-repositorybefore this PR and see the file change, and notice that after this PR the file change goes away.