zh-lx/code-inspector
Grade a repo

0

/ 100

GradeA

A well-known project done right. Strong docs and solid engineering throughout.

Top 11% of 5,156 graded repos

🚀 Click the dom to open your IDE and position the cursor at dom's source code location! 点击页面 dom 来打开 IDE 并将光标自动定位到源代码位置!

Documentation82
Engineering93
Health100
TypeScript2,981MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

6 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

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

  3. 3
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  4. 4
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

82

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

93

Reproducibility6pt80

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

CI/CD14pt85

CI is configured (.github/workflows/codecov.yml).

Tests18pt100

Test files detected (test).

Linting and formatting5pt100

Linter or formatter configured (demos/next15/eslint.config.mjs).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 231
    Forks
  • 0
    Releases

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 2,981
    Watchers

Responsiveness

  • 2h
    Median issue response
  • <1h
    Median PR merge time
  • 7
    Open issues
Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/codecov.yml).
    Good: Issue or PR templates present.
  • assets
  • demos
    Good: Linter or formatter configured (demos/next15/eslint.config.mjs).
    Good: Environment pinned via demos/vite-react/.nvmrc.
  • docs
  • packages
  • scripts
  • test
    Good: Test files detected (test).
  • .gitignore
    Good: .gitignore present.
  • deploy.sh
  • 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
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tsconfig.json
  • vitest.config.ts
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/zh-lx/code-inspector)](https://www.repo-grade.com/report/zh-lx/code-inspector)

More graded TypeScript repos