ratatui/ratatuiNew scan
93/ 100 · A

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

A Rust crate for cooking up terminal user interfaces (TUIs) 👨‍🍳🐀 https://ratatui.rs

Rust21,047 starsMITupdated 4d ago
DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
91
Project healthDescription, activity, stars, deps
92

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Install and run instructions
    DocumentationInfo

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

  2. 2
    Reproducibility
    EngineeringInfo

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

Detailed breakdown

Documentation

97
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • 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 guide100
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

91
  • Tests90
    • Test files detected (ratatui-core/tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/check-pr.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.).
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting60
    • Linter or formatter configured (.editorconfig).
  • Reproducibility90
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • 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.
    • Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

92
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml is a workspace manifest for a multi-crate Rust project.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 21,047 stars.
  • Housekeeping100
    • .gitignore present.
Repository files43 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/check-pr.yml).
    Good: Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • .vscode
  • assets
  • examples
  • ratatui
  • ratatui-core
    Good: Test files detected (ratatui-core/tests).
  • ratatui-crossterm
  • ratatui-macros
  • ratatui-termina
  • ratatui-termion
  • ratatui-termwiz
  • ratatui-widgets
  • xtask
  • .cliffignore
  • .cz.toml
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.yaml
  • ARCHITECTURE.md
  • bacon.toml
  • BREAKING-CHANGES.md
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • cliff.toml
  • clippy.toml
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • committed.toml
  • CONTRIBUTING.md
  • deny.toml
  • FUNDING.json
  • LICENSE
    Good: Licensed under MIT.
  • MAINTAINERS.md
  • 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.
  • release-plz.toml
  • RELEASE.md
  • rust-toolchain.toml
  • rustfmt.toml
  • SECURITY.md
    Good: Security policy present.
  • tombi.toml
  • typos.toml