mcpField
T
typescript-review

typescript-review

github.com/metabaseTesting & quality49.9k2.3k installsUpdated today
Repository

About typescript-review

typescript-review is a code-review skill for TypeScript and JavaScript changes. It helps reviewers prioritize the project's writing rules, especially the blocking prohibition on new or edited `any` types, while also checking tests, accessibility, performance, security, and other review concerns.

Key features

  1. 01Prioritize typescript-write requirements
  2. 02Block explicit or implicit new `any`
  3. 03Review diffs, tests, and helper files
  4. 04Check accessibility, performance, and security
  5. 05Assess bundle size, analytics, and public APIs

Use cases

  1. 01Review a TypeScript or JavaScript pull request
  2. 02Find violations of project authoring rules
  3. 03Assess test claims and unverified checks
  4. 04Inspect accessibility and security risks

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/metabase/metabase --skill typescript-review

After installing, type/typescript-reviewin Claude Code to confirm it loaded.

Details

From the project README

TypeScript/JavaScript Code Review Skill

@./../_shared/typescript-commands.md @./../_shared/react-redux-patterns.md

Main Focus

Primary standard: the typescript-write skill. Load it first — it defines the authoring rules this review enforces, alongside frontend/AGENTS.md and docs/developers-guide/frontend.md.

Adherence to typescript-write is the highest-priority review dimension: rank any violation of its provisions above all other findings. Treat its no-any hard rule (no explicit or implicit any in new, moved, or otherwise edited code) as blocking. Use TypeScript LSP tools to inspect inferred types when available; otherwise rely on type-checking and linting.

Read the full diff and new files, including tests and helpers. For tests, check that the setup, actions, and assertions exercise the behavior being claimed. Cite the applicable rule and file/line for violations. Report checks that didn't run or didn't cover the change as unverified, not as passed. Passing automated checks don't establish guideline compliance.

Review in this priority order:

  1. Violations of typescript-write provisions — no-any, type tightening, type modeling, function signatures, null/undefined handling, naming, structure, comments. Highest priority; block on the no-any rule. Apply conditional guidance in context: explain the unsupported type guarantee or concrete readability problem, rather than treating every preference as a blanket ban.
  2. Compliance with frontend/AGENTS.md.
  3. Readability and maintainability.
  4. Appropriate test coverage. For internal typed callers, avoid requesting tests solely for inputs the type system excludes. External API data, deserialised values, storage and JavaScript callers can violate annotations: test runtime validation and nontrivial assumptions at those boundaries. Types do not replace behavioural, security or data-integrity tests.

Blind spots — act as the missing reviewer

These rarely surface in team reviews, so this skill should raise them. They are additive — raise them, but rank them below typescript-write violations:

  • Accessibility. Interactive elements need keyboard support, focus management, and accessible names. Flag missing aria-label/aria-labelledby, non-semantic click targets, modals without focus trap, icon-only buttons without labels, and form inputs without a linked label.
  • Performance. Flag areas that scale poorly and aren't memoized; inline object/array literals passed to memoized children; effects that fire on every batch of a progressive load; and new dependencies added to hot paths.
  • Security. Evaluate potential security issues in new, moved, or otherwise edited code.
  • Bundle size. Flag new large dependencies, default imports from icon or util libs, and heavy modules imported at route-load time.
  • Analytics. User-facing flows should emit tracking events. If a PR adds a new flow (button, modal, navigation) without a tracking event, ask whether one is expected.
  • Public API surface (embedding SDK). Consumers should be able to use public signatures and name types they need to import. Export those types deliberately and document public behaviour, including @deprecated for deprecated APIs; a referenced structural type does not automatically need its own named export.

Comments

Markdown supported