elastic/elasticsearch-js
Grade a repo

89

/ 100

GradeA

Excellent work. The main thing left to polish is a reproducible setup.

Top 12% of 5,156 graded repos

Official Elasticsearch client library for Node.js

Documentation94
Engineering84
Health100
TypeScript5,291Apache-2.029d ago

Top fixes

Highest-impact changes first, ranked by point weight

6 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    Install and run instructions9pt

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

  3. 3
    Reproducibility6pt

    Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

  4. 4
    Contributing guide5pt

    Show new contributors how to get a local dev environment running.

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

94

Contributing guide5pt80

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

84

Reproducibility6pt30

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

Tests18pt80

Test files detected (test).

CI/CD14pt100

CI is configured (.github/workflows/docs-build.yml).

Linting and formatting5pt100

Linter or formatter configured (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

  • 6 / 34
    Commits (30d / 90d)
  • 722
    Forks
  • 125
    Releaseslatest 7y ago

Community

  • 87% - Good
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 5,291
    Watchers

Responsiveness

  • 2h
    Median issue response
  • <1h
    Median PR merge time
  • 22
    Open issues
Repository files26 root entries
  • .buildkite
    Good: Environment pinned via .buildkite/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/docs-build.yml).
    Good: Issue or PR templates present.
  • docs
  • scripts
  • src
  • test
    Good: Test files detected (test).
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .taprc
  • AGENTS.md
  • catalog-info.yaml
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • 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.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • index.d.ts
  • index.js
  • LICENSE
    Good: Licensed under Apache-2.0.
  • NOTICE.txt
  • 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.
  • renovate.json
    Good: Renovate is configured (renovate.json). Dependencies update automatically across every package manager it detects.
  • tsconfig.esm.json
  • tsconfig.json
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/elastic/elasticsearch-js)](https://www.repo-grade.com/report/elastic/elasticsearch-js)

More graded TypeScript repos