SuperAPI AI Directory

review-guidelines

Coding & development

View repository

Updated 10-16 07:19

About this skill

Review Guidelines

Additional checks for this codebase:

Code Quality

  • Prefer type over interface for type definitions
  • Use arrow functions (const fn = () =>) over function declarations
  • Use #field (ES2022 private) instead of private field (TypeScript)
  • No any types — use unknown with type guards
  • No index.ts files (except plugin entry points) — use feature-named re-exports
  • Explicit .ts extensions on all local imports
  • Object params when >2 args: fn({ a, b, c }: { ... })
  • Zod namespace import: import * as z from 'zod'
  • Import directly from specific files, not through re-exports within a module

Testing

  • Use test() not it() for test declarations
  • No conditional assertions — assert the condition first
  • Test both branches: try/catch, conditionals, fallbacks
  • Prefer real dependencies over mocks for module resolution tests
  • Organize with describe() blocks

Bun Runtime

  • Bun.file() over fs.existsSync() / readFileSync()
  • Bun.write() over writeFileSync()
  • Bun.$\cmd`overchild_process.spawn()`
  • import.meta.dir over process.cwd()
  • Run commands from repo root with bun --cwd packages/<name> — never cd into packages

Security

  • Never commit secrets, API keys, or tokens
  • Check for OWASP top 10, command injection, XSS
  • Verify new dependencies for license compliance
  • Watch for ReDoS patterns in regex

Breaking Changes

  • Flag any changes to public API signatures
  • Check for TSDoc @public markers on modified exports
  • Verify backward compatibility of Zod schema changes