Skip to content

Add a clean script for local build and runtime artifacts#28

Merged
emrekayat merged 2 commits into
emrekayat:mainfrom
Caneryy:feat/clean-script-issue-23
Jun 28, 2026
Merged

Add a clean script for local build and runtime artifacts#28
emrekayat merged 2 commits into
emrekayat:mainfrom
Caneryy:feat/clean-script-issue-23

Conversation

@Caneryy

@Caneryy Caneryy commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a root npm run clean command backed by a small cross-platform Node script.
  • Remove workspace dist and coverage directories plus local API runtime files under apps/api/data.
  • Document when to run clean in the README quality gates section.

Test plan

  • npm run build and npm run test:coverage to generate local artifacts
  • npm run clean removes dist, coverage, and apps/api/data runtime files
  • npm run check:source-artifacts passes after clean

Closes #23

@vercel

vercel Bot commented Jun 27, 2026

Copy link
Copy Markdown

@Caneryy is attempting to deploy a commit to the emrekayat's projects Team on Vercel.

A member of the Team first needs to authorize it.

@drips-wave

drips-wave Bot commented Jun 27, 2026

Copy link
Copy Markdown

@Caneryy Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@emrekayat

Copy link
Copy Markdown
Owner

Thanks for the PR for #23. The clean command works locally and the requested checks pass on this branch, but I cannot merge it yet after the latest main update.

Current blocker:

  • #25 Expose build/version metadata in the health endpoint #29 added a tracked apps/api/data/.gitkeep so the runtime data directory can stay present while ignoring generated DB/WAL files. This PR's npm run clean currently removes every entry under apps/api/data, which would delete that tracked .gitkeep once merged with latest main and leave the working tree dirty after running the cleanup command.

Please rebase on latest main and update the clean script to preserve apps/api/data/.gitkeep while still removing runtime artifacts such as .db, .db-wal, .db-shm, and generated JSON files. After that, please rerun npm run clean, npm run check:source-artifacts, npm run format:check, npm run typecheck, and npm run build.

@emrekayat

Copy link
Copy Markdown
Owner

Thanks for the focused implementation. I checked this locally from the PR branch as the maintainer account.

What passes:

  • npm run typecheck
  • npm run build
  • npm run lint (warnings only)
  • npm run format:check
  • npm run clean && npm run check:source-artifacts for workspace artifacts under apps/*, packages/*, and apps/api/data

One acceptance gap before merge: the issue/README copy says the command removes local build output dist and coverage coverage, but the script only walks apps and packages. A root-level ./dist or ./coverage directory is left behind by npm run clean.

Please update scripts/clean.mjs to also remove root dist and root coverage (while keeping the existing workspace cleanup and apps/api/data behavior), then rerun:

npm run clean
npm run check:source-artifacts
npm run typecheck
npm run build

Note: GitHub Actions is currently failing on a Rollup optional dependency install issue (@rollup/rollup-linux-x64-gnu), which looks CI-environment related rather than caused by this PR. I am not blocking on the Vercel authorization check either, but I do need the root artifact cleanup fixed before merging #23.

Add a cross-platform Node clean command that removes workspace dist and coverage output plus local API runtime data, and document it in README.
@Caneryy Caneryy force-pushed the feat/clean-script-issue-23 branch from 9379437 to 8d4627a Compare June 28, 2026 12:03
Keep apps/api/data/.gitkeep after clean, remove only runtime DB/JSON
files, and delete root-level dist and coverage directories.

Co-authored-by: Cursor <cursoragent@cursor.com>
@Caneryy

Caneryy commented Jun 28, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the detailed review @emrekayat — both blockers are addressed.

Changes:

Verified locally:

  • npm run clean.gitkeep preserved, runtime files removed, root/workspace artifacts cleaned
  • npm run check:source-artifacts
  • npm run format:check
  • npm run typecheck
  • npm run build

Ready for re-review.

@emrekayat emrekayat merged commit abddb8e into emrekayat:main Jun 28, 2026
0 of 2 checks passed
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.

Add a clean script for local build and runtime artifacts

2 participants