mobxjs/mobxNew scan
89/ 100 · B

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

Simple, scalable state management.

TypeScript28,192 starsMITupdated 8d ago
DocumentationREADME, setup, examples, license
83
EngineeringTests, CI, linting, lockfiles
97
Project healthDescription, activity, stars, deps
78

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
    Install and run instructions
    DocumentationWarning

    Add a section showing how to start or use the project.

  3. 3
    Install and run instructions
    DocumentationInfo

    Add a .env.example listing all required environment variables so contributors know what to set up.

Detailed breakdown

Documentation

83
  • 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 instructions45
    • README documents how to install the project.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use 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 guide89
    • Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.
    • Contributing guide includes setup/install instructions.
    • 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 explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

97
  • Tests100
    • Test files detected (jest.config.js).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/build_and_test.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.
    • CI reports or uploads test coverage.
    • 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.
  • Reproducibility82
    • Lockfile present (package-lock.json). 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.
    • 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 templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

78
  • Dependency manifest75
    • Dependency manifest found (package.json).
    • package.json is missing a description (−10 pts).Add a one-line description to package.json. It appears in npm search and on GitHub.
    • 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.
    • package.json has no homepage field (−7 pts).Add a `homepage` field pointing to your docs or project website.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 28,192 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (packages/eslint-plugin-mobx/preview/node_modules/eslint-plugin-mobx) (−40 pts).Remove them and add to .gitignore.
Repository files26 root entries
  • .changeset
  • .github
    Good: CI is configured (.github/workflows/build_and_test.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • .idea
  • .vscode
  • docs
  • packages
    Warning: Build artifacts or local files may be committed (packages/eslint-plugin-mobx/preview/node_modules/eslint-plugin-mobx) (−40 pts).Fix: Remove them and add to .gitignore.
  • scripts
  • website
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintrc.js
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc
  • .watchmanconfig
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.
    Good: Contributing guide includes setup/install instructions.
    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 .).
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • jest.base.config.js
  • jest.config.js
    Good: Test files detected (jest.config.js).
  • 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.
    Warning: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.
  • sponsors.md
  • tsconfig.json
  • tsconfig.test.json