docs(0.2.0): document UnmatchedReason values + fix supported versions table#3
Open
BetelGuese wants to merge 1 commit intomainfrom
Open
docs(0.2.0): document UnmatchedReason values + fix supported versions table#3BetelGuese wants to merge 1 commit intomainfrom
BetelGuese wants to merge 1 commit intomainfrom
Conversation
… table Audit (2026-04-26) found three doc gaps that didn't track the 0.2.0 BREAKING change to UnmatchedReason semantics. No code changes. - src/types.ts — add JSDoc to UnmatchedReason and each union member describing what it means. The matchQuery JSDoc already covers the order-dependent "last failure" rule but the type itself was opaque in IDE hover. - README.md — extend the matchQuery API entry with a table of UnmatchedReason values + a 0.2.0 BREAKING note for callers upgrading from 0.1.x (where every failure collapsed to 'no_credential_found'). - SECURITY.md — Supported Versions table only listed 0.1.x. Replace with 0.2.x (current) + 0.1.x marked as superseded. Tests: 116/116 passing. dist/ DTS rebuilds with the new JSDoc.
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
Documentation-only refresh. The 2026-04-26 audit flagged three doc gaps that didn't track the 0.2.0 BREAKING change to
UnmatchedReasonsemantics: the type members had no IDE-hover JSDoc, the README'smatchQueryAPI entry didn't mention the new specific reasons or the migration impact, andSECURITY.md"Supported Versions" still only listed0.1.x.Changes
src/types.ts— add JSDoc to theUnmatchedReasontype and each union member describing what it means. ThematchQueryJSDoc already covers the order-dependent "last failure" rule but the type itself was opaque in IDE hover. This change ships indist/(DTS rebuilt as part of this PR's verification) and is technically the only edit that would surface to npm consumers without a release. No release planned; will land at next functional minor.README.md— extend thematchQueryAPI entry with a markdown table ofUnmatchedReasonvalues + a 0.2.0 BREAKING note for callers upgrading from 0.1.x (where every failure collapsed to'no_credential_found').SECURITY.md— Supported Versions table only listed0.1.x. Replace with0.2.x(current) +0.1.xmarked as superseded.Verification
npm test— 116/116 passing.npm run build— ESM + CJS + DTS clean. The DTS now contains the JSDoc text for hover docs.Test plan
matchQuerytable.