eza-community/ezaNew scan
89/ 100 · B

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

A modern alternative to ls

Rust22,269 starsEUPL-1.2updated 16d ago
DocumentationREADME, setup, examples, license
91
EngineeringTests, CI, linting, lockfiles
85
Project healthDescription, activity, stars, deps
97

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringWarning

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  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

91
  • 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 EUPL-1.2.
  • Contributing guide95
    • 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 includes code examples.
    • Code of conduct present.

Engineering

85
  • Tests90
    • Test files detected (tests).
    • Cargo.toml has dev-dependencies and test files are present.
  • CI/CD72

    Not applicable?

    • CI is configured (.github/workflows/unit-tests.yml).
    • The CI workflow does not appear to run any tests (−28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • 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.
  • Linting and formatting80
    • Rust linting enforced in CI: cargo clippy + cargo fmt.
    • No rustfmt.toml found.Add a rustfmt.toml to enforce a consistent code style across contributors.
  • 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.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

97
  • Dependency manifest90
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml includes a description for crates.io.
    • Cargo.toml declares a license.
    • Cargo.toml links to the source repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Rust.
    • Cargo.toml [package] metadata is complete (description, authors, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 22,269 stars.
  • Housekeeping100
    • .gitignore present.
Repository files35 root entries
  • .config
  • .github
    Good: CI is configured (.github/workflows/unit-tests.yml).
    Good: Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • benches
  • completions
  • devtools
  • docs
  • LICENSES
  • man
  • nix
  • snap
  • src
  • tests
    Good: Test files detected (tests).
  • .envrc
  • .git-blame-ignore-revs
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config-non-nix.yaml
  • build.rs
  • 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.
    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.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • deb.asc
  • deny.toml
  • flake.lock
  • flake.nix
  • INSTALL.md
  • justfile
  • LICENSE.txt
    Good: Licensed under EUPL-1.2.
  • powertest.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.
  • REUSE.toml
  • rust-toolchain.toml
  • SECURITY.md
    Good: Security policy present.
  • TESTING.md