piotrmachowski/lovelace-xiaomi-vacuum-map-card

0

/ 100

Documentation94
Engineering47
Health98
TypeScript1,888MIT1d ago
Grade a repo

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

This card provides a user-friendly way to fully control map-based vacuums in Home Assistant. Supported brands include Xiaomi (Roborock/Viomi/Dreame/Roidmi/Valetudo/Valetudo RE), Neato, Wyze, Roomba, Ecovacs (and probably more).

Documentation

94

Contributing guide5pt78

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

47

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

CI/CD14pt57

CI is configured (.github/workflows/build.yml).

Reproducibility6pt70

Lockfile present (package-lock.json). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.js).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

98

Dependency manifest6pt93

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 275
    Forks
  • 50
    Releaseslatest 6y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 1,888
    Watchers

Responsiveness

  • 2h
    Median issue response
  • 9h
    Median PR merge time
  • 50
    Open issues
Repository files18 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Issue or PR templates present.
  • .vscode
  • docs
  • src
  • .eslintrc.js
    Good: Linter or formatter configured (.eslintrc.js).
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc.js
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: 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.
    Good: Contributing guide includes code examples.
  • hacs.json
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
  • rollup.config.dev.js
  • rollup.config.js
  • tsconfig.json