feat: export expected-pattern engine, refresh docs, untrack artifacts#174
Merged
Merged
Conversation
…ed docs artifacts - Re-export parseExpectedPatterns, extractCaptures, tagExpectedRegions, and cleanTemplate from the package root (with a red-first export test) - README: drop stale "Recent Updates" section; fix onProcessing examples (array type, timing.main/cleanup fields, segment count); complete the Props table (snippet props, compact, expected class); add Programmatic API - Stop tracking @humanspeak/docs-kit vite build artifacts (sitemap/demo manifests, static doc & example mirrors, social cards); they regenerate at build time and are now gitignored Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Round out the programmatic API so consumers can annotate the return types of parseExpectedPatterns and extractCaptures instead of relying on inference. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Important Review skippedAuto reviews are limited based on label configuration. 🏷️ Required labels (at least one) (1)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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.
Summary
Broadens the library's reuse surface and tidies its docs. The expected-pattern engine — previously only reachable by mounting the component — is now exported as framework-agnostic functions, the README is corrected and completed, and generated docs-kit build artifacts are removed from version control (kept on disk, regenerated at build time).
No runtime behavior changes to the component; this is additive API + docs + repo hygiene.
Changes
✨ New public API
parseExpectedPatterns,extractCaptures,tagExpectedRegions,cleanTemplate— usable without the Svelte component.ParseResultandExtractResulttypes so consumers can annotate return values instead of relying on inference.ParseResult's implementation-detail fields (groups,parts,matches,linePatterns) are marked@internal — not part of the stable public API; may change in any future release, keeping refactor freedom;cleanedTextstays a stable field.📚 Documentation
onProcessingexamples: the second arg isSvelteDiffTuple[](not a single tuple), and the timing fields aretiming.main/timing.cleanup(the oldcomputeTime/cleanupTimenever existed).compact+ theexpectedrenderer class), mirroring the docs site.🧪 Testing
ParseResult/ExtractResult. Lib suite: 79 → 81 tests, all passing.🔧 Repo hygiene
@humanspeak/docs-kitvite plugins (sitemap/demo manifests,demo-loaders.ts,demo-virtual.d.ts,static/docs+static/examplesmirrors, 38 social-card PNGs) and gitignored them under one block, matching the existing convention (llms.txt/llms-full.txtwere already ignored). Files remain on disk; nothing is deleted.Commits
989e1fafeat: export expected-pattern engine, refresh README, untrack generated docs artifacts5b759cdfeat: export ParseResult and ExtractResult types