Codebase Skill — Complete Operational Guide

Description

# Codebase Skill — Complete Operational Guide > **KEEP THIS FILE UP TO DATE.** When architectural decisions change, files move, new patterns are adopted, or conventions shift, update this file immediately. Stale guidance is worse than no guidance. After any structural change (new store, renamed file, new dependency, changed workflow), check if this file needs updating. --- ## Quick Reference Commands ```bash pnpm dev # Dev server → localhost:5173 pnpm build # tsc && vite build → dist/ pnpm lint # ESLint (--max-warnings 0, zero tolerance) pnpm test # Playwright E2E (full suite, ~10 min) pnpm test:headed # E2E with visible browser pnpm test:ui # E2E Playwright UI debug mode pnpm test:unit # Vitest unit tests (src/**/*.test.ts) npx tsx scripts/take-screenshots.ts # All 8 showcase screenshots npx tsx scripts/take-screenshots.ts 2 # Single screenshot by index npx tsx scripts/take-screenshots.ts composite # Re-composite from existing raws ``` --- ## File Map — Where to Find Everything ### By Purpose | I need to... | Look here | |---------------------------------------|-----------------------------------------------------| | Add/change a React component | `src/components/` | | Add/change chart logic | `src/components/LogChart.tsx` + `src/components/logChart/` | | Add/change chart styles | `src/components/LogChart.styles.ts` | | Add a new tuning rule | `src/domain/rules/` (create new file, register in RuleEngine) | | Change how analysis works | `src/domain/engine/RuleEngine.ts` | | Add/change a Betaflight parameter | `src/domain/types/Analysis.ts` (BetaflightParameter type) | | Map parameter to CLI command | `src/domain/utils/CliExport.ts` | | Add CLI option metadata/ranges | `src/lib/betaflight/cliOptions.ts` | | Change how .bbl/.bfl files parse | `src/domain/blackbox/` | | Change how .txt/.csv files parse | `src/workers/logParser.worker.ts` | | Add/change a MobX store | `src/stores/` | | Wire a new store into the app | `src/stores/RootStore.ts` | | Add/change theme colors | `src/theme/lightTheme.ts`, `src/theme/darkTheme.ts` | | Add/change theme type | `src/theme/types.ts` (ThemeColors interface) | | Add global CSS animations | `src/theme/GlobalStyles.tsx` | | Add/change MobX reactive primitives | `src/lib/mobx-reactivity/` | | Add/change serial (USB) communication | `src/serial/` | | Add/change quad profile thresholds | `src/domain/profiles/quadProfiles.ts` | | Add/change issue descriptions on chart| `src/domain/utils/issueChartDescriptions.ts` | | Update changelog | `src/data/changelog.ts` | | Add/change glossary terms | `src/data/glossary.ts` | | Change build/deploy | `vite.config.ts`, `.github/workflows/deploy.yml` | | Change virtual:changelog module | `vite-plugins/changelogPlugin.ts` | | Add/change E2E tests | `e2e/` (specs + helpers) | | Add/change unit tests | Co-located with source: `src/**/*.test.ts` | | Change Playwright config | `playwright.config.ts` | | Change ESLint rules | `eslint.config.js` | | Check TS config | `tsconfig.json` (`useDefineForClassFields: false`) |

Security Status