Code Standards
Topics:
- Naming conventions — files / classes / functions / paths / role / button / route names
- Vue style — SFC script order, template rules
- Backend style — enforced checklist (response, schema, API, CRUD, permissions, models)
Toolchain
| Concern | Tool | Command |
|---|---|---|
| Backend lint / format | Ruff (line 200, double-quote, rules E/F/I) | just fmt backend / just lint backend |
| Backend types | basedpyright (standard mode) | just typecheck backend |
| Backend tests | pytest | just test backend |
| Frontend lint | ESLint (@soybeanjs/eslint-config-vue) + oxlint | just lint frontend |
| Frontend types | vue-tsc | just typecheck frontend |
| Full stack | — | just check |
| Pre-commit hook | simple-git-hooks | auto-installed via cd web && pnpm install |
Pre-commit gate
bash
just checkOr run only the side you touched: just check backend / just check frontend.
Recommended VS Code setup
- Backend: install Charliermarsh.ruff + DetachHead.basedpyright
- Frontend: install Vue.volar + dbaeumer.vscode-eslint
- Auto-fix on save:
"editor.codeActionsOnSave": { "source.fixAll": "explicit" }