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.

Sign up for GitHub

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

add a script to clean up db output and run it before build script #65

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

add a script to clean up db output and run it before build script #65

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c3eec8
add a script to clean up db output and run it before build script
GGAlanSmithee Mar 5, 2024
8e1740b
use wipe.sh
GGAlanSmithee Mar 6, 2024
e218927
call wipe.sh from root package, and do not run it before build in db …
GGAlanSmithee Mar 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion chess/db/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"types": "build/index.d.ts",
"type": "module",
"scripts": {
"clean": "rm -rf tsconfig.tsbuildinfo & rm -rf build",
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason you put these in the db/package.json instead of the root package.json?

Copy link
Author

@GGAlanSmithee GGAlanSmithee Mar 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

No, not really, I'm just used to localize the scripts to where they are ran, and it made more sense to have it there when the script was rm -rf tsconfig.tsbuildinfo & rm -rf build, but now, that we are using wipe.sh, it does make sense to run it from the root.

However, I would suggest to also run clean when running build, since that is where it is of most use, because if not, it will fail silently (fail as in not produce new output), which was the reason why I wanted to add this in the first place. And in this case, it is a bit awkward to have the clean script in the parent package.json and the build script in db/package.json.

I guess it boils down to if you expect users to run scripts directly from the db package, or always operate from the root.

Copy link
Contributor

Choose a reason for hiding this comment

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

However, I would suggest to also run clean when running build

it should never be required to run clean before build. If your code changes, it will automatically know to rebuild (that's what tsconfig.tsbuildinfo is for). Usually the only time typescript fails to detect changes are cases related to bumping dependencies that include special tools (which is why the wipe.sh command also wipes node_modules

Copy link
Author

Choose a reason for hiding this comment

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

ok, understood. In that case there is something else at play here, I would think. I need to investigate further.

"clean": "sh ../scripts/wipe.sh",
"build": "npm run clean && tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "npx pgtyped -w -c pgtypedconfig.json"
Expand Down
2 changes: 1 addition & 1 deletion hex-battle/backend/db/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"types": "build/index.d.ts",
"type": "module",
"scripts": {
"clean": "rm -rf tsconfig.tsbuildinfo & rm -rf build",
"clean": "sh ../scripts/wipe.sh",
"build": "npm run clean && tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "npx pgtyped -w -c pgtypedconfig.json"
Expand Down
2 changes: 1 addition & 1 deletion nft-lvlup/db/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"types": "build/index.d.ts",
"type": "module",
"scripts": {
"clean": "rm -rf tsconfig.tsbuildinfo & rm -rf build",
"clean": "sh ../scripts/wipe.sh",
"build": "npm run clean && tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "npx pgtyped -w -c pgtypedconfig.json"
Expand Down
2 changes: 1 addition & 1 deletion open-world/db/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"types": "build/index.d.ts",
"type": "module",
"scripts": {
"clean": "rm -rf tsconfig.tsbuildinfo & rm -rf build",
"clean": "sh ../scripts/wipe.sh",
"build": "npm run clean && tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "npx pgtyped -w -c pgtypedconfig.json"
Expand Down
2 changes: 1 addition & 1 deletion paima-dice/db/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"types": "build/index.d.ts",
"type": "module",
"scripts": {
"clean": "rm -rf tsconfig.tsbuildinfo & rm -rf build",
"clean": "sh ../scripts/wipe.sh",
"build": "npm run clean && tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "npx pgtyped -w -c pgtypedconfig.json"
Expand Down
2 changes: 1 addition & 1 deletion rock-paper-scissors/db/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"types": "build/index.d.ts",
"type": "module",
"scripts": {
"clean": "rm -rf tsconfig.tsbuildinfo & rm -rf build",
"clean": "sh ../scripts/wipe.sh",
"build": "npm run clean && tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "npx pgtyped -w -c pgtypedconfig.json"
Expand Down
2 changes: 1 addition & 1 deletion trading-cards/db/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"types": "build/index.d.ts",
"type": "module",
"scripts": {
"clean": "rm -rf tsconfig.tsbuildinfo & rm -rf build",
"clean": "sh ../scripts/wipe.sh",
"build": "npm run clean && tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "npx pgtyped -w -c pgtypedconfig.json"
Expand Down
2 changes: 1 addition & 1 deletion web-2.5/db/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"types": "build/index.d.ts",
"type": "module",
"scripts": {
"clean": "rm -rf tsconfig.tsbuildinfo & rm -rf build",
"clean": "sh ../scripts/wipe.sh",
"build": "npm run clean && tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
"test": "echo \"Error: no test specified\" && exit 1",
"compile": "npx pgtyped -w -c pgtypedconfig.json"
Expand Down