Files

1.6 KiB

Quality Guidelines

Code quality standards for frontend development.


Overview

The workbench frontend uses Prettier as the source formatting authority. Code is formatted before review; formatting is not left to individual editor settings.


Forbidden Patterns

  • Do not commit dense, manually minified, or single-line JSX/TypeScript.
  • Do not hand-format around Prettier output.
  • Do not leave a page component responsible for unrelated form implementations, API calls, and multiple edit histories after a named component or hook boundary exists.
  • Do not duplicate an edit protocol while extracting it. Move ownership and update call sites in one change so there is only one active path.

Required Patterns

  • Run npm run format after editing frontend files.
  • Run npm run format:check in the validation gate.
  • Keep React components, hooks, types, and API clients in separately formatted modules once a component becomes non-trivial.
  • Keep App.tsx as a composition root. New domain behavior belongs in a hook or named component with typed props.
  • Refactors must preserve API call order, DOM-visible labels/defaults, and OpenLayers map identity unless the task explicitly changes them.

Testing Requirements

  • Run npm run format:check, npm run test:client, and npm run build for frontend changes.

Code Review Checklist

  • Formatting check passes.
  • UI behavior changes do not rebuild the OpenLayers map unless the map lifecycle explicitly requires it.
  • Verify ordinary v1 staged, v2 direct-edit, and traffic-signal draft flows independently; passing one flow does not prove the others survived extraction.