streamich/react-useNew scan
88/ 100 ยท B

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

React Hooks โ€” ๐Ÿ‘

TypeScript43,976 starsUnlicenseupdated 6d ago
DocumentationREADME, setup, examples, license
74
EngineeringTests, CI, linting, lockfiles
96
Project healthDescription, activity, stars, deps
94

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  2. 2
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  3. 3
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

Detailed breakdown

Documentation

74
  • README50
    • README is present.
    • README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    • 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 no code examples (โˆ’15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • 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 Unlicense.
  • Contributing guide70
    • 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 includes code examples.
    • 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

96
  • Tests100
    • Test files detected (jest.config.ts).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/check-codebase.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • 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 caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting95
    • Linter or formatter configured (.editorconfig).
    • Lint script wired into package.json.
    • tsconfig.json has `strict: true`. Full TypeScript type safety enabled.
  • Reproducibility70
    • Lockfile present (yarn.lock). Installs are reproducible.
    • 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.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

94
  • Dependency manifest92
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
    • package.json has no keywords (โˆ’8 pts).Add a `keywords` array to help people find your package on npm.
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 43,976 stars.
  • Housekeeping100
    • .gitignore present.
Repository files23 root entries
  • .github
    Good: CI is configured (.github/workflows/check-codebase.yml).
    Good: Issue or PR templates present.
  • .storybook
  • docs
  • src
  • stories
  • tests
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintrc.js
  • .gitignore
    Good: .gitignore present.
  • .travis.yml
  • babel.config.js
  • CHANGELOG.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.
    Good: Contributing guide includes code examples.
  • CONTRIBUTING.md
  • jest.config.base.ts
  • jest.config.node.ts
  • jest.config.ts
    Good: Test files detected (jest.config.ts).
  • LICENSE
    Good: Licensed under Unlicense.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Info: README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    Info: 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • renovate.json
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.json
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.