Skip to content

Commit 0856d3c

Browse files
committed
docs: replace Makefile with Taskfile across all documentation
1 parent da0ecf6 commit 0856d3c

File tree

16 files changed

+367
-320
lines changed

16 files changed

+367
-320
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Thank you for your interest in contributing to CCProxy API! This guide will help
1717
```bash
1818
git clone https://github.com/CaddyGlow/ccproxy-api.git
1919
cd ccproxy-api
20-
make setup # Installs dependencies and sets up dev environment
20+
./Taskfile setup # Installs dependencies and sets up dev environment
2121
```
2222

23-
> **Note**: Pre-commit hooks are automatically installed with `make setup`
23+
> **Note**: Pre-commit hooks are automatically installed with `./Taskfile setup`
2424
2525
## Development Workflow
2626

@@ -40,13 +40,13 @@ git checkout -b feature/your-feature-name
4040

4141
```bash
4242
# Recommended: Run comprehensive checks with auto-fixes
43-
make pre-commit
43+
./Taskfile pre-commit
4444

4545
# Alternative: Run individual checks
46-
make format # Format code
47-
make lint # Check linting
48-
make typecheck # Check types
49-
make test-unit # Run fast tests
46+
./Taskfile format # Format code
47+
./Taskfile lint # Check linting
48+
./Taskfile typecheck # Check types
49+
./Taskfile test-unit # Run fast tests
5050
```
5151

5252
### 4. Commit Your Changes
@@ -65,7 +65,7 @@ git commit -m "feat: add new feature"
6565

6666
Before pushing:
6767
```bash
68-
make ci # Runs full CI pipeline locally (pre-commit + tests)
68+
./Taskfile ci # Runs full CI pipeline locally (pre-commit + tests)
6969
```
7070

7171
### 6. Push and Create PR
@@ -83,11 +83,11 @@ All code must pass these checks before merging:
8383

8484
| Check | Command | Purpose | Auto-fix |
8585
|-------|---------|---------|----------|
86-
| **Formatting** | `make format` | Code style consistency ||
87-
| **Linting** | `make lint` | Error detection | Partial (`make lint-fix`) |
88-
| **Type Checking** | `make typecheck` | Type safety ||
89-
| **Tests** | `make test` | Functionality ||
90-
| **Pre-commit** | `make pre-commit` | All checks combined ||
86+
| **Formatting** | `./Taskfile format` | Code style consistency ||
87+
| **Linting** | `./Taskfile lint` | Error detection | Partial (`./Taskfile lint-fix`) |
88+
| **Type Checking** | `./Taskfile typecheck` | Type safety ||
89+
| **Tests** | `./Taskfile test` | Functionality ||
90+
| **Pre-commit** | `./Taskfile pre-commit` | All checks combined ||
9191

9292
## Architecture: DI & Services
9393

@@ -160,27 +160,23 @@ The CCProxy test suite uses a streamlined architecture with 606 focused tests or
160160

161161
```bash
162162
# All tests with coverage (recommended)
163-
make test
163+
./Taskfile test
164164

165165
# Fast unit tests only - isolated components, service boundary mocking
166-
make test-unit
166+
./Taskfile test-unit
167167

168168
# Integration tests - cross-component behavior, minimal mocking
169-
make test-integration
169+
./Taskfile test-integration
170170

171171
# Plugin tests - centralized plugin testing
172-
make test-plugins
173-
174-
# Performance tests - benchmarks and load testing
175-
make test-performance
172+
./Taskfile test-plugins
176173

177174
# Coverage report with HTML output
178-
make test-coverage
175+
./Taskfile test-coverage
179176

180177
# Specific patterns
181-
make test-file FILE=unit/auth/test_auth.py
182-
make test-match MATCH="authentication"
183-
make test-watch # Auto-run on file changes
178+
./Taskfile test-file tests/unit/auth/test_auth.py
179+
./Taskfile test-match authentication
184180
```
185181

186182
#### Test Organization
@@ -271,56 +267,56 @@ chore: update dependencies
271267

272268
Test the full CI pipeline locally:
273269
```bash
274-
make ci # Same as GitHub Actions CI workflow
270+
./Taskfile ci # Same as GitHub Actions CI workflow
275271
```
276272

277273
## Common Development Tasks
278274

279275
### Running the Dev Server
280276
```bash
281-
make dev # Starts with debug logging and auto-reload
277+
./Taskfile dev # Starts with debug logging and auto-reload
282278
```
283279

284280
### Debugging Requests
285281
```bash
286282
# Enable verbose logging
287283
CCPROXY_VERBOSE_API=true \
288284
CCPROXY_REQUEST_LOG_DIR=/tmp/ccproxy/request \
289-
make dev
285+
./Taskfile dev
290286

291287
# View last request
292288
scripts/show_request.sh
293289
```
294290

295291
### Building and Testing Docker
296292
```bash
297-
make docker-build
298-
make docker-run
293+
./Taskfile docker-build
294+
./Taskfile docker-run
299295
```
300296

301297
### Documentation
302298
```bash
303-
make docs-build # Build docs
304-
make docs-serve # Serve locally at http://localhost:8000
299+
./Taskfile docs-build # Build docs
300+
./Taskfile docs-serve # Serve locally at http://localhost:8000
305301
```
306302

307303
## Troubleshooting
308304

309305
### Type Errors
310306
```bash
311-
make typecheck
307+
./Taskfile typecheck
312308
# Or for detailed output:
313309
uv run mypy . --show-error-codes
314310
```
315311

316312
### Formatting Issues
317313
```bash
318-
make format # Auto-fixes most issues
314+
./Taskfile format # Auto-fixes most issues
319315
```
320316

321317
### Linting Errors
322318
```bash
323-
make lint-fix # Auto-fix what's possible
319+
./Taskfile lint-fix # Auto-fix what's possible
324320
# Manual fix required for remaining issues
325321
```
326322

@@ -336,7 +332,7 @@ uv run pytest tests/test_file.py -s
336332
### Pre-commit Hook Failures
337333
```bash
338334
# Run manually to see all issues
339-
make pre-commit
335+
./Taskfile pre-commit
340336

341337
# Skip hooks temporarily (not recommended)
342338
git commit --no-verify -m "WIP: debugging"

CONVENTIONS.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ class ProviderAdapter(BaseAdapter):
147147

148148
Core tools enforced via pre-commit and CI:
149149

150-
* **Package Manager:** `uv` (via Makefile only)
150+
* **Package Manager:** `uv` (via Taskfile)
151151
* **Formatter:** `ruff format`
152152
* **Linter:** `ruff check`
153153
* **Type Checker:** `mypy`
@@ -158,29 +158,28 @@ Core tools enforced via pre-commit and CI:
158158

159159
### Required Before Commits
160160
```bash
161-
make pre-commit # Comprehensive checks + auto-fixes
162-
make test # Run tests with coverage
161+
./Taskfile pre-commit # Comprehensive checks + auto-fixes
162+
./Taskfile test # Run tests with coverage
163163
```
164164

165-
### Key Makefile Targets
165+
### Key Taskfile Tasks
166166

167167
| Category | Target | Description |
168168
|----------|--------|-------------|
169-
| **Setup** | `make setup` | Complete dev environment setup |
170-
| **Quality** | `make pre-commit` | All checks with auto-fixes |
171-
| | `make check` | Lint + typecheck + format check |
172-
| | `make format` | Format code |
173-
| | `make lint` | Linting only |
174-
| | `make typecheck` | Type checking |
175-
| **Testing** | `make test` | Full test suite with coverage |
176-
| | `make test-unit` | Fast unit tests only |
177-
| | `make test-integration` | Integration tests (core + plugins) |
178-
| | `make test-integration-plugin PLUGIN=<name>` | Single plugin integration |
179-
| | `make test-plugins` | Only plugin tests |
180-
| **CI** | `make ci` | Full CI pipeline |
181-
| **Build** | `make build` | Build Python package |
182-
| | `make docker-build` | Build Docker image |
183-
| **Dev** | `make dev` | Start dev server with debug logging |
169+
| **Setup** | `./Taskfile setup` | Complete dev environment setup |
170+
| **Quality** | `./Taskfile pre-commit` | All checks with auto-fixes |
171+
| | `./Taskfile check` | Lint + typecheck + format check |
172+
| | `./Taskfile format` | Format code |
173+
| | `./Taskfile lint` | Linting only |
174+
| | `./Taskfile typecheck` | Type checking |
175+
| **Testing** | `./Taskfile test` | Full test suite with coverage |
176+
| | `./Taskfile test-unit` | Fast unit tests only |
177+
| | `./Taskfile test-integration [path]` | Integration tests (core + plugins) |
178+
| | `./Taskfile test-plugins [path]` | Only plugin tests |
179+
| **CI** | `./Taskfile ci` | Full CI pipeline |
180+
| **Build** | `./Taskfile build` | Build Python package |
181+
| | `./Taskfile docker-build` | Build Docker image |
182+
| **Dev** | `./Taskfile dev` | Start dev server with debug logging |
184183

185184
## 14. Documentation
186185

0 commit comments

Comments
 (0)