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: remove extra protos file #5696

Merged
merged 3 commits into from
Sep 30, 2024
Merged

fix: remove extra protos file #5696

merged 3 commits into from
Sep 30, 2024

Conversation

sofisl
Copy link
Contributor

@sofisl sofisl commented Sep 20, 2024

For some reason we're publishing an extra protos file. Adding this in to make sure we don't re-add protos once we've run compile. FYI that we'll also need to make this change in the generator (will do). Publishing as a fix since this will reduce its package size from 17MB to 9MB.

@sofisl sofisl requested review from yoshi-approver and a team as code owners September 20, 2024 22:23
@@ -75,7 +75,7 @@
"compile:esm": "tsc -p ./tsconfig.esm.json && cp -r esm/src/json-helper.cjs build/esm/src/json-helper.cjs",
"babel": "babel esm --out-dir build/cjs --ignore \"esm/**/*.d.ts\" --extensions \".ts\" --out-file-extension .cjs --copy-files",
"compile:cjs": "tsc -p ./tsconfig.json && npm run babel",
"compile": "npm run compile:esm && npm run compile:cjs && cp -r protos build/protos"
"compile": "npm run compile:esm && npm run compile:cjs && rm -rf build/protos && cp -r protos build/protos"
Copy link
Contributor

Choose a reason for hiding this comment

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

To enable non-POSIX compatibility (e.g. Windows) we could make this an inline node script rather than rm -rf:

Suggested change
"compile": "npm run compile:esm && npm run compile:cjs && rm -rf build/protos && cp -r protos build/protos"
"compile": "npm run compile:esm && npm run compile:cjs && node -e \"fs.rm('build/protos', {recursive: true})\" && cp -r protos build/protos"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since technically we don't support Windows (we don't have windows tests), and technically speaking you could compile this library without having Node, I think it's better to keep as is.

Copy link
Contributor

Choose a reason for hiding this comment

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

With npm as a prerequisite means there is a version of node available in the $PATH. Also we do support Windows; while we don't have any OS-specific tests customers are certainly using Windows. Here are a few examples where this can bite customers:

Either way, this would be best practice, but no one's filed an issue yet.

@@ -75,7 +75,7 @@
"compile:esm": "tsc -p ./tsconfig.esm.json && cp -r esm/src/json-helper.cjs build/esm/src/json-helper.cjs",
"babel": "babel esm --out-dir build/cjs --ignore \"esm/**/*.d.ts\" --extensions \".ts\" --out-file-extension .cjs --copy-files",
"compile:cjs": "tsc -p ./tsconfig.json && npm run babel",
"compile": "npm run compile:esm && npm run compile:cjs && cp -r protos build/protos"
"compile": "npm run compile:esm && npm run compile:cjs && rm -rf build/protos && cp -r protos build/protos"
Copy link
Contributor

Choose a reason for hiding this comment

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

With npm as a prerequisite means there is a version of node available in the $PATH. Also we do support Windows; while we don't have any OS-specific tests customers are certainly using Windows. Here are a few examples where this can bite customers:

Either way, this would be best practice, but no one's filed an issue yet.

@sofisl sofisl merged commit 4676845 into main Sep 30, 2024
13 checks passed
@sofisl sofisl deleted the fixDoubleProtosProblems branch September 30, 2024 21:03
@release-please release-please bot mentioned this pull request Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants