mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Jordan Ritter
bd119c29e1
## Summary Comprehensive docs quality infrastructure — model name validation, executable doc tests, and 8 community docs fixes rolled up. ### Docs fixes (supersedes 8 PRs) - **gpt-5.2 → gpt-5.4** across 70 files, 124 occurrences (supersedes #3655) - **Anthropic model IDs** dots → hyphens to match API/AI SDK format (supersedes #3656) - **LangGraph FastAPI quickstart** — missing `import uvicorn`, missing `MemorySaver` checkpointer, `port` string→int (supersedes #3661, with contributor's `langgrapg` typo fixed) - **AG2 ContextVariables import** — moved from `autogen` to `autogen.agentchat` per latest AG2 (supersedes #3658, verified via Docker) - **CrewAI Flows** — comment out deprecated CLI option (supersedes #3667) - **Pydantic quickstart** — pin Starlette 0.45.3 (1.0.0 is incompatible, verified via Docker) (supersedes #3660) - **CopilotChat example** — add missing `default` export for Next.js page components (supersedes #3669) - **globals.css import** — add to all 9 quickstart layout examples so customization section works (supersedes #3665) ### Model name validation (new) - `docs/model-allowlist.json` — maintained list of valid model names by provider (OpenAI, Anthropic, Google, Cohere, Meta) - `scripts/validate-doc-model-names.ts` — CI lint that extracts model names from docs code blocks and validates against allowlist - 20 tests ### Executable doc tests (new, Phase 1) - `scripts/doc-tests/extract.ts` — remark + remark-mdx AST parser finds `doctest`-tagged code blocks in MDX - `scripts/doc-tests/run.ts` — execution harness: installs deps, points at aimock, runs server/script/component snippets - `.github/workflows/test_doc-examples.yml` — CI triggered on `docs/**` changes (previously excluded from ALL CI) - LangGraph FastAPI quickstart tagged as first `doctest="server"` example - 10 tests for extraction ### Spec [Executable Doc Tests proposal on Notion](https://www.notion.so/33c3aa38185281388a21e8dfe752ac5e) ## Supersedes | PR | Fix | Status | |----|-----|--------| | #3655 | gpt-5.2-mini → gpt-5.4-mini | ✅ Included (all 70 files, not just 22) | | #3656 | Anthropic dots → hyphens | ✅ Included | | #3658 | AG2 ContextVariables import | ✅ Included (verified via Docker) | | #3660 | Starlette pin | ✅ Included (verified via Docker) | | #3661 | LangGraph FastAPI quickstart | ✅ Included (with typo fix) | | #3665 | globals.css import | ✅ Included | | #3667 | CrewAI deprecated CLI | ✅ Included | | #3669 | CopilotChat default export | ✅ Included | All 8 PRs can be closed when this merges. ## Test plan - [x] Model name validator passes (0 violations) - [x] 20 validator unit tests pass - [x] 10 extraction unit tests pass - [x] Build passes - [x] Commitlint passes - [ ] CI workflow validates doc examples on docs/** changes 🤖 Generated with [Claude Code](https://claude.com/claude-code)
101 lines
3.5 KiB
JSON
101 lines
3.5 KiB
JSON
{
|
|
"name": "CopilotKit",
|
|
"private": true,
|
|
"scripts": {
|
|
"build": "nx run-many -t build --projects=packages/** --exclude=@copilotkit/demo-agents",
|
|
"build:examples": "nx run-many -t build --projects=examples/**",
|
|
"build:storybook": "nx run-many -t build --projects=examples/v2/*/storybook",
|
|
"check-types": "nx run-many -t check-types",
|
|
"clean": "git clean -fdX --exclude=\"!.env\"",
|
|
"lint": "oxlint .",
|
|
"format": "oxfmt --write .",
|
|
"check-format": "oxfmt --check .",
|
|
"test": "nx run-many -t test",
|
|
"test:watch": "pnpm run test && nx watch --all -- pnpm run test",
|
|
"test:coverage": "nx run-many -t test:coverage",
|
|
"dev": "pnpm run build && nx watch --projects=packages/** -- pnpm run build",
|
|
"dev:examples": "pnpm run build:examples && nx watch --projects=examples/** -- pnpm run build:examples",
|
|
"storybook:angular": "pnpm -C examples/v2/angular/storybook dev",
|
|
"storybook:react": "pnpm -C examples/v2/react/storybook dev",
|
|
"storybook": "pnpm storybook:react",
|
|
"docs": "pnpm -C examples/v2/docs dev",
|
|
"demo:angular": "nx run-many -t dev --projects=examples/v2/angular/demo,examples/v2/angular/demo-server",
|
|
"demo:react": "pnpm -C examples/v2/react/demo dev",
|
|
"changeset": "changeset",
|
|
"ci:check-release-plan": "node ./scripts/release/check-allowed-release-packages.js",
|
|
"ci:publish-release": "pnpm run build && pnpm changeset publish --no-git-tag",
|
|
"prepare": "lefthook install",
|
|
"graph": "nx graph",
|
|
"publint": "nx run-many -t publint --projects=packages/**",
|
|
"attw": "nx run-many -t attw --projects=packages/**",
|
|
"check:packages": "nx run-many -t publint,attw --projects=packages/**",
|
|
"validate:model-names": "tsx scripts/validate-doc-model-names.ts"
|
|
},
|
|
"devDependencies": {
|
|
"@arethetypeswrong/cli": "^0.18.2",
|
|
"@changesets/cli": "^2.29.8",
|
|
"@commitlint/cli": "^20.3.0",
|
|
"@commitlint/config-conventional": "^20.3.0",
|
|
"@storybook/addon-docs": "^10.1.10",
|
|
"@storybook/addon-webpack5-compiler-swc": "^4.0.2",
|
|
"@storybook/react-webpack5": "^10.1.10",
|
|
"@types/jscodeshift": "^17.3.0",
|
|
"@types/node": "^18.11.17",
|
|
"@vitest/coverage-v8": "^3.2.4",
|
|
"danger": "^12.3.3",
|
|
"glob": "^10.3.12",
|
|
"install": "^0.13.0",
|
|
"jscodeshift": "^17.3.0",
|
|
"lefthook": "^2.1.1",
|
|
"npm": "^10.7.0",
|
|
"nx": "^22.5.0",
|
|
"oxfmt": "^0.36.0",
|
|
"oxlint": "^1.51.0",
|
|
"publint": "^0.3.17",
|
|
"remark": "^15.0.1",
|
|
"remark-mdx": "^3.1.1",
|
|
"remark-parse": "^11.0.0",
|
|
"storybook": "^10.1.10",
|
|
"ts-node": "^10.9.2",
|
|
"tsdown": "^0.20.3",
|
|
"tsx": "^4.21.0",
|
|
"typescript": "^5.2.3",
|
|
"unified": "^11.0.5",
|
|
"unist-util-visit": "^5.1.0",
|
|
"vitest": "^4.1.3"
|
|
},
|
|
"engines": {
|
|
"node": ">=18"
|
|
},
|
|
"packageManager": "pnpm@10.13.1",
|
|
"pnpm": {
|
|
"peerDependencyRules": {
|
|
"ignoreMissing": [
|
|
"react",
|
|
"react-dom"
|
|
],
|
|
"allowedVersions": {
|
|
"react": "*",
|
|
"react-dom": "*"
|
|
}
|
|
},
|
|
"overrides": {
|
|
"streamdown>react": "^19.0.0",
|
|
"@types/react": "^19.1.0",
|
|
"@types/react-dom": "^19.0.2",
|
|
"react": "19.2.3",
|
|
"react-dom": "19.2.3",
|
|
"next@<=15.4.10": "15.4.10",
|
|
"send@<=0.19.0": "0.19.0",
|
|
"path-to-regexp@<=0.1.12": "0.1.12",
|
|
"serve-static@<=1.16.0": "1.16.0",
|
|
"prismjs@<=1.30.0": "1.30.0",
|
|
"pino@<=10.1.1": "10.1.1",
|
|
"@copilotkit/license-verifier": "0.0.1-a1"
|
|
},
|
|
"patchedDependencies": {
|
|
"@changesets/assemble-release-plan@6.0.9": "patches/@changesets__assemble-release-plan@6.0.9.patch"
|
|
}
|
|
}
|
|
}
|