vercel/aiNew scan
91/ 100 · A

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

The AI Toolkit for TypeScript. From the creators of Next.js, the AI SDK is a free open-source library for building AI-powered applications and agents

TypeScript24,861 starsOtherupdated 2d ago
DocumentationREADME, setup, examples, license
96
EngineeringTests, CI, linting, lockfiles
88
Project healthDescription, activity, stars, deps
93

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

Detailed breakdown

Documentation

96
  • README90
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • No status badges in the README (−10 pts).Add CI/build status badges from shields.io or your CI provider to signal project health.
  • Install and run instructions100
    • README documents how to install the project.
    • README documents how to run the project.
    • .env.example is present. Contributors can see exactly which env vars to set.
  • License100
    • Licensed under Other.
  • Contributing guide98
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Code of conduct present.

Engineering

88
  • Tests100
    • Test files detected (examples/ai-functions/src/e2e/amazon-bedrock-anthropic.test.ts).
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/ci.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting60
    • Linting configured via package.json scripts or devDependencies.
    • tsconfig.json enables noImplicitAny or strictNullChecks (+10 pts).
    • tsconfig.json does not enable full strict mode (−10 pts vs `strict: true`).Set "strict": true in compilerOptions to enable all strict checks at once (+10 more pts).
  • Reproducibility70
    • Lockfile present (pnpm-lock.yaml). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

93
  • Dependency manifest90
    • Dependency manifest found (package.json).
    • package.json is missing a description (−10 pts).Add a one-line description to package.json. It appears in npm search and on GitHub.
    • package.json links back to the repository.
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 24,861 stars.
  • Housekeeping100
    • .gitignore present.
Repository files34 root entries
  • .agents
  • .changeset
  • .claude
  • .cursor
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • .husky
  • .vscode
  • architecture
  • assets
  • content
  • contributing
  • examples
    Good: Test files detected (examples/ai-functions/src/e2e/amazon-bedrock-anthropic.test.ts).
  • packages
  • skills
  • tools
  • .gitignore
    Good: .gitignore present.
  • .kodiak.toml
  • .npmrc
  • .oxfmtrc.jsonc
  • .oxlintrc.json
  • AGENTS.md
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • LICENSE
    Good: Licensed under Other.
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Info: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • socket.yaml
  • tsconfig.json
  • tsconfig.with-examples.json
  • turbo.json