Repository navigation
Conversation
useMap defaults initialState to new Map(), and useMap.spec.ts already calls it with no argument, but the JSDoc listed initialState as required, so the generated docs, the translations and the agent skill reference all marked it required. Document it as [initialState=new Map()], the way useSet documents its initialState, and regenerate the docs and the skill copy. Assisted-by: Claude:claude-opus-5-5
🦋 Changeset detectedLatest commit: 795332e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
This branch has not been deployed
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.
Overview
useMapdefaultsinitialStatetonew Map(), anduseMap.spec.tsalready callsuseMap()with no argument. The JSDoc still listed it as required:So the generated page, its ko/ja/es/zh-Hans translations and the agent skill reference all show
initialStateasrequired, and their signature has no default.This PR documents it as
[initialState=new Map()], the same wayuseSetdocuments itsinitialState([initialState=new Set()]). It then regeneratesuseMap.mdandpackages/plugin/skills/react-simplikit/references/useMap.md, and updates the four translations the same way: therequiredflag is dropped and the signature readsinitialState: MapOrEntries<K, V> = new Map(), as on theuseSetpages. Apatchchangeset is included, following #569.How it was checked:
@paramoptional marker with its signature. Onmain,useMap'sinitialStatewas the only mismatch among 42 functions. On this branch there are none.generateDocs(the code behindyarn docs:gen useMap, which also runsgenerateSkill).yarn installcould not finish on this machine, so the generator files were transpiled with the repo's TypeScript and run under PnP instead of tsx. A control run on unchangedmainreproduced the committed files exactly..scripts/verifyDocs.tsand.scripts/verifySkill.tspass the same way. As a negative check,verifyDocsfails with "useMap.md is out of date" when only the JSDoc is changed.prettier --list-differenton the changed files reports nothing.yarn run fix(ESLint),yarn run test:coverageandverifyDocsI18n. No code changed, so no new test.The investigation and the change were done with Claude Code (Claude Opus 5.5).
Checklist
yarn run fixto format and lint the code and docs?yarn run test:coverageto make sure there is no uncovered line?