nickel-lang/nickelNew scan
82/ 100 · B

Good community traction and solid fundamentals. Nearly in the top tier.

Better configuration for less

Rust2,931 starsMITupdated 3d ago
DocumentationREADME, setup, examples, license
92
EngineeringTests, CI, linting, lockfiles
73
Project healthDescription, activity, stars, deps
92

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

92
  • 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 guide65
    • Contributing guide is detailed and thorough.
    • 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 describes the PR/review workflow.
    • 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

73
  • Tests90
    • Test files detected (cli/tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/continuous-integration.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 formatting40
    • Rust projects have clippy available. Run `cargo clippy` for linting.
    • CI does not appear to run `cargo clippy` (−40 pts vs enforcing it in CI).Add `cargo clippy -- -D warnings` and `cargo fmt --check` as CI steps.
    • No rustfmt.toml found.Add a rustfmt.toml to enforce a consistent code style across contributors.
  • Reproducibility92
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via Dockerfile.
    • Consider using a multi-stage Dockerfile (builder + runtime stage) for smaller, more secure images.Use a multi-stage Dockerfile.
    • Dependabot configured for github-actions.
    • Dependabot only covers one ecosystem (+12 pts; covering 2+ earns +20 pts).Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • Issue and PR templates0
    • No issue or PR templates found (−90 pts).Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

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).
    • 2,931 stars.
  • Housekeeping100
    • .gitignore present.
Repository files42 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/continuous-integration.yml).
    Good: Dependabot configured for github-actions.
  • .vscode
  • cli
    Good: Test files detected (cli/tests).
  • core
  • doc
  • examples
  • flock
  • fmt
  • git
  • lsp
  • nickel
  • notes
  • package
  • parser
  • py-nickel
  • rfcs
  • scripts
  • spec
  • utils
  • vector
  • wasm-repl
  • .envrc
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.json
  • .vscodeignore
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • default.nix
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • flake.lock
  • flake.nix
  • HACKING.md
  • LICENSE
    Good: Licensed under MIT.
  • out.json
  • RATIONALE.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.
  • RELEASES.md
  • RELEASING.md
  • rust-toolchain.toml
  • shell.nix