docs: clarify type-check workflow with private packages#2629
Merged
Conversation
Spell out that type checking only works per-example, and that any optional/private package must be activated via PRIVATE_ADDITIONAL_DEPENDENCIES (with `yarn install` to link the workspace) and codegen must be re-run before tsgo sees its injected fragments. Documents the three-step workflow that currently fails silently with confusing "field does not exist" errors when skipped.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Two doc additions: - `graphcommerce cleanup-interceptors` restores `.original.*` files over the codegen-wrapped originals. Always run before committing so dozens of unrelated `next-ui`/`magento-*` wrappers don't pollute the diff. - Every feature PR must include a usage example. For UI components, add a demo route under `packages/demo-magento-graphcommerce/copy/pages/test/` and link it from the test overview; for plugins, wire them into one of the example storefronts so the diff shows the integration point.
🦋 Changeset detectedLatest commit: cbe732a The changes in this PR will be included in the next version bump. This PR includes changesets to release 86 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
…t route Earlier wording suggested adding a `pages/test/<feature>.tsx` demo route counted as a showcase. It does not — that route lives outside the real flow, reviewers don't walk through it, and the integration with the storefront stays unproven. Replace the section with a stricter rule: every feature PR must wire the feature into one of the existing example storefronts so it is visible on a real page (product page, account flow, cart page, etc.). The PR's "Test plan" must name the URL the reviewer opens to see it working, and any backend prerequisites (Magento product config, Hygraph content) must be called out.
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
1 participant
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
Documents that you can only type check an example, never the whole repo, and that any optional/private package needs three things done in order before
tsgosees its injected fragments:PRIVATE_ADDITIONAL_DEPENDENCIESyarn installto symlink the workspaceyarn codegenso fragments land in the example's.gql.tsSkipping any of these produces confusing "field does not exist" errors on injected fragments that look like the type system is broken when really the example just hasn't been told the package exists.
Test plan
🤖 Generated with Claude Code