fix: TypingAnimation package.json export + dedicated COMPONENTS_REFERENCE entry#25
Merged
Merged
Conversation
Pre-existing gap surfaced during 0.2.0 doc audit: TypingAnimation (src/core/typing-animation.js) is the canonical streaming/typed-reveal class but had no package.json export and no dedicated COMPONENTS_REFERENCE entry. README import examples used the long internal path 'src/core/typing-animation.js' instead of an idiomatic export. Fixes: - package.json: add './typing-animation' → './src/core/typing-animation.js' - docs/COMPONENTS_REFERENCE.md: add ## TypingAnimation section immediately before DecryptReveal so the 3 text-reveal patterns (TypingAnimation | DecryptReveal | PhraseCycle) are contiguous and the conceptual distinction is reinforced - docs/COMPONENTS_REFERENCE.md: TOC entry updated to include TypingAnimation - README.md: 2 import examples updated from long path to './typing-animation' - README.md: dropped deprecated 'glitchChance' option from example code, showed canonical 'duration' + 'bufferEnabled' + 'bufferFlickerSpeed' pattern instead
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
corrupted-theme | bd775b8 | Commit Preview URL Branch Preview URL |
May 18 2026, 10:21 AM |
3 tasks
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
Pre-existing 0.1.x-era gap surfaced during 0.2.0 doc audit:
TypingAnimation(src/core/typing-animation.js) is the canonical streaming/typed-reveal class but had nopackage.jsonexport## TypingAnimationsection indocs/COMPONENTS_REFERENCE.md— only mentioned as comparison points in DecryptReveal / PhraseCycle sections@whykusanagi/corrupted-theme/src/core/typing-animation.jsinstead of an idiomatic exportFixes
package.json— adds"./typing-animation": "./src/core/typing-animation.js"docs/COMPONENTS_REFERENCE.md— new## TypingAnimationsection inserted immediately before## DecryptReveal, so the 3 text-reveal patterns (TypingAnimation | DecryptReveal | PhraseCycle) are contiguous in the doc. TOC entry updated.README.md— 2 import examples updated from the long path to'@whykusanagi/corrupted-theme/typing-animation'. Code examples now use the canonicalduration+bufferEnabled+bufferFlickerSpeedoptions (dropped the deprecatedglitchChancefrom the old examples).Test plan
node -e "require('./package.json').exports['./typing-animation']"→./src/core/typing-animation.jsimport('./src/core/typing-animation.js')loads andTypingAnimation.SFW_JAPANESE.length === 40npm test— 166/166 pass🤖 Generated with Claude Code