lineguard 0.1.7

A fast and reliable file linter that ensures proper line endings and clean formatting
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

.PHONY: all build test check fmt clippy clean release help

# Default target
all: check test

# Build the project
build:
	cargo build

# Run all tests
test:
	cargo test

# Run all checks (fmt, clippy, build, test)
check: fmt clippy build test
	@echo "✅ All checks passed!"

# Check code formatting
fmt:
	cargo fmt --all -- --check

# Run clippy
clippy:
	cargo clippy --all-targets --all-features -- -D warnings

# Clean build artifacts
clean:
	cargo clean

# Build release version
release:
	cargo build --release

# Run the tool
run:
	cargo run --

# Install locally
install:
	cargo install --path .

# Uninstall
uninstall:
	cargo uninstall lineguard

# Setup git hooks
setup-hooks:
	@echo "Installing git hooks..."
	@mkdir -p .git/hooks
	@cp examples/pre-commit.sh .git/hooks/pre-commit
	@chmod +x .git/hooks/pre-commit
	@echo "Git hooks installed!"

# Run benchmarks
bench:
	cargo build --release
	@echo "Running benchmarks..."
	@command -v hyperfine >/dev/null 2>&1 || { echo "hyperfine not installed. Install with: cargo install hyperfine"; exit 1; }
	hyperfine --warmup 3 './target/release/lineguard src' './target/release/lineguard "src/**/*.rs"'

# Generate coverage report
coverage:
	@command -v cargo-tarpaulin >/dev/null 2>&1 || cargo install cargo-tarpaulin
	cargo tarpaulin --out html --avoid-cfg-tarpaulin
	@echo "Coverage report generated at: target/tarpaulin/tarpaulin-report.html"

# Security audit
audit:
	@command -v cargo-audit >/dev/null 2>&1 || cargo install cargo-audit
	cargo audit

# Update dependencies
update-deps:
	@command -v cargo-edit >/dev/null 2>&1 || cargo install cargo-edit
	cargo upgrade --workspace --incompatible

# Development workflow (format and test)
dev:
	cargo fmt --all
	cargo test
	@echo "Ready for commit!"

# Show help
help:
	@echo "Available targets:"
	@echo "  make all         - Run checks and tests (default)"
	@echo "  make build       - Build the project"
	@echo "  make test        - Run all tests"
	@echo "  make check       - Run all checks (fmt, clippy, build, test)"
	@echo "  make fmt         - Check code formatting"
	@echo "  make clippy      - Run clippy linter"
	@echo "  make clean       - Clean build artifacts"
	@echo "  make release     - Build release version"
	@echo "  make run         - Run the tool"
	@echo "  make install     - Install locally"
	@echo "  make setup-hooks - Install git hooks"
	@echo "  make bench       - Run benchmarks"
	@echo "  make coverage    - Generate coverage report"
	@echo "  make audit       - Run security audit"
	@echo "  make update-deps - Update dependencies"
	@echo "  make dev         - Development workflow (format + test)"
	@echo "  make help        - Show this help message"