kysely-org/kyselyNew scan
90/ 100 · A

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

A type-safe TypeScript SQL query builder

TypeScript13,950 starsMITupdated 7d ago
DocumentationREADME, setup, examples, license
90
EngineeringTests, CI, linting, lockfiles
86
Project healthDescription, activity, stars, deps
100

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
    DocumentationInfo

    Show a quick-start snippet so contributors can see what using your project looks like.

Detailed breakdown

Documentation

90
  • README85
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • 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 guide90
    • Contributing guide is detailed and thorough.
    • 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

86
  • Tests100
    • Test files detected (.mocharc.cjs).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/test.yml).
    • 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.
    • CI includes a build step.
  • Linting and formatting75
    • Linter or formatter configured (.prettierrc.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.
  • Reproducibility100
    • Lockfile present (pnpm-lock.yaml). Installs are reproducible.
    • Environment pinned via docker-compose.yml.
    • Dependabot covers 3 ecosystems (npm, bun, github-actions). Dependencies stay current.
  • 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

100
  • Dependency manifest100
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
  • 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).
    • 13,950 stars.
  • Housekeeping100
    • .gitignore present.
    • A .env file exists in a test directory (example/.env). This is a test fixture, not a committed secret.
Repository files33 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Dependabot covers 3 ecosystems (npm, bun, github-actions). Dependencies stay current.
  • assets
  • docs
  • example
  • scripts
  • site
  • src
  • test
  • .gitignore
    Good: .gitignore present.
  • .mocharc.cjs
    Good: Test files detected (.mocharc.cjs).
  • .node-version
  • .nvmrc
  • .prettierignore
  • .prettierrc.json
    Good: Linter or formatter configured (.prettierrc.json).
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
  • deno.check.d.ts
  • deno.check.json
  • deno.lint.json
  • docker-compose.yml
    Good: Environment pinned via docker-compose.yml.
  • FUNDING.md
  • jsr.json
  • LICENSE
    Good: Licensed under MIT.
  • outdated-typescript.d.ts
  • package.json
    Good: Dependency manifest found (package.json).
  • playground.ts
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Info: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.
  • SECURITY.md
    Good: Security policy present.
  • tsconfig-base.json
  • tsconfig.json
  • zizmor.yml