trpc/trpcNew scan
91/ 100 · A

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

🧙‍♀️ Move Fast and Break Nothing. End-to-end typesafe APIs made easy.

TypeScript40,331 starsMITupdated 3d ago
DocumentationREADME, setup, examples, license
89
EngineeringTests, CI, linting, lockfiles
96
Project healthDescription, activity, stars, deps
81

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

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

  2. 2
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  3. 3
    Dependency manifest
    Project healthInfo

    Add a one-line description to package.json. It appears in npm search and on GitHub.

Detailed breakdown

Documentation

89
  • README80
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • 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 MIT.
  • Contributing guide78
    • Contributing guide is detailed and thorough.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide lacks a PR workflow section (−8 pts).Explain how to fork, branch, and open a pull request so contributors know what to expect.
    • Contributing guide includes code examples.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

96
  • Tests100
    • Test files detected (examples/.experimental/next-app-dir/test).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/check-skills.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting75
    • Linter or formatter configured (eslint.config.js).
    • Lint script wired into package.json.
    • tsconfig.json does not enable strict type checking (−20 pts).Add "strict": true to compilerOptions to catch more bugs at compile time.
  • Reproducibility92
    • Lockfile present (pnpm-lock.yaml). Installs are reproducible.
    • Environment pinned via examples/next-prisma-websockets-starter/docker-compose.yaml.
    • Dependabot is configured. Dependencies update automatically.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

81
  • Dependency manifest65
    • 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 has no repository field (−10 pts).Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.
    • package.json has no keywords (−8 pts).Add a `keywords` array to help people find your package on npm.
    • package.json has no homepage field (−7 pts).Add a `homepage` field pointing to your docs or project website.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 40,331 stars.
  • Housekeeping100
    • .gitignore present.
    • A .env file exists in a test directory (examples/.experimental/next-app-dir/.env). This is a test fixture, not a committed secret.
Repository files33 root entries
  • _artifacts
  • .cursor
  • .github
    Good: CI is configured (.github/workflows/check-skills.yml).
    Good: Issue or PR templates present.
  • .superset
  • .vscode
  • examples
    Good: Test files detected (examples/.experimental/next-app-dir/test).
    Good: Environment pinned via examples/next-prisma-websockets-starter/docker-compose.yaml.
    Good: Dependabot is configured. Dependencies update automatically.
  • packages
  • scripts
  • www
  • .coderabbit.yaml
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .kodiak.toml
  • .npmrc
  • .nvmrc
  • .prettierignore
  • .tool-versions
  • .ts-prunerc
  • codecov.yml
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Info: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • eslint.config.js
    Good: Linter or formatter configured (eslint.config.js).
  • lerna.json
  • LICENSE
    Good: Licensed under MIT.
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • prettier.config.js
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.build.json
  • tsconfig.json
  • turbo.json
  • vitest.config.ts