googleapis/google-api-nodejs-clientNew scan
86/ 100 · B

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

Google's officially supported Node.js client library for accessing Google APIs. Support for authorization and authentication with OAuth 2.0, API Keys and JWT (Service Tokens) is included.

TypeScript12,171 starsApache-2.0updated 19d ago
DocumentationREADME, setup, examples, license
83
EngineeringTests, CI, linting, lockfiles
85
Project healthDescription, activity, stars, deps
95

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

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

  2. 2
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  3. 3
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

Detailed breakdown

Documentation

83
  • README70
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • 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 Apache-2.0.
  • Contributing guide84
    • Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.
    • Contributing guide includes setup/install instructions.
    • 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 has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Code of conduct present.

Engineering

85
  • Tests100
    • Test files detected (.github/scripts/tests).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/ci.yaml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • 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.
    • CI tests across multiple environments or versions.
  • Linting and formatting75
    • Linter or formatter configured (.eslintrc.json).
    • Lint script wired into package.json.
    • tsconfig.json does not enable strict type checking (−20 pts).Add "strict": true to compilerOptions to catch more bugs at compile time.
  • Reproducibility0
    • No dependency lockfile found (−70 pts).Commit a lockfile (package-lock.json, poetry.lock, uv.lock, etc.) so installs produce the same result everywhere.
    • 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 templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

95
  • Dependency manifest83
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
    • package.json has no homepage field (−7 pts).Add a `homepage` field pointing to your docs or project website.
    • 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: TypeScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 12,171 stars.
  • Housekeeping100
    • .gitignore present.
Repository files39 root entries
  • .github
    Good: Test files detected (.github/scripts/tests).
    Good: CI is configured (.github/workflows/ci.yaml).
    Good: Issue or PR templates present.
  • .kokoro
  • discovery
  • samples
  • src
  • system-test
  • test
  • .compodocrc
  • .eslintignore
  • .eslintrc.json
    Good: Linter or formatter configured (.eslintrc.json).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .jsdoc.js
  • .mocharc.js
  • .nycrc
  • .prettierignore
  • .prettierrc.js
  • .release-please-manifest.json
  • .repo-metadata.json
  • .trampolinerc
  • AUTHORS
  • CHANGELOG.md
    Good: Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.
    Good: Contributing guide includes setup/install instructions.
    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.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • disclaimers.json
  • generator.md
  • ignore.json
  • LICENSE
    Good: Licensed under Apache-2.0.
  • linkinator.config.json
  • owlbot.py
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    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.
  • release-please-config.json
  • renovate.json
  • SECURITY.md
    Good: Security policy present.
  • synth.metadata
  • tsconfig.json
  • tsconfig.test.json
  • tsconfig.tools.json