Repository navigation
v12: remove makeitaquote/api, refresh release tooling and docs - #79
Merged
Merged
Conversation
The Voids API client is moving out to its own package, @makeitaquote/voids — it never shared anything with local rendering but input validation, and every release of this package was re-publishing an HTTP client for a third-party service this project doesn't operate. Drops src/api/*, the ./api export, the api example, and the build-boundary checks that existed only to keep the native canvas binding out of that subpath. http/client.ts loses post()/json, which only the Voids client used. BREAKING CHANGE: `makeitaquote/api` no longer exists. Import VoidsMiQ from @makeitaquote/voids instead.
README, MIGRATING, CONTRIBUTING and the bug-report template all referenced makeitaquote/api directly; update them for the new package at otnc/makeitaquote-voids and add the v11->v12 migration entry.
The whole document still titled and dated itself as the v9 design doc despite carrying amendments up through v12. Retitle it, add a short version->section index at the top so §1-§13 read as the historical v9 record they are rather than the current state, and append §19 documenting the decision to split the Voids API client into @makeitaquote/voids: why, what left this repo, and what the new package needs to preserve.
Two real bugs, both hit while trying to cut a 12.0.0-beta.0 for the api-removal branch: - npm publish had no --tag, so a prerelease version would land on the `latest` dist-tag — what `npm install makeitaquote` resolves for everyone. The tag is now derived from the version (major/minor/patch + dist_tag combine into X.Y.Z or X.Y.Z-<dist_tag>.N, N picking up from existing git tags of that exact base+tag), defaulting to latest, with dist_tag as an explicit override. gh release create now marks a non-latest release as --prerelease too. - The gallery job hardcoded `ref: main` and pushed docs back to `HEAD:main` no matter which branch the release job actually ran on. It now follows the release job's own ref, and is skipped entirely for a prerelease — a beta on a working branch has no business regenerating the public gallery.
…nstructions for @makeitaquote/voids
Both were single-call-site conveniences for something small enough to own directly: - segment.ts only used ufo's parseURL() to pull a hostname out of a URL. Native URL does the same job; wrapping the throw it has (that ufo's lenient parser doesn't) in a try/catch keeps the same fall-through-to-null behaviour, and every input that used to reach the HOSTNAME_LIKE filter as garbage now either gets rejected earlier or handled correctly (e.g. IDN hosts now punycode-encode instead of failing the filter). - diskCache.ts only used write-file-atomic for the classic write-temp, fsync, rename-into-place pattern. Reimplemented directly with node:fs/promises; drops the library's mode/chown-preservation (this code never passed those options, so it was never exercised) and its signal-exit-based cleanup of an orphaned temp file on a killed process (the write is of an already-downloaded, already-in-memory buffer, so the interruption window is small, and a leftover .tmp file in the font cache is inert — clearCache()/uninstallFonts() sweep the whole directory anyway).
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.
Summary
makeitaquote/apisubpath entirely —VoidsMiQmoves out to its own package,@makeitaquote/voids.makeitaquotebecomes local-rendering-only.ufoandwrite-file-atomic: both were single-call-site conveniences, replaced withnode:URLand a directnode:fs/promiseswrite-temp/fsync/rename implementation.release.yml: fixes prereleases publishing to thelatestnpm dist-tag, and a hardcodedmainin the gallery job that would push doc regeneration off-branch. Adds aversion/dist_tagcombination scheme (major/minor/patch+dist_tag: rc|alpha|beta|...) with auto-incrementing prerelease numbers from existing git tags.DESIGN.mdretitled and indexed by version so it no longer reads as frozen at v9; adds §19 recording the v12 split decision.Verified against
12.0.0-alpha.0and12.0.0-alpha.1prereleases actually published through the updatedrelease.yml, cut from this branch without touchingmain.Test plan
npm run typechecknpm run ci(Biome)npm run test(785 tests, including the real-filesystem font-cache write path)npm run build && npm run check:build(27 checks)12.0.0-alpha.0/12.0.0-alpha.1published under thealphanpm dist-tag, notlatest