vercel/swrNew scan
84/ 100 · B

Popular and well-maintained. A little polish away from elite status.

React Hooks for Data Fetching

TypeScript32,400 starsMITupdated 12d ago
DocumentationREADME, setup, examples, license
64
EngineeringTests, CI, linting, lockfiles
92
Project healthDescription, activity, stars, deps
100

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

64
  • 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 instructions0
    • No install instructions found in the README (−45 pts).Add a section showing how to install dependencies.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide75
    • CONTRIBUTING guide or docs directory present.
    • Code of conduct present.

Engineering

92
  • Tests100
    • Test files detected (e2e/test).
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/test-canary.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 includes a build step.
  • Linting and formatting95
    • Linter or formatter configured (.editorconfig).
    • Lint script wired into package.json.
    • tsconfig.json has `strict: true`. Full TypeScript type safety enabled.
  • 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

100
  • Dependency manifest100
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: TypeScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 32,400 stars.
  • Housekeeping100
    • .gitignore present.
Repository files27 root entries
  • _internal
  • .codesandbox
  • .github
    Good: CONTRIBUTING guide or docs directory present.
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/test-canary.yml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • .husky
  • e2e
    Good: Test files detected (e2e/test).
  • examples
  • immutable
  • infinite
  • mutation
  • scripts
  • src
  • subscription
  • test
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • .swcrc
  • eslint.config.mjs
  • jest.config.build.js
  • jest.config.js
  • LICENSE
    Good: Licensed under MIT.
  • package.json
    Good: Dependency manifest found (package.json).
  • playwright.config.js
  • 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.
    Warning: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Warning: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • tsconfig.json