sidorares/node-mysql2New scan
82/ 100 · B

Good community traction and solid fundamentals. Nearly in the top tier.

:zap: fast mysqljs/mysql compatible mysql driver for node.js

TypeScript4,365 starsMITupdated 3d ago
DocumentationREADME, setup, examples, license
71
EngineeringTests, CI, linting, lockfiles
84
Project healthDescription, activity, stars, deps
97

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

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

  2. 2
    CI/CD
    EngineeringInfo

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

  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

71
  • 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 instructions45
    • README documents how to install the project.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use 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

84
  • Tests100
    • Test files detected (test).
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/ci-build.yml).
    • CI workflow runs tests.
    • 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.
    • CI reports or uploads test coverage.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting95
    • Linter or formatter configured (.editorconfig).
    • Lint script wired into package.json.
    • tsconfig.json has `strict: true`. Full TypeScript type safety enabled.
  • Reproducibility100
    • Lockfile present (package-lock.json). Installs are reproducible.
    • Environment pinned via test/docker-compose.yml.
    • Dependabot covers 2 ecosystems (npm, npm). Dependencies stay current.
    • Dependabot is not configured for GitHub Actions.Add a `package-ecosystem: github-actions` entry to keep workflow action versions up to date.
  • Issue and PR templates10
    • No issue or PR templates found (−90 pts).Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
    • Security policy present.

Project health

97
  • 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: TypeScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 4,365 stars.
  • Housekeeping100
    • .gitignore present.
Repository files38 root entries
  • .github
    Good: CI is configured (.github/workflows/ci-build.yml).
    Good: Dependabot covers 2 ecosystems (npm, npm). Dependencies stay current.
  • benchmarks
  • fixtures
  • lib
  • test
    Good: Test files detected (test).
    Good: Environment pinned via test/docker-compose.yml.
  • tools
  • typings
  • website
  • .cursorrules
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • .nycrc
  • .prettierignore
  • .prettierrc
  • .windsurfrules
  • AGENTS.md
  • Changelog.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.
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • Contributing.md
  • deno.json
  • eslint.config.mjs
  • index.d.ts
  • index.js
  • 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).
  • poku.config.js
  • promise.d.ts
  • promise.js
  • 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.
    Warning: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • rollup.config.mjs
  • SECURITY.md
    Good: Security policy present.
  • tea.yaml
  • tsconfig.json