docs(skills): fix anime.js v3 syntax in v4 adapter guidance - #3064
Merged
miguel-heygen merged 2 commits intoAug 16, 2026
Conversation
youngeuibae
force-pushed
the
fix/animejs-v4-adapter-docs
branch
from
August 6, 2026 08:24
a3b4689 to
3e98e2b
Compare
youngeuibae
changed the title
miguel-heygen
approved these changes
Aug 6, 2026
The animejs adapter docs teach v3 syntax against a v4 build, so the examples
cannot run as written: every v4 bundle assigns a *namespace object* to the
global `anime`, making v3's `anime({ targets })` call form a TypeError. `easing:`
is now `ease:`, ease names lost their `ease` prefix, and `timeline.add()` takes
`(targets, parameters, position)`.
- Rewrite `skills/hyperframes-animation/adapters/animejs.md` for v4:
`anime.animate()` / `anime.createTimeline()`, `ease:` names, targets-first
`add()`, position shorthands, and a note that the producer fixtures pin
4.0.2 (`lib/`) while 4.1+ moved bundles to `dist/bundles/`.
- Fix the same v3 `anime.timeline({ targets })` snippet in
`skills/hyperframes-keyframes/references/keyframe-patterns.md`.
- Stop advertising `anime.running` auto-discovery as a safety net. No v4 build
exports `running` (checked 4.0.2 and 4.5.0), so `discover()` returns
immediately and any instance a composition forgets to push onto
`window.__hfAnime` is silently never seeked. Marked v3-only/inert in the
skill page and the adapter docstring; explicit registration is now stated
as mandatory.
- Add render-safety notes the page lacked: `createSeededRandom()` as the
deterministic replacement for `Math.random()`, and why
`autoplay: onScroll(...)`, `createDraggable`, and pointer-driven
`createAnimatable` cannot work under headless seek rendering.
- Regenerate skills-manifest.json.
Runtime behaviour is unchanged: the `packages/core` edit is comment-only, and
the seek path already works on v4 (registered instances expose
seek/pause/play). The now-dead `anime.running` branch in `discover()` is left
in place — it is guarded and try/caught, and removing it is a behaviour change
that belongs in its own PR.
miguel-heygen
force-pushed
the
fix/animejs-v4-adapter-docs
branch
from
August 16, 2026 17:37
3e98e2b to
37fab5a
Compare
miguel-heygen
approved these changes
Aug 16, 2026
miguel-heygen
left a comment
miguel-heygen
left a comment
Collaborator
There was a problem hiding this comment.
Reviewed at 37fab5a7fdbdba1e4754ed3ab0ac76c9a4f8a0a1.
The v4 API claims match the published 4.0.2 and 4.5.0 packages and the official v4 API shape. Executable examples now use animate(targets, params) / createTimeline(), explicit adapter registration is accurately required, the public and local global types no longer teach v3, and the new source contract test protects both the examples and type shapes. The contributor's authored commit remains intact after the rebase.
No code-level blockers found. Required CI should remain the merge gate.
Verdict: APPROVE
Reasoning: The issue is reproduced, the fix covers every repository guidance/type surface found, regression coverage exercises the failure mode, and targeted tests plus manifest/format/lint checks pass.
— Magi
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
2 participants
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.
Problem
The Anime.js guidance loaded a v4 bundle but taught the incompatible v3 API:
Anime.js v4 exposes a namespace object instead:
anime.animate(targets, params)andanime.createTimeline(). It also renamedeasingtoease, changed ease names, and moved timeline targets to the firstadd()argument. v4 also has noanime.running, so the documented auto-discovery fallback cannot discover v4 instances.Changes
window.__hfAnimeregistration and document deterministic v4 usage.animeglobal types with v4 while retaining optional v3runningdiscovery for compatibility.skills-manifest.json.The producer fixtures remain on
animejs@4.0.2/lib/anime.iife.min.js; that URL still resolves and those fixtures already use the correct v4createTimeline()API.Attribution
The documentation fix remains authored by @youngeuibae in the first commit. The branch was rebased onto current
main, and the maintainer follow-up only adds the missing type alignment and regression guard.Verification
animejs@4.0.2andanimejs@4.5.0exports inspected: both exposeanimate/createTimeline, neither exposes a callable default orrunning.node --test scripts/animejs-v4-guidance.test.mjs— 5/5 pass.vitest run --environment jsdom packages/core/src/runtime/adapters/animejs.test.ts— 15/15 pass.oxfmtcheck andoxlinton changed source/test files — clean.bun packages/cli/scripts/gen-skills-manifest.ts --check— in sync.Full workspace typechecking is left to CI because this isolated review worktree intentionally has no installed/generated workspace dependency tree.
Fixes #3293