Repository navigation
[AI slop, WIP] README: which helper do I need? + stop publishing top-level test files - #1028
Draft
sethconvex wants to merge 2 commits into
Draft
sethconvex wants to merge 2 commits into
sethconvex wants to merge 2 commits into
Conversation
Maps each problem to the entry point and import path that solves it, and names the components that supersede the retries, rateLimit and migrations helpers. Points external-API-at-volume work at batch-worker, workpool, rate-limiter and action-cache. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
`rm **/*.test.*` runs in sh, where ** is *, so it removed tests one level down but left browser.test.ts, index.test.ts, react.test.ts, standardSchema.test.ts, validators.test.ts and functionReferences.test.ts in the published package (present in convex-helpers@0.1.128). Remove both levels and add *.test.* to .npmignore. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
commit: |
sethconvex
changed the title
Member
|
note: #1024 and another stacked PR are changing some plumbing that may affect this |
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.
Part of the agent-facing docs work. Companion PRs: get-convex/convex#59661 (docs pages + llms.txt, stacked on get-convex/convex#58344), get-convex/convex-agents#108 (agent skill content).
README: "Which helper do I need?"
Adds a table at the top of the README, which ships in the npm package where coding agents read it. Each row maps a problem to the export and import path that solves it and links to the README section. A second table names the components to use instead of the
retries,rateLimitandmigrationshelpers. A closing paragraph sends work that calls third-party APIs for many items to batch-worker, workpool, rate-limiter and action-cache. Every link points to a README anchor or a live convex.dev component page.Build: stop publishing top-level test files
The build runs
rm **/*.test.*insh, where**behaves like*, so it deletes tests one directory down but leaves the top-level ones. The published convex-helpers@0.1.128 shipsbrowser.test.ts,index.test.ts,react.test.ts,standardSchema.test.ts,validators.test.tsandfunctionReferences.test.ts, which agents then find when they grepnode_modules. The build now removes both levels, and.npmignoreexcludes*.test.*.Tests
npm run buildnow leaves 0 test files indist, andnpm pack --dry-runlists none.npm run lintpasses: eslint, typecheck and prettier.🤖 Generated with Claude Code