launchbadge/sqlxNew scan
84/ 100 Ā· B

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

šŸ§° The Rust SQL Toolkit. An async, pure Rust SQL crate featuring compile-time checked queries without a DSL. Supports PostgreSQL, MySQL, and SQLite.

Rust17,142 starsApache-2.0updated 5d ago
DocumentationREADME, setup, examples, license
88
EngineeringTests, CI, linting, lockfiles
80
Project healthDescription, activity, stars, deps
88

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

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

  2. 2
    README
    DocumentationWarning

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

  3. 3
    Reproducibility
    EngineeringWarning

    Run `cargo build` and commit the resulting Cargo.lock file.

Detailed breakdown

Documentation

88
  • README80
    • 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.
    • README includes status badges.
  • Install and run instructions100
    • README documents how to install the project.
    • README documents how to run the project.
    • .env.example is present. Contributors can see exactly which env vars to set.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide71
    • 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 lacks a testing section (āˆ’8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    • 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.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

80
  • Tests90
    • Test files detected (examples/postgres/axum-social-with-tests/tests).
    • Cargo.toml has dev-dependencies and test files are present.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/examples.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting60
    • Linter or formatter configured (.editorconfig).
  • Reproducibility10
    • No Cargo.lock found (āˆ’70 pts). Rust binary/application crates should commit Cargo.lock.Run `cargo build` and commit the resulting Cargo.lock file.
    • Environment pinned via examples/postgres/mockable-todos/docker-compose.yml.
    • 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.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • 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

88
  • Dependency manifest75
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml includes a description for crates.io.
    • Cargo.toml is missing a license field (āˆ’10 pts).Add `license = "MIT"` (or your preferred SPDX identifier) to [package].
    • Cargo.toml is missing a repository field (āˆ’10 pts).Add `repository = "https://github.com/owner/repo"` to [package].
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 17,142 stars.
  • Housekeeping100
    • .gitignore present.
    • A .env file exists in a test directory (tests/.env). This is a test fixture, not a committed secret.
Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/examples.yml).
    Good: Issue or PR templates present.
  • benches
  • contrib
  • examples
    Good: Test files detected (examples/postgres/axum-social-with-tests/tests).
    Good: Environment pinned via examples/postgres/mockable-todos/docker-compose.yml.
  • sqlx-cli
  • sqlx-core
  • sqlx-macros
  • sqlx-macros-core
  • sqlx-mysql
  • sqlx-postgres
  • sqlx-sqlite
  • sqlx-test
  • src
  • tests
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • 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 .).
    Info: 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.
    Info: Contributing guide has no code examples (āˆ’5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • clippy.toml
  • CONTRIBUTING.md
  • FAQ.md
  • gen-changelog.sh
  • LICENSE-APACHE
  • LICENSE-MIT
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • rust-toolchain.toml