89/ 100 · B
A well-known project done right. Strong docs and solid engineering throughout.
Facilitating high-level interactions between Wasm modules and JavaScript
Rust9,036 starsApache-2.0updated 4d ago
DocumentationREADME, setup, examples, license
EngineeringTests, CI, linting, lockfiles
Project healthDescription, activity, stars, deps
What to fix first
The highest-impact improvements for this repo.
- 1READMEDocumentationWarning
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 2Install and run instructionsDocumentationInfo
Add a .env.example listing all required environment variables so contributors know what to set up.
- 3ReproducibilityEngineeringInfo
For Rust binaries/applications, commit Cargo.lock. For library-only crates, omitting it is the recommended practice per the Cargo guide.
Detailed breakdown
Documentation
83- README80
- 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.
- 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 Apache-2.0.
- Contributing guide59
- 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 explains how to run tests.
- 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.
- 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- Tests90
- Test files detected (crates/cli-support/src/transforms/externref/tests).
- Cargo.toml has dev-dependencies and test files are present.
- CI/CD100
Not applicable?
- CI is configured (.github/workflows/main.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 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.
- Reproducibility75
- No Cargo.lock committed. Correct for Rust library crates (Rust ecosystem convention).For Rust binaries/applications, commit Cargo.lock. For library-only crates, omitting it is the recommended practice per the Cargo guide.
- 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 uses Rust edition 2021 (current best practice).
- Issue and PR templates90
- Issue or PR templates present.
- Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.
Project health
98- Dependency manifest95
- 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).
- 9,036 stars.
- Housekeeping100
- .gitignore present.
Repository files26 root entries
- .cargo
- .githubGood: CI is configured (.github/workflows/main.yml).Good: Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.Good: Issue or PR templates present.
- .vscode
- benches
- benchmarks
- cratesGood: Test files detected (crates/cli-support/src/transforms/externref/tests).
- examples
- guide
- releases
- src
- tests
- .gitattributes
- .gitignoreGood: .gitignore present.
- build.rs
- Cargo.tomlGood: Dependency manifest found (Cargo.toml).
- CHANGELOG.mdGood: 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 .).Good: Contributing guide explains how to run tests.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.
- clippy.toml
- codecov.yml
- CONTRIBUTING.md
- justfile
- LICENSE-APACHE
- LICENSE-MIT
- publish.rs
- README.mdGood: 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.Good: README includes status badges.Good: README documents how to install the project.Good: README documents how to run the project.
- rust-analyzer.toml
- taplo.toml