Skip to content

Commit 92fbebd

Browse files
Ajit Pratap Singhclaude
authored andcommitted
docs: update all documentation references from Make to Task
Update remaining Make/Makefile references across documentation: - CONTRIBUTING.md: Update prerequisites, hooks installation commands, and PR checklist to use task commands - scripts/install-hooks.sh: Update hint message from 'make fmt' to 'task fmt' - docs/CLI_GUIDE.md: Replace Makefile example with Taskfile.yml example for build tools integration - docs/PRODUCTION_GUIDE.md: Update build tools reference to Task 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6d77f5c commit 92fbebd

4 files changed

Lines changed: 25 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ GoSQLX aims to be the **fastest, most reliable, and most comprehensive SQL parsi
3838
### Prerequisites
3939
- **Go 1.19+** (latest stable version recommended)
4040
- **Git** for version control
41-
- **Make** for build automation (optional)
41+
- **Task** for task automation (optional) - Install with `go install github.com/go-task/task/v3/cmd/task@latest`
4242

4343
### Getting Started
4444
```bash
@@ -60,7 +60,7 @@ go test ./...
6060
go test -race ./...
6161

6262
# 7. Install Git hooks (RECOMMENDED)
63-
make install-hooks
63+
task hooks:install
6464
# or
6565
./scripts/install-hooks.sh
6666
```
@@ -70,8 +70,8 @@ make install-hooks
7070
GoSQLX provides pre-commit hooks to catch code quality issues before they reach CI/CD:
7171

7272
```bash
73-
# Install hooks using Make
74-
make install-hooks
73+
# Install hooks using Task
74+
task hooks:install
7575

7676
# Or run the script directly
7777
./scripts/install-hooks.sh
@@ -393,7 +393,7 @@ Many applications use PostgreSQL's JSON features extensively...
393393
## 📋 Pull Request Checklist
394394

395395
### Before Submitting
396-
- [ ] **Git Hooks**: Pre-commit hooks installed and passing (`make install-hooks`)
396+
- [ ] **Git Hooks**: Pre-commit hooks installed and passing (`task hooks:install`)
397397
- [ ] **Tests**: All tests pass with `go test -race ./...`
398398
- [ ] **Coverage**: New code has >95% test coverage
399399
- [ ] **Performance**: No performance regression

docs/CLI_GUIDE.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -510,20 +510,29 @@ gosqlx validate current_file.sql
510510
```
511511

512512
### Build Tools Integration
513-
```makefile
514-
# Makefile example
515-
.PHONY: sql-lint sql-format sql-check
513+
```yaml
514+
# Taskfile.yml example (using go-task)
515+
version: '3'
516516
517-
sql-lint:
518-
gosqlx validate src/**/*.sql
517+
tasks:
518+
sql:lint:
519+
desc: Validate SQL files
520+
cmds:
521+
- gosqlx validate src/**/*.sql
519522
520-
sql-format:
521-
gosqlx format -i src/**/*.sql
523+
sql:format:
524+
desc: Format SQL files in place
525+
cmds:
526+
- gosqlx format -i src/**/*.sql
522527
523-
sql-check:
524-
gosqlx format --check src/**/*.sql
528+
sql:check:
529+
desc: Check SQL formatting
530+
cmds:
531+
- gosqlx format --check src/**/*.sql
525532
```
526533

534+
Run with: `task sql:lint`, `task sql:format`, or `task sql:check`
535+
527536
## Troubleshooting
528537

529538
### Common Issues

docs/PRODUCTION_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ GoSQLX is **production-ready** for enterprise deployment with validated performa
1919
### Dependencies
2020
- **Core Library**: Zero external dependencies
2121
- **Optional Tools**: Standard library only
22-
- **Build Tools**: Go toolchain, make (optional)
22+
- **Build Tools**: Go toolchain, Task (optional) - `go install github.com/go-task/task/v3/cmd/task@latest`
2323

2424
## Installation Methods
2525

scripts/install-hooks.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ if [ -n "$UNFORMATTED" ]; then
5151
echo "$UNFORMATTED"
5252
echo ""
5353
echo "To fix, run: gofmt -w ."
54-
echo "Or use: make fmt"
54+
echo "Or use: task fmt"
5555
exit 1
5656
fi
5757
echo "✓ Code formatting check passed"

0 commit comments

Comments
 (0)