44 lines
602 B
Markdown
44 lines
602 B
Markdown
# Code Style
|
|
|
|
## Linting & Formatting
|
|
|
|
```bash
|
|
# Run all linters
|
|
uv run ruff check . --fix
|
|
uv run ruff format .
|
|
uv run isort . --profile black --filter-files
|
|
|
|
# Type checking
|
|
uv run mypy .
|
|
```
|
|
|
|
## Documentation
|
|
|
|
```bash
|
|
# Check docstring style
|
|
uv run pydocstyle app/
|
|
|
|
# Check documentation coverage
|
|
uv run interrogate app/ -v
|
|
|
|
# Build documentation
|
|
uv run mkdocs build
|
|
|
|
# Serve documentation locally
|
|
uv run mkdocs serve
|
|
```
|
|
|
|
## Pre-commit Hooks
|
|
|
|
This project uses pre-commit hooks to ensure code quality:
|
|
|
|
- ruff check
|
|
- ruff format
|
|
- isort
|
|
- mypy
|
|
|
|
Install hooks:
|
|
```bash
|
|
uv run pre-commit install
|
|
```
|