Clarify --component flag refers to module name#18
Merged
Conversation
The --component flag's value is the Convex module path prefix where the upload API is exposed (i.e. convex/<module>.ts), not the component name registered in convex.config.ts. The previous wording caused confusion when those names differed.
commit: |
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
The
--component <name>flag in theuploadanddeployCLIs takes a Convex module path prefix (i.e.convex/<name>.ts— the file where you re-exportexposeUploadApi(...)), not the component name registered inconvex.config.ts. The previous help text and docs said "Convex component name", which is misleading when those names differ — e.g. component registered asselfHostingbut upload API exposed inconvex/staticHosting.ts.This PR is doc-only:
--componenthelp text inupload,deploy, and theinit-emitted CLI ReferenceINTEGRATION.mdtroubleshooting section and rewrites it to call out the misnomer explicitlyNo code or default-value changes.
Test plan