Development Workflow

Contributor notes for keeping Boreal UI source, package exports, generated prop metadata, and documentation in sync.

Base and wrappers

Base components own behavior. Framework wrappers provide the package-specific styling and client boundaries.

Package output

Published output includes runtime files, type declarations, generated docs, markdown guides, and CLI sources.

Audit before release

Run targeted checks while developing and the full audit before beta or release work.

Component Anatomy

component-files.txttxt

src/components/ComponentName/
  ComponentName.types.ts
  ComponentNameBase.tsx
  core/ComponentName.tsx
  core/ComponentName.scss
  next/ComponentName.tsx
  next/ComponentName.module.scss

Public Component Checklist

Update type definitions in ComponentName.types.ts.
Update shared behavior in ComponentNameBase.tsx.
Update framework wrappers and styles.
Update tests and stories when behavior is user-facing.
Regenerate prop docs with npm run gen:docs.
Update package exports when the import surface changes.

Verification Commands

audit.shbash

npm run gen:docs
npm run audit:types
npm run audit:lint
npm run audit:styles
npm run audit:test
npm run audit:build
npm run audit:package
npm run check:sync

Documentation Checklist

Update public API docs when import paths, barrels, or standalone exports change.
Update installation docs when setup or package entry points change.
Update styling docs when style config, theme, color scheme, or CSS variable APIs change.
Update accessibility docs when ARIA, keyboard, focus, or labeling behavior changes.
Keep generated prop metadata exhaustive and markdown docs practical.