oxc-project/oxcNew scan
79/ 100 · C

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

⚓ A collection of high-performance JavaScript tools.

Rust21,590 starsMITupdated 2d ago
DocumentationREADME, setup, examples, license
65
EngineeringTests, CI, linting, lockfiles
91
Project healthDescription, activity, stars, deps
75

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

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

  3. 3
    README
    DocumentationWarning

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

Detailed breakdown

Documentation

65
  • README65
    • 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 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 instructions45
    • No install instructions found in the README (−45 pts).Add a section showing how to install dependencies.
    • 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 guide56
    • Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • 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 lacks a PR workflow section (−8 pts).Explain how to fork, branch, and open a pull request so contributors know what to expect.
    • 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

91
  • Tests100
    • Test files detected (apps/oxfmt/test).
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/ci.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.
    • 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 caches dependencies for faster runs.
    • CI includes a build step.
  • Linting and formatting75
    • Linter or formatter configured (.editorconfig).
    • Lint script wired into package.json.
  • Reproducibility80
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via .devcontainer/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

75
  • Dependency manifest65
    • Dependency manifest found (Cargo.toml).
    • package.json is missing a description (−10 pts).Add a one-line description to package.json. It appears in npm search and on GitHub.
    • package.json has no repository field (−10 pts).Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.
    • package.json has no keywords (−8 pts).Add a `keywords` array to help people find your package on npm.
    • package.json has no homepage field (−7 pts).Add a `homepage` field pointing to your docs or project website.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 21,590 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (apps/oxfmt/test/cli/init_with_schema/fixtures/node_modules/oxfmt) (−40 pts).Remove them and add to .gitignore.
Repository files43 root entries
  • .agents
  • .cargo
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • .vscode
  • .zed
  • apps
    Good: Test files detected (apps/oxfmt/test).
    Warning: Build artifacts or local files may be committed (apps/oxfmt/test/cli/init_with_schema/fixtures/node_modules/oxfmt) (−40 pts).Fix: Remove them and add to .gitignore.
  • crates
  • napi
  • npm
  • tasks
  • .clippy.toml
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .ignore
  • .node-version
  • .rustfmt.toml
  • .typos.toml
  • AGENTS.md
  • ARCHITECTURE.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 present (+6 pts for length); 400+ words earns the full +12 pts.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    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).
    Info: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • CLAUDE.md
  • cliff.toml
  • CONTRIBUTING.md
  • Cross.toml
  • deny.toml
  • justfile
  • LICENSE
    Good: Licensed under MIT.
  • MAINTENANCE.md
  • oxc_release.toml
  • oxfmtrc.jsonc
  • oxlintrc.json
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • 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.
    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.
    Warning: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • rust-toolchain.toml
  • THIRD-PARTY-LICENSE
  • vite-task.json