mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
f233e46937
This PR: - replaces ESLint with oxlint across the pnpm workspace and the Bun-based docs site, porting the rules to `.oxlintrc.json` / `docs/.oxlintrc.json` with behavior parity (restricted-syntax selectors kept via `oxlint-plugin-eslint`) - migrates typecheck to TypeScript 7 (`typescript@^7.0.2` catalog) and keeps a TS6 pin for JS compiler API consumers via a named `ts6` pnpm catalog (`ts/scripts/validate-examples.ts`, the `@composio/cli` generate pipeline). The CLI's `typescript` dependency rebinds only the compiler-API import — its typecheck still runs the root TS7 `tsc`, since the alias package only ships a `tsc6` bin (documented in `ts/packages/cli/AGENTS.md`) - removes the `paths` mappings that pointed `@composio/core` (and, in `experimental`, `@composio/json-schema-to-zod` plus core-internal `#`-imports) at sibling `src` directories: under TS7, tsdown's tsgo-based dts step emitted stray `.d.ts` files next to those out-of-root sources on every dependent package build. Workspace deps now resolve through their built dist types, which turbo's `dependsOn: ^build` already guarantees exist — and which the deep-path exports (`@composio/core/*`) always used anyway - renames the cli boundary tooling `eslint-boundaries*` → `lint-boundaries*` and hardens the scanner to reject `oxlint-disable` spellings so the disable manifest cannot be bypassed - rewrites inline `eslint-disable` comments to oxlint rule names (comment-only; no runtime changes), and adds **one new** declared boundary: `tool-file-uploads.ts` needs `no-restricted-imports` disabled for `node:crypto` (MD5 for the presigned-upload checksum is not in Web Crypto), because oxlint also catches dynamic `await import()` where ESLint did not. The manifest grows 46 → 47 deliberately - updates CI path filters, `turbo.jsonc` lint inputs, and the docs typescript-check workflow (renamed to "Docs - Lint and TypeScript Validation" since it now lints too); drops `eslint`, `typescript-eslint`, `eslint-config-next`, and `globals` from the dependency graphs - ships no changeset: I built `@composio/core` and `@composio/anthropic` on this branch and on the pre-migration base and diffed the emitted `dist/**/*.d.mts`. The provider output is byte-identical. Core's output is **semantically identical but not byte-identical**: TS7 changes quote style (`"x"` → `'x'`), object-property and union-member ordering in inferred types, and picks equivalent shorter re-export alias paths for five signatures (e.g. `OpenAI.Beta.Threads.Runs.Run` → `OpenAI.Beta.Threads.Run` — verified both names alias the same type in the shipped typings). Chunk-name hashes shift as a consequence. No type gains, losses, or shape changes; `attw` and `publint` pass on the TS7 build ## Context First of a three-PR split of #3958. The type-safety refactors are stacked on this branch and merge after it: - docs: https://github.com/ComposioHQ/composio/pull/3967 - `@composio/core`: https://github.com/ComposioHQ/composio/pull/3968
2.2 KiB
2.2 KiB
AGENTS.md
Documentation-site guidance for AI agents working under docs/.
Scope
docs/ is a Fumadocs/Next.js site. Docs PRs branch from next and target next.
Read Next
- Use the
docs-decisionsskill for docs content, changelogs, decisions, docs automation, or docs review. - Context references live under
docs/agent-guidance/context/; usedocs/agent-guidance/context/twoslash.mdbefore editing typed MDX examples. - Agent workflow prompts live under
docs/agent-guidance/agents/. - Changelog guidance lives at
docs/agent-guidance/guides/changelog.md. - Decision records live under
docs/decisions/; readdocs/decisions/README.mdfirst.
Commands
Run commands from docs/:
bun install
bun run dev
bun run build
bun run types:check
bun run lint
bun run lint:links
bun run test
bun run test:integration
bun run generate:toolkits
bun run generate:meta-tools
bun run generate:api-index
Rules
- TypeScript code blocks in MDX are checked during docs builds. Use
docs/agent-guidance/context/twoslash.mdbefore changing typed examples. - Parse untyped or external data (JSON files, fetched payloads, framework page data) once at the boundary with zod schemas and let
z.infertypes flow downstream. Never hand-roll structural guards ('x' in obj/typeofchains), cast parsed JSON withas, or fake validation withz.custom(() => true). - Internal docs links must be relative site paths such as
/docs/...,/reference/..., or/assets/.... - API reference pages and toolkit/meta-tool data are generated. Do not hand-edit generated data unless the local generator owns it.
- Changelog entries require
titleanddatefrontmatter, and dates useYYYY-MM-DD. - Prefer cURL for API interactions because docs are consumed by humans and AI crawlers.
- Links to
dashboard.composio.devmust carryutm_source=docs,utm_medium, andutm_campaign(content links useutm_medium=contentandutm_campaign=<page-slug>), and any link with a path must be a go-link (/~/project/...or/~/org/...) or/login. Never linkapp.composio.devorplatform.composio.dev. Oxlint enforces TS/TSX;tests/static/dashboard-links.test.tsenforces MDX.