Skip to content
This repository was archived by the owner on Oct 21, 2026. It is now read-only.

docs(video.js): add usage, an ai quickstart, and an agent guide - #3128

Closed
mihar-22 wants to merge 2 commits into
t3code/verify-videojs-vite-setupfrom
docs/video-js-package-guide
Closed

mihar-22 wants to merge 2 commits into
t3code/verify-videojs-vite-setupfrom
docs/video-js-package-guide

Conversation

@mihar-22

@mihar-22 mihar-22 commented Oct 1, 2026

Copy link
Copy Markdown
Member

Stacked on #3113.

Summary

Document the video.js package for people and coding agents, and add a type test that guards #3113's tag typing at the video.js boundary.

Changes

  • README Usage. import 'video.js', the three-tag markup, and driving the player through store and the selectors the root re-exports, including the store.target check before calling actions.
  • README AI Quickstart. Print the Video.js skill install steps and HTML installation instructions with @videojs/cli, pinned to the installed video.js version. The CLI's version check reads @videojs/html/@videojs/react, not video.js, so an unpinned CLI can drift. The instructions install @videojs/html, and readers should keep the version video.js already brings.
  • AGENTS.md / CLAUDE.md (package-level, not published). Records the boundaries an agent would get wrong: legacy detection never leaves this package, CDN parity, setup-time-only stubs, and the root's prod build never shipping registry text while video.js/errors does. Also the four-step checklist for adding a VJS8_LEGACY_* code, including the site page and sidebar entry.
  • src/tests/index.test-d.ts. Resolves @videojs/html through its built declarations and checks that import 'video.js' types <video-player> and <video-skin> by tag name. It runs under pnpm typecheck.

Testing

  • The type test fails against @videojs/html built from main (Property 'store' does not exist on type 'Element') and passes with fix(html): type preset tags and stop store installing react #3113.
  • pnpm -F video.js test (31), pnpm -F site test legacy-error, pnpm typecheck, and pnpm check:workspace (agent-context budgets).
  • I ran every README and AGENTS.md command against the local CLI build. A separate review-branch pass checked the factual claims against code.

🤖 Generated with Claude Code

Resolve `@videojs/html` through its built declarations and check that
`import 'video.js'` types `<video-player>` and `<video-skin>` by tag
name, so a define entry that drops its augmentation fails typecheck.
The README shows the one-import setup and the player store API, then
points coding agents at the Video.js skill and version-pinned
`agents init` instructions. AGENTS.md records the package boundaries
and the checklist for adding a legacy error code.
@vercel

vercel Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
v10-sandbox Ready Ready Preview Oct 1, 2026 9:14pm UTC

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Oct 1, 2026

Copy link
Copy Markdown
@videojs/cdn

pnpm add https://pkg.pr.new/@videojs/cdn@3128

@videojs/cli

pnpm add https://pkg.pr.new/@videojs/cli@3128

@videojs/core

pnpm add https://pkg.pr.new/@videojs/core@3128

@videojs/element

pnpm add https://pkg.pr.new/@videojs/element@3128

@videojs/html

pnpm add https://pkg.pr.new/@videojs/html@3128

@videojs/media

pnpm add https://pkg.pr.new/@videojs/media@3128

@videojs/react

pnpm add https://pkg.pr.new/@videojs/react@3128

@videojs/spf

pnpm add https://pkg.pr.new/@videojs/spf@3128

@videojs/store

pnpm add https://pkg.pr.new/@videojs/store@3128

@videojs/utils

pnpm add https://pkg.pr.new/@videojs/utils@3128

@videojs/cloudflare-video

pnpm add https://pkg.pr.new/@videojs/cloudflare-video@3128

@videojs/dash-video

pnpm add https://pkg.pr.new/@videojs/dash-video@3128

@videojs/hlsjs-video

pnpm add https://pkg.pr.new/@videojs/hlsjs-video@3128

@videojs/mux-audio

pnpm add https://pkg.pr.new/@videojs/mux-audio@3128

@videojs/mux-video

pnpm add https://pkg.pr.new/@videojs/mux-video@3128

@videojs/native-hls-video

pnpm add https://pkg.pr.new/@videojs/native-hls-video@3128

@videojs/shaka-video

pnpm add https://pkg.pr.new/@videojs/shaka-video@3128

@videojs/spotify-audio

pnpm add https://pkg.pr.new/@videojs/spotify-audio@3128

@videojs/tiktok-video

pnpm add https://pkg.pr.new/@videojs/tiktok-video@3128

@videojs/twitch-video

pnpm add https://pkg.pr.new/@videojs/twitch-video@3128

@videojs/vimeo-video

pnpm add https://pkg.pr.new/@videojs/vimeo-video@3128

@videojs/wistia-video

pnpm add https://pkg.pr.new/@videojs/wistia-video@3128

@videojs/youtube-video

pnpm add https://pkg.pr.new/@videojs/youtube-video@3128

@videojs/google-cast

pnpm add https://pkg.pr.new/@videojs/google-cast@3128

@videojs/mux-data

pnpm add https://pkg.pr.new/@videojs/mux-data@3128

commit: cd32656

@github-actions

github-actions Bot commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

📦 Bundle Size Report

🎨 @videojs/html — no changes
Presets (7)
Entry Initial Lazy
/video (default) 65.26 kB 56.03 kB
/video (default + hls) 67.12 kB 56.03 kB
/video (neutral) 65.75 kB 56.03 kB
/video (neutral + hls) 67.52 kB 56.03 kB
/audio (default) 49.09 kB 56.03 kB
/audio (neutral) 49.45 kB 56.03 kB
/background 12.76 kB 56.03 kB
Media (18)
Entry Initial
/media/mux-video 3.03 kB
/media/mux-audio 2.71 kB
/media/background-video 1.17 kB
/media/cloudflare-video 2.91 kB
/media/dash-video 2.63 kB
/media/hls-audio 23.54 kB
/media/hls-background-video 17.56 kB
/media/hls-video 33.95 kB
/media/hlsjs-video 2.64 kB
/media/mux-background-video 17.58 kB
/media/native-hls-video 7.54 kB
/media/shaka-video 2.64 kB
/media/spotify-audio 3.03 kB
/media/tiktok-video 3.14 kB
/media/twitch-video 2.94 kB
/media/vimeo-video 2.92 kB
/media/wistia-video 615 B
/media/youtube-video 2.91 kB
Players (5)
Entry Initial Lazy
/video/player 10.85 kB 56.03 kB
/audio/player 7.05 kB 56.03 kB
/background/player 5.34 kB 56.03 kB
/live-video/player 10.23 kB 56.03 kB
/live-audio/player 7.06 kB 56.03 kB
Skins (41)
Entry Type Initial Lazy
/video/compat-skin.css css 7.48 kB —
/video/neutral-skin.css css 8.33 kB —
/video/skin.css css 8.05 kB —
/video/compat-skin js 62.40 kB 56.03 kB
/video/compat-skin2 js 7.45 kB —
/video/neutral-skin js 63.28 kB 56.03 kB
/video/neutral-skin2 js 8.32 kB —
/video/skin js 62.92 kB 56.03 kB
/video/skin2 js 8.02 kB —
/audio/compat-skin.css css 6.13 kB —
/audio/neutral-skin.css css 6.07 kB —
/audio/skin.css css 5.80 kB —
/audio/compat-skin js 53.92 kB 56.03 kB
/audio/compat-skin2 js 6.13 kB —
/audio/neutral-skin js 47.06 kB 56.03 kB
/audio/neutral-skin2 js 6.05 kB —
/audio/skin js 46.78 kB 56.03 kB
/audio/skin2 js 5.78 kB —
/background/skin.css css 141 B —
/background/skin js 10.18 kB 56.03 kB
/background/skin2 js 159 B —
/live-video/compat-skin.css css 6.92 kB —
/live-video/neutral-skin.css css 6.82 kB —
/live-video/skin.css css 6.72 kB —
/live-video/compat-skin js 53.70 kB 56.03 kB
/live-video/compat-skin2 js 6.91 kB —
/live-video/neutral-skin js 50.90 kB 56.03 kB
/live-video/neutral-skin2 js 6.82 kB —
/live-video/skin js 50.90 kB 56.03 kB
/live-video/skin2 js 6.72 kB —
/live-audio/compat-skin.css css 5.63 kB —
/live-audio/neutral-skin.css css 4.77 kB —
/live-audio/skin.css css 4.67 kB —
/live-audio/compat-skin js 40.87 kB 56.03 kB
/live-audio/compat-skin2 js 5.64 kB —
/live-audio/neutral-skin js 36.28 kB 56.03 kB
/live-audio/neutral-skin2 js 4.77 kB —
/live-audio/skin js 36.21 kB 56.03 kB
/live-audio/skin2 js 4.66 kB —
/global.css css 239 B —
/shadow.css css 78 B —
UI Components (62)
Entry Initial Lazy
/ui/airplay-button 11.57 kB 56.03 kB
/ui/alert-dialog 8.99 kB 56.03 kB
/ui/audio-track-radio-group 11.68 kB 56.03 kB
/ui/buffering-indicator 8.91 kB 56.03 kB
/ui/captions-button 11.83 kB 56.03 kB
/ui/captions-radio-group 11.73 kB 56.03 kB
/ui/cast-button 11.56 kB 56.03 kB
/ui/container 9.79 kB 56.03 kB
/ui/controls 9.10 kB 56.03 kB
/ui/controls-backdrop 1.69 kB 56.03 kB
/ui/controls-content 1.67 kB 56.03 kB
/ui/dialog 8.92 kB 56.03 kB
/ui/dialog-backdrop 1.70 kB 56.03 kB
/ui/dialog-close 2.06 kB 56.03 kB
/ui/dialog-description 1.69 kB 56.03 kB
/ui/dialog-popup 1.90 kB 56.03 kB
/ui/dialog-title 1.69 kB 56.03 kB
/ui/error-dialog 12.69 kB 56.03 kB
/ui/fullscreen-button 11.57 kB 56.03 kB
/ui/gesture 10.01 kB 56.03 kB
/ui/hotkey 10.40 kB 56.03 kB
/ui/live-button 10.09 kB 56.03 kB
/ui/menu 19.25 kB 56.03 kB
/ui/menu-checkbox-item 1.97 kB 56.03 kB
/ui/menu-content 7.65 kB 56.03 kB
/ui/menu-group 2.09 kB 56.03 kB
/ui/menu-group-label 1.64 kB —
/ui/menu-item 2.29 kB 56.03 kB
/ui/menu-item-indicator 1.38 kB 56.03 kB
/ui/menu-radio-group 3.03 kB 56.03 kB
/ui/menu-radio-item 2.14 kB 56.03 kB
/ui/menu-separator 1.30 kB 56.03 kB
/ui/mute-button 11.59 kB 56.03 kB
/ui/pip-button 11.54 kB 56.03 kB
/ui/play-button 11.53 kB 56.03 kB
/ui/playback-rate-button 11.63 kB 56.03 kB
/ui/playback-rate-radio-group 11.69 kB 56.03 kB
/ui/popover 8.77 kB 56.03 kB
/ui/poster 9.21 kB 56.03 kB
/ui/quality-radio-group 12.18 kB 56.03 kB
/ui/seek-button 11.58 kB 56.03 kB
/ui/seek-indicator 13.39 kB 56.03 kB
/ui/seek-indicator-value 1.10 kB —
/ui/slider 11.94 kB 56.03 kB
/ui/slider-preview 2.01 kB 56.03 kB
/ui/status-announcer 10.94 kB 56.03 kB
/ui/status-indicator 13.34 kB 56.03 kB
/ui/status-indicator-value 1.10 kB —
/ui/thumbnail 10.64 kB 56.03 kB
/ui/time 11.36 kB 56.03 kB
/ui/time-slider 13.44 kB 56.03 kB
/ui/time-slider-chapter-title 9.10 kB 56.03 kB
/ui/time-slider-chapters 9.92 kB 56.03 kB
/ui/title 8.48 kB 56.03 kB
/ui/tooltip 10.15 kB 56.03 kB
/ui/tooltip-label 1.21 kB —
/ui/tooltip-shortcut 1.18 kB —
/ui/volume-indicator 13.31 kB 56.03 kB
/ui/volume-indicator-fill 1.11 kB —
/ui/volume-indicator-value 1.10 kB —
/ui/volume-popover 15.21 kB 56.03 kB
/ui/volume-slider 12.65 kB 56.03 kB
⚛️ @videojs/react — no changes
Presets (7)
Entry Initial Lazy
/video (default) 58.83 kB 56.03 kB
/video (default + hls) 59.45 kB 56.03 kB
/video (neutral) 58.95 kB 56.03 kB
/video (neutral + hls) 59.42 kB 56.03 kB
/audio (default) 45.71 kB 56.03 kB
/audio (neutral) 45.78 kB 56.03 kB
/background 921 B 56.03 kB
Media (22)
Entry Initial
/media/mux-video/hls-js 1.47 kB
/media/mux-video/spf 1.47 kB
/media/mux-audio/hls-js 1.15 kB
/media/mux-audio/spf 1.14 kB
/media/background-video 532 B
/media/cloudflare-video 1.88 kB
/media/dash-video 1.13 kB
/media/hls-audio 22.20 kB
/media/hls-background-video 17.60 kB
/media/hls-video 32.64 kB
/media/hlsjs-video 1.13 kB
/media/mux-audio 1.13 kB
/media/mux-background-video 17.63 kB
/media/mux-video 1.46 kB
/media/native-hls-video 6.19 kB
/media/shaka-video 1.13 kB
/media/spotify-audio 1.94 kB
/media/tiktok-video 1.88 kB
/media/twitch-video 1.89 kB
/media/vimeo-video 1.85 kB
/media/wistia-video 1.42 kB
/media/youtube-video 1.86 kB
Extensions (2)
Entry Initial
/extensions/google-cast 613 B
/extensions/mux-data 665 B
Players (5)
Entry Initial Lazy
/video/player 8.65 kB 56.03 kB
/audio/player 4.85 kB 56.03 kB
/background/player 3.11 kB 56.03 kB
/live-video/player 8.03 kB 56.03 kB
/live-audio/player 4.86 kB 56.03 kB
Skins (26)
Entry Type Initial Lazy
/video/compat-skin.css css 7.35 kB —
/video/neutral-skin.css css 8.16 kB —
/video/skin.css css 7.86 kB —
/video/compat-skin js 59.72 kB 56.03 kB
/video/neutral-skin js 58.86 kB 56.03 kB
/video/skin js 58.70 kB 56.03 kB
/audio/compat-skin.css css 5.97 kB —
/audio/neutral-skin.css css 5.89 kB —
/audio/skin.css css 5.60 kB —
/audio/compat-skin js 50.68 kB 56.03 kB
/audio/neutral-skin js 45.58 kB 56.03 kB
/audio/skin js 45.59 kB 56.03 kB
/background/skin.css css 97 B —
/background/skin js 516 B —
/live-video/compat-skin.css css 6.81 kB —
/live-video/neutral-skin.css css 6.65 kB —
/live-video/skin.css css 6.55 kB —
/live-video/compat-skin js 55.58 kB 56.03 kB
/live-video/neutral-skin js 48.59 kB 56.03 kB
/live-video/skin js 48.66 kB 56.03 kB
/live-audio/compat-skin.css css 5.48 kB —
/live-audio/neutral-skin.css css 4.58 kB —
/live-audio/skin.css css 4.47 kB —
/live-audio/compat-skin js 41.83 kB 56.03 kB
/live-audio/neutral-skin js 33.84 kB 56.03 kB
/live-audio/skin js 33.84 kB 56.03 kB
UI Components (39)
Entry Initial Lazy
/ui/airplay-button 11.21 kB 56.03 kB
/ui/alert-dialog 5.17 kB 56.03 kB
/ui/audio-track 8.33 kB 56.03 kB
/ui/audio-track-radio-group 10.80 kB 56.03 kB
/ui/buffering-indicator 8.39 kB 56.03 kB
/ui/captions-button 11.20 kB 56.03 kB
/ui/captions-radio-group 10.86 kB 56.03 kB
/ui/cast-button 11.19 kB 56.03 kB
/ui/controls 8.27 kB 56.03 kB
/ui/dialog 5.16 kB 56.03 kB
/ui/error-dialog 12.62 kB 56.03 kB
/ui/fullscreen-button 11.18 kB 56.03 kB
/ui/gesture 8.55 kB 56.03 kB
/ui/hotkey 8.95 kB 56.03 kB
/ui/live-button 9.51 kB 56.03 kB
/ui/menu 21.98 kB 56.03 kB
/ui/mute-button 11.22 kB 56.03 kB
/ui/pip-button 11.18 kB 56.03 kB
/ui/play-button 11.15 kB 56.03 kB
/ui/playback-rate 8.38 kB 56.03 kB
/ui/playback-rate-button 11.14 kB 56.03 kB
/ui/playback-rate-radio-group 10.84 kB 56.03 kB
/ui/popover 9.08 kB 56.03 kB
/ui/poster 8.59 kB 56.03 kB
/ui/quality 8.75 kB 56.03 kB
/ui/quality-radio-group 11.18 kB 56.03 kB
/ui/seek-button 11.18 kB 56.03 kB
/ui/seek-indicator 13.08 kB 56.03 kB
/ui/slider 14.37 kB 56.03 kB
/ui/status-announcer 10.84 kB 56.03 kB
/ui/status-indicator 13.36 kB 56.03 kB
/ui/thumbnail 9.78 kB 56.03 kB
/ui/time 10.58 kB 56.03 kB
/ui/time-slider 16.14 kB 56.03 kB
/ui/title 7.87 kB 56.03 kB
/ui/tooltip 9.96 kB 56.03 kB
/ui/volume-indicator 13.38 kB 56.03 kB
/ui/volume-popover 15.53 kB 56.03 kB
/ui/volume-slider 12.97 kB 56.03 kB
🧩 @videojs/core — no changes
Entries (76)
Entry Initial Lazy
. 13.48 kB —
/dom 23.92 kB 56.03 kB
/vjsc 1.90 kB —
/i18n 3.21 kB 56.03 kB
/i18n/locales/all 33.91 kB —
/i18n/locales/ar 1.16 kB —
/i18n/locales/az 1.08 kB —
/i18n/locales/bg 1.29 kB —
/i18n/locales/bn 1.25 kB —
/i18n/locales/bs 1.02 kB —
/i18n/locales/ca 1.04 kB —
/i18n/locales/cs 1.10 kB —
/i18n/locales/cy 1.02 kB —
/i18n/locales/da 984 B —
/i18n/locales/de 1.06 kB —
/i18n/locales/el 1.42 kB —
/i18n/locales/en 801 B —
/i18n/locales/es 999 B —
/i18n/locales/et 1.02 kB —
/i18n/locales/eu 1.04 kB —
/i18n/locales/fa 1.21 kB —
/i18n/locales/fi 1.05 kB —
/i18n/locales/fr 1.01 kB —
/i18n/locales/gd 1.09 kB —
/i18n/locales/gl 1017 B —
/i18n/locales/he 1.10 kB —
/i18n/locales/hi 1.25 kB —
/i18n/locales/hr 1.05 kB —
/i18n/locales/hu 1.10 kB —
/i18n/locales/id 953 B —
/i18n/locales/it 1.01 kB —
/i18n/locales/ja 1.16 kB —
/i18n/locales/ko 1.08 kB —
/i18n/locales/lt 1.04 kB —
/i18n/locales/lv 1.09 kB —
/i18n/locales/mr 1.23 kB —
/i18n/locales/nb 990 B —
/i18n/locales/ne 1.23 kB —
/i18n/locales/nl 1.01 kB —
/i18n/locales/nn 983 B —
/i18n/locales/oc 1.05 kB —
/i18n/locales/pl 1.11 kB —
/i18n/locales/pt 1.02 kB —
/i18n/locales/pt-BR 1.02 kB —
/i18n/locales/pt-PT 1.02 kB —
/i18n/locales/ro 1.04 kB —
/i18n/locales/ru 1.36 kB —
/i18n/locales/sk 1.10 kB —
/i18n/locales/sl 1.04 kB —
/i18n/locales/sr 1.05 kB —
/i18n/locales/sv 1.01 kB —
/i18n/locales/te 1.29 kB —
/i18n/locales/th 1.20 kB —
/i18n/locales/tr 1.00 kB —
/i18n/locales/uk 1.37 kB —
/i18n/locales/vi 1.10 kB —
/i18n/locales/zh 1.01 kB —
/i18n/locales/zh-CN 1.01 kB —
/i18n/locales/zh-TW 1.02 kB —
/i18n/text/airplay 101 B —
/i18n/text/buttons 137 B —
/i18n/text/captions 93 B —
/i18n/text/cast 114 B —
/i18n/text/common 90 B —
/i18n/text/container 75 B —
/i18n/text/errors 285 B —
/i18n/text/fullscreen 98 B —
/i18n/text/live 126 B —
/i18n/text/menu 249 B —
/i18n/text/pip 101 B —
/i18n/text/playback 80 B —
/i18n/text/seek 105 B —
/i18n/text/slider 65 B —
/i18n/text/status 222 B —
/i18n/text/time 322 B —
/i18n/text/volume 133 B —
🏷️ @videojs/element — no changes
Entries (2)
Entry Initial
. 1.05 kB
/context 1.15 kB
📦 @videojs/store — no changes
Entries (3)
Entry Initial
. 1.85 kB
/html 703 B
/react 419 B
🔧 @videojs/utils — no changes
Entries (13)
Entry Initial
/array 271 B
/dom 5.25 kB
/events 320 B
/function 414 B
/i18n 249 B
/jwt 176 B
/object 535 B
/predicate 297 B
/percent 281 B
/string 239 B
/style 212 B
/time 1018 B
/number 199 B
📦 @videojs/cdn — no changes
📦 @videojs/cloudflare-video — no changes
📦 @videojs/dash-video — no changes
📦 @videojs/google-cast — no changes
📦 @videojs/hlsjs-video — no changes
📦 @videojs/media — no changes
Entries (3)
Entry Initial
. 3.22 kB
/dom 4.00 kB
/media-tracks 2.05 kB
📦 @videojs/mux — no changes
📦 @videojs/mux-audio — no changes
Entries (2)
Entry Initial
. 136.03 kB
/spf 22.76 kB
📦 @videojs/mux-data — no changes
📦 @videojs/mux-video — no changes
Entries (2)
Entry Initial
. 135.99 kB
/spf 32.99 kB
📦 @videojs/native-hls-video — no changes
📦 @videojs/shaka-video — no changes
📦 @videojs/spf — no changes
Entries (7)
Entry Initial
. 4.56 kB
/dom 7.85 kB
/hls 28.40 kB
/media-tracks 507 B
/hls-background-video 16.60 kB
/hls-audio 21.28 kB
/hls-video 31.73 kB
📦 @videojs/spotify-audio — no changes
📦 @videojs/tiktok-video — no changes
📦 @videojs/twitch-video — no changes
📦 @videojs/other — no changes
Entries (3)
Entry Initial Lazy
video.js 74.33 kB 56.03 kB
video.js/package.json 608 B —
video.js/errors 1.03 kB —
📦 @videojs/vimeo-video — no changes
📦 @videojs/wistia-video — no changes
Entries (2)
Entry Initial
. 1.91 kB
/helpers 1.76 kB
📦 @videojs/youtube-video — no changes

ℹ️ How to interpret

Each entry is independently bundled, minified, and brotli-compressed. Initial size includes its static import graph; lazy dynamic chunks are reported separately.

Entries are not additive because their dependency graphs overlap. Preset rows represent realistic combined bundles.

Changes of 300 B or less across initial, lazy, and total size are collapsed, not discarded.

Run pnpm size locally to check current initial sizes.

This branch was successfully deployed

1 active deployment
Preview — cd32656a Deployed Oct 1, 2026 by vercel[bot]
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants