chore: rewrite READMEs purpose-first and drop the build script for prepack - #12
Merged
Merged
Conversation
The types package already relied on prepack alone; the downgrader kept a duplicate build script that nothing referenced. pnpm pack still runs unbuild through prepack.
…ENSE Every README now opens with what the project or package is for, uses the orpc badge block (codecov, npm downloads, license, Discord, DeepWiki), and ends with a License section after the generated sponsors block. The downgrader mapping tables are tightened and gain two previously undocumented behaviors. The LICENSE file backs the MIT declaration already in each package.json.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
✅ No new issues found.
I read the full diff (all 6 files) and verified the substantive claims in it against the repo:
buildscript removal is safe. I grepped every script, workflow, and config in the repo (CI not building, no docs/lint-staged references) — nothing referenced thebuildscript.prepack: unbuildstill drivespnpm pack/publish, and now matches the types package exactly.- Newly documented downgrader behaviors check out against source and tests: path parameters gain
required: true(v3.1-to-v3.0.tsconvertParameterOrHeader, tested atv3.1-to-v3.0.test.ts:443), emptyrequiredarrays dropped (tested at:1186),format: byte/binaryonly when noformatexists (convertContentKeywords),const: null→nullable: true(convertConst), and multi-typeanyOfvariants each nullable whennullwas listed (applyTypes). - Types README claims check out:
@deprecatedtags exist in the v3.1/v3.2 sources,styleliterals are version-specific, thetests/schema/failcorpus is indeed not committed, and the downgrader corpus tests reuse the fixtures as claimed. - The function-signature table matches the actual exports (notably
downgradeSchemaV31ToV30returningSchemaObject | ReferenceObject). - ESLint passes clean on all four changed READMEs.
The LICENSE year (2026) matches the repo's release window, and the new README content is accurate, self-contained, and internally consistent. Merge when ready.
DeepSeek Flash (default — pick a model for stronger reviews) | 𝕏
This file contains hidden or 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
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.

Rewrites every README to open with what the project and each package are for, and lines them up with the orpc README shape: centered title, badge block (codecov, npm downloads, MIT license, Discord, DeepWiki), package table, and a License footer. Also removes the redundant
buildscript from the downgrader soprepackalone drives publishing, and adds the MIT LICENSE file the packages already declared.Docs
required: true, and emptyrequiredarrays are dropped.sync-sponsorsruns end to end and reports zero changes with the new License section after it.Packaging
pnpm packon the downgrader still runs unbuild viaprepack; nothing in docs or CI referencedbuild.Testing