nestjs/swagger

0

/ 100

Documentation80
Engineering96
Health95
TypeScript1,876MIT1d ago
Grade a repo

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

OpenAPI (Swagger) module for Nest framework (node.js) :earth_americas:

Documentation

80

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt72

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

96

Reproducibility6pt70

Lockfile present (package-lock.json). Installs are reproducible.

Tests18pt100

Test files detected (test).

CI/CD14pt100

CI is configured (.circleci/config.yml).

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

95

Dependency manifest6pt85

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)
  • 540
    Forks
  • 159
    Releaseslatest 6y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 1,876
    Watchers

Responsiveness

  • 1d 16h
    Median issue response
  • 22d 14h
    Median PR merge time
  • 24
    Open issues
Repository files25 root entries
  • .circleci
    Good: CI is configured (.circleci/config.yml).
  • .github
    Good: Issue or PR templates present.
  • e2e
  • lib
  • test
    Good: Test files detected (test).
  • .commitlintrc.json
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • .release-it.json
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • index.ts
  • LICENSE
    Good: Licensed under MIT.
  • nest-cli.json
  • oxlintrc.json
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • plugin.js
  • plugin.ts
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • renovate.json
  • tsconfig.build.json
  • tsconfig.json
  • vitest.config.mts
  • vitest.e2e.config.mts