microsoft/TypeScriptNew scan
97/ 100 · A

A landmark open source project with strong engineering quality.

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

TypeScript109,291 starsApache-2.0updated 5d agolarge repo (partial scan)

Outstanding work. A score of 97/100 puts this repo in a very small tier of truly well-engineered open source projects.

DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
99
Project healthDescription, activity, stars, deps
94

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Install and run instructions
    DocumentationIssue

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

  2. 2
    Reproducibility
    EngineeringIssue

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  3. 3
    Housekeeping
    Project healthIssue

    Remove them and add to .gitignore.

Detailed breakdown

Documentation

97
  • README100
    • This repository is large enough that GitHub truncated the file tree. The scan is based on a partial file list, so some checks may under-report.
    • 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.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • No .env.example found (−10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide100
    • 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 includes code examples.
    • Code of conduct present.

Engineering

99
  • Tests100
    • Test files detected (scripts/eslint/tests).
  • CI/CD100

    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 workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • CI reports or uploads test coverage.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • Linter or formatter configured (.editorconfig).
  • Reproducibility90
    • Lockfile present (package-lock.json). 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.
    • Dependabot covers 2 ecosystems (github-actions, devcontainers). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

94
  • 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).
    • 109,291 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (tests/baselines/reference/project/nodeModulesMaxDepthExceeded/amd/maxDepthExceeded/built/node_modules/m1) (−40 pts).Remove them and add to .gitignore.
Repository files30 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, devcontainers). Dependencies stay current.
    Good: Issue or PR templates present.
  • .vscode
  • bin
  • scripts
    Good: Test files detected (scripts/eslint/tests).
  • src
  • tests
    Issue: Build artifacts or local files may be committed (tests/baselines/reference/project/nodeModulesMaxDepthExceeded/amd/maxDepthExceeded/built/node_modules/m1) (−40 pts).Fix: Remove them and add to .gitignore.
  • .c8rc.json
  • .dprint.jsonc
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gulp.js
  • AGENTS.md
  • azure-pipelines.release-publish.yml
  • azure-pipelines.release.yml
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.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.
    Good: Contributing guide includes code examples.
  • eslint.config.mjs
  • Herebyfile.mjs
  • knip.jsonc
  • LICENSE.txt
    Good: Licensed under Apache-2.0.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
  • SECURITY.md
    Good: Security policy present.
  • SUPPORT.md
  • ThirdPartyNoticeText.txt