nestjs/nestNew scan
88/ 100 ยท B

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

A progressive Node.js framework for building efficient, scalable, and enterprise-grade server-side applications with TypeScript/JavaScript ๐Ÿš€

TypeScript75,837 starsMITupdated 4d ago
DocumentationREADME, setup, examples, license
89
EngineeringTests, CI, linting, lockfiles
86
Project healthDescription, activity, stars, deps
94

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringWarning

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    CI/CD
    EngineeringInfo

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

Detailed breakdown

Documentation

89
  • README85
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has no code examples (โˆ’15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • 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.
    • 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 guide83
    • 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 lacks a code style section (โˆ’8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

86
  • Tests100
    • Test files detected (integration/auto-mock/test).
  • CI/CD57

    Not applicable?

    • CI is configured (.github/workflows/codeql-analysis.yml).
    • The CI workflow does not appear to run any tests (โˆ’28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • 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.
  • Linting and formatting85
    • Linter or formatter configured (.prettierrc).
    • Lint script wired into package.json.
    • 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).
  • Reproducibility100
    • Lockfile present (package-lock.json). Installs are reproducible.
    • Environment pinned via integration/docker-compose.yml.
    • Dependabot covers 2 ecosystems (npm, github-actions). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

94
  • Dependency manifest92
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
    • package.json has no keywords (โˆ’8 pts).Add a `keywords` array to help people find your package on npm.
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 75,837 stars.
  • Housekeeping100
    • .gitignore present.
Repository files31 root entries
  • .circleci
  • .github
    Good: CI is configured (.github/workflows/codeql-analysis.yml).
    Good: Dependabot covers 2 ecosystems (npm, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • .husky
  • hooks
  • integration
    Good: Test files detected (integration/auto-mock/test).
    Good: Environment pinned via integration/docker-compose.yml.
  • packages
  • sample
  • scripts
  • tools
  • .commitlintrc.json
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .prettierignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • 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.
    Info: Contributing guide lacks a code style section (โˆ’8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    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
  • gulpfile.js
  • lerna.json
  • LICENSE
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • readme_jp.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Info: README has no code examples (โˆ’15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.
  • readme_kr.md
  • readme_zh.md
  • Readme.md
  • renovate.json
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.json
  • tsconfig.spec.json