kawamataryo/vue-word-highlighter

0

/ 100

Documentation94
Engineering57
Health89
TypeScript339MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

The word highlighter library for Vue 2 and Vue 3.

Documentation

94

Contributing guide5pt82

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

57

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Tests18pt35

Test files detected (tests-vue2/jest.config.js).

Reproducibility6pt80

Lockfile present (yarn.lock). Installs are reproducible.

CI/CD14pt83

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

Linting and formatting5pt100

Linter or formatter configured (biome.json).

Project health

89

Dependency manifest6pt65

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)
  • 22
    Forks
  • 17
    Releaseslatest 3y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 339
    Watchers

Responsiveness

  • 19h
    Median issue response
  • <1h
    Median PR merge time
  • 15
    Open issues
Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • .husky
  • example
  • tests-vue2
    Good: Test files detected (tests-vue2/jest.config.js).
  • tests-vue3
  • vue-word-highlighter
  • .gitignore
    Good: .gitignore present.
  • .tool-versions
    Good: Environment pinned via .tool-versions.
  • biome.json
    Good: Linter or formatter configured (biome.json).
  • 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.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • LICENSE
    Good: Licensed under MIT.
  • 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.
  • renovate.json
  • tsconfig.json
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.