benbalter/word-to-markdown-js

0

/ 100

Documentation76
Engineering83
Health92
TypeScript220Apache-2.01d ago
Grade a repo

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

Convert Word documents to beautiful Markdown. Via command line or in your browser.

Documentation

76

README12pt55

README is present.

Contributing guide5pt75

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

83

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.

CI/CD14pt83

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

Tests18pt100

Test files detected (build/__tests__).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Reproducibility6pt100

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

Project health

92

Dependency manifest6pt75

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)
  • 28
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 5d 6h
    Median issue response
  • <1h
    Median PR merge time
  • 15
    Open issues
Repository files28 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 3 ecosystems (npm, github-actions, docker). Dependencies stay current.
  • build
    Good: Test files detected (build/__tests__).
  • docs
  • public
  • scripts
  • src
  • web
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintignore
  • .eslintrc.json
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .prettierrc
  • .tool-versions
  • astro.config.mjs
  • compose.yml
    Good: Environment pinned via compose.yml.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • jest.config.js
  • LICENSE
    Good: Licensed under Apache-2.0.
  • OPTIMIZATION_SUMMARY.md
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • playwright.config.ts
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: 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.
    Issue: 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.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tsconfig.eslint.json
  • tsconfig.json
  • tsconfig.release.json