avajs/avaNew scan
84/ 100 · B

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

Node.js test runner that lets you develop with confidence 🚀

JavaScript20,848 starsMITupdated 1mo ago
DocumentationREADME, setup, examples, license
90
EngineeringTests, CI, linting, lockfiles
79
Project healthDescription, activity, stars, deps
91

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
    README
    DocumentationInfo

    Add CI/build status badges from shields.io or your CI provider to signal project health.

Detailed breakdown

Documentation

90
  • 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 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 guide75
    • CONTRIBUTING guide or docs directory present.
    • Code of conduct present.

Engineering

79
  • Tests100
    • Test files detected (test-tap/fixture/globs/custom-extension/test).
  • CI/CD57

    Not applicable?

    • CI is configured (.github/workflows/ci.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.
    • 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 formatting60
    • Linter or formatter configured (.editorconfig).
    • tsconfig.json does not enable strict type checking (−20 pts).Add "strict": true to compilerOptions to catch more bugs at compile time.
  • Reproducibility70
    • 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.
    • 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 templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

91
  • Dependency manifest90
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
    • package.json has no build script (−10 pts).Add a `build` script to package.json so the project can be compiled with `npm run build`.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: JavaScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 20,848 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (test/config-require/fixtures/require-dependency/node_modules/@ava) (−40 pts).Remove them and add to .gitignore.
Repository files27 root entries
  • .github
    Good: CONTRIBUTING guide or docs directory present.
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
  • docs
  • entrypoints
  • examples
  • lib
  • media
  • scripts
  • test
    Warning: Build artifacts or local files may be committed (test/config-require/fixtures/require-dependency/node_modules/@ava) (−40 pts).Fix: Remove them and add to .gitignore.
  • test-tap
    Good: Test files detected (test-tap/fixture/globs/custom-extension/test).
  • test-types
  • types
  • .c8rc.json
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • .taprc
  • ava.config.js
  • index.d.ts
  • license
    Good: Licensed under MIT.
  • maintaining.md
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • plugin.d.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.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tsconfig.json
  • xo.config.js