Repository navigation
docs(api-types): make the refresh steps runnable and describe the real consumer - #23041
Conversation
…l consumer Two corrections to this README, one reported and one made stale by #22013. The copy-pasteable refresh block ended with bare `oxfmt --write src/generated`. That resolves inside the `check:generated` script, where pnpm puts `node_modules/.bin` on PATH, but not in the shell a human pastes it into: $ cd packages/comfyui-api-types && command -v oxfmt (not found) Now `pnpm exec oxfmt --write src/generated`, verified to run from that directory in a clean environment. The scope section still said nothing imported the package and that `QueuePromptRequestBody` was hand-written, which stopped being true when #22013 merged. It now describes the two members that derive from `PromptWorkflowMetadata` and why they use different operators — the request narrows the map by key, the frame takes the map's value type, because core echoes the map's contents onto the frame rather than the map itself. Also records why `tsconfig.types.json` bundles this package: the frame types are re-exported from `@comfyorg/comfyui-frontend-types` and this package is private, so without the bundle entry the published declarations carry an unresolvable import and `check:types-consumer` fails. That is easy to undo by accident.
🎨 Storybook: ✅ Built — View Storybook🧩 Custom Nodes Ecosystem Matrix: 🟡 Withheld — could not measure
Findings and check detailsExecutes the frontend JS of every registry pack that ships any, against this change, in both renderers. The eight The matrix runs on same-repository version-bump PRs with relevant changes, main-branch pushes, and manual dispatches. This candidate does not qualify, so every expensive stage was skipped. Full docs: scripts/registry-census/README.md Reproduce locally# build one shard's fixture, then run it
python3 scripts/registry-census/build_matrix.py --shard 1/4
MATRIX_RENDERER=vue MATRIX_VUE=1 \
npx vitest run --config vitest.matrix.config.mts
🌾 Fallow: ✅ PassedFindings and check detailsFallow audits the diff for duplication, complexity and dead code. It gates on new findings only, so when the audit completes, a red is something this PR introduced or moved — never inherited backlog. A red can also mean the audit itself did not finish; the details below say which happened. No new findings in the changed files. Full docs: ADR-DEVEX-LINT-0015 Reproduce locally# the base the gate compared against
npx fallow audit --root . --quiet --format json \
--changed-since df6dfd8f146df453738bb13bdcd3c061130353b5
🏛️ Architecture: ✅ PassedFindings and check detailsWarnings (368)
Full docs: Frontend domain catalog Reproduce locallypnpm architecture:check |
|
No actionable comments were generated in the recent review. Walkthrough
Merge Risk:
|
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #23041 +/- ##
=======================================
Coverage 87.62% 87.62%
=======================================
Files 3049 3049
Lines 163734 163734
Branches 41721 41721
=======================================
Hits 143471 143471
Misses 19372 19372
Partials 891 891
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
dante01yoon
left a comment
There was a problem hiding this comment.
Reviewed the README against the package dependency, generated workflow metadata consumers, declaration bundle configuration, and CI scripts. The pnpm exec refresh command and updated consumer description match the repository. No blocking findings. No tests run, as requested.
Follow-up to #22426 and #22013, both merged. Documentation only — no code, no spec, no generated output.
Why
Two problems with
packages/comfyui-api-types/README.md.The refresh steps were not runnable. The copy-pasteable block ended with bare
oxfmt --write src/generated. That resolves inside thecheck:generatedscript, where pnpm putsnode_modules/.binon PATH, but not in the shell someone pastes it into:Reported by @dante01yoon on #22426; the thread was still open when that PR merged.
The scope section described a state that no longer exists. It said nothing imported the package and that
QueuePromptRequestBodywas still hand-written. #22013 made both false.What changed
pnpm exec oxfmt --write src/generated, verified to run from the package directory in a clean environment (env -iwith only node on PATH).PromptWorkflowMetadata, and why they use different operators: the request narrows the map by key, the frame takes the map's value type, because core echoes the map's contents onto the frame rather than the map itself.tsconfig.types.jsonbundles this package — the frame types are re-exported from@comfyorg/comfyui-frontend-typesand this package isprivate, so without the bundle entry the published declarations carry an import no external consumer can resolve andcheck:types-consumerfails. That is easy to remove by accident.Verification Evidence
The
pnpm typecheck:workspacesclaim already in the file was also checked rather than assumed: the script exists and runs inci-lint-format.yamlandci-lint-format-queue.yaml.The pin is unchanged at
8f0da854…, so no regeneration is involved.