planby - 米舟开源

karolkozer/planby

Watch

Star

Fork

简介统计版本

3 days ago

planby

karolkozer

v2.1.0

Feature

Planby now ships an agent skill — a compact, source-verified description of the API that AI coding assistants read before writing code, so they stop inventing useEpg options that don't exist.

npm install planby
npx planby init-ai

One command wires the skill into every assistant you use:

Agent	What it writes
Claude Code / Agent SDK	`.claude/skills/planby`
Cursor	`.cursor/rules/planby.mdc`
Windsurf	`.windsurf/rules/planby.md`
Codex, Gemini CLI, Antigravity, …	a section in `AGENTS.md`

Each file points at the skill bundled inside node_modules/planby, so the guidance always matches the version you installed. Re-run it after upgrading.

The skill documents the useEpg hook and every one of its options, the Channel/Program schemas, the theme and what each color actually controls, the three render functions, and branding with styled(). It ships two runnable examples that are type-checked against the published types on every release, and it knows which features belong to Planby PRO so it says so instead of generating code that cannot work.

See Using Planby with AI assistants in the README.

Smaller ESM bundle

Dropped the Create React App-era @emotion/styled/macro imports. The macro was only being expanded in the CommonJS build, so the ESM bundle carried its machinery for nothing:

Bundle (gzip)	2.0.0	2.1.0
`planby.esm.js`	18.8 kB	10.9 kB (−42%)
`planby.cjs.production.min.js`	7.1 kB	7.2 kB

Stable class name for the timeline label

TimelineTime now renders with a stable planby-timeline-time class instead of a generated hash, so it can be targeted from globalStyles.

Fixed

The test suite runs again (9/9 suites, 21/21 tests). react, react-dom and the Testing Library packages were never declared in devDependencies, Jest ran DOM tests in a node environment, and tsdx's bundled Jest conflicted with the root ts-jest.
Packing now builds through prepack instead of prepare. prepare is an npm-only lifecycle hook and never ran under Yarn, so yarn npm publish could ship a package with an empty dist/.

Contributing

CONTRIBUTING.md now documents the development setup — Corepack, the pinned Yarn version, the everyday commands, and the rule that a change to the public API must update skills/planby/ in the same pull request.