google/zxNew scan
89/ 100 · B

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

A tool for writing better scripts

JavaScript45,533 starsApache-2.0updated 4d ago
DocumentationREADME, setup, examples, license
81
EngineeringTests, CI, linting, lockfiles
90
Project healthDescription, activity, stars, deps
100

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
    CI/CD
    EngineeringInfo

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

Detailed breakdown

Documentation

81
  • 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 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 Apache-2.0.
  • Contributing guide70
    • CONTRIBUTING guide or docs directory present.
    • 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

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

    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 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.
    • 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 formatting70
    • Linting configured via package.json scripts or devDependencies.
    • tsconfig.json has `strict: true`. Full TypeScript type safety enabled.
  • Reproducibility80
    • Lockfile present (package-lock.json). Installs are reproducible.
    • Environment pinned via dcr/Dockerfile.
    • 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.
  • Issue and PR templates100
    • Issue or PR templates present.
    • 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: JavaScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 45,533 stars.
  • Housekeeping100
    • .gitignore present.
Repository files24 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • build
  • dcr
    Good: Environment pinned via dcr/Dockerfile.
  • docs
    Good: CONTRIBUTING guide or docs directory present.
  • examples
  • man
  • scripts
  • src
  • test
    Good: Test files detected (test).
  • test-d
  • .commitlintrc
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .node_version
  • .nycrc
  • .prettierignore
  • .size-limit.json
  • lefthook.yml
  • LICENSE
    Good: Licensed under Apache-2.0.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
    Good: README documents how to run the project.
  • tsconfig.json
  • zizmor.yml