askr 0.1.0

Interactive CLI input tool with real-time validation and choice menus
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207

# askr - Interactive CLI input tool
# Makefile for building, testing, and releasing

.PHONY: help build test clean lint fmt check install uninstall
.PHONY: release-dry release tag docs examples
.PHONY: completion completions pre-commit setup
.DEFAULT_GOAL := help

# Build configuration
CARGO := cargo
TARGET_DIR := target
BINARY_NAME := askr
VERSION := $(shell grep '^version =' Cargo.toml | head -1 | cut -d '"' -f 2)

# Colors for output
RED := \033[31m
GREEN := \033[32m
YELLOW := \033[33m
BLUE := \033[34m
BOLD := \033[1m
RESET := \033[0m

help: ## Show this help message
	@echo "$(BOLD)askr v$(VERSION) - Interactive CLI input tool$(RESET)"
	@echo ""
	@echo "$(BOLD)Available targets:$(RESET)"
	@awk 'BEGIN {FS = ":.*##"; printf ""} /^[a-zA-Z_-]+:.*?##/ { printf "  $(GREEN)%-15s$(RESET) %s\n", $$1, $$2 }' $(MAKEFILE_LIST)

# Development targets
build: ## Build the project in debug mode
	@echo "$(BLUE)Building $(BINARY_NAME)...$(RESET)"
	$(CARGO) build

build-release: ## Build the project in release mode
	@echo "$(BLUE)Building $(BINARY_NAME) (release)...$(RESET)"
	$(CARGO) build --release

test: ## Run all tests
	@echo "$(BLUE)Running tests...$(RESET)"
	$(CARGO) test

test-verbose: ## Run tests with verbose output
	@echo "$(BLUE)Running tests (verbose)...$(RESET)"
	$(CARGO) test -- --nocapture

check: ## Check code without building
	@echo "$(BLUE)Checking code...$(RESET)"
	$(CARGO) check

# Code quality targets
lint: ## Run clippy lints
	@echo "$(BLUE)Running clippy...$(RESET)"
	$(CARGO) clippy --all-targets --all-features -- -D unused-imports -D clippy::collapsible_else_if -D clippy::int_plus_one

lint-fix: ## Run clippy with automatic fixes
	@echo "$(BLUE)Running clippy with fixes...$(RESET)"
	$(CARGO) clippy --fix --allow-dirty --allow-staged

fmt: ## Format code with rustfmt
	@echo "$(BLUE)Formatting code...$(RESET)"
	$(CARGO) fmt

fmt-check: ## Check code formatting
	@echo "$(BLUE)Checking code formatting...$(RESET)"
	$(CARGO) fmt --check

# Installation targets
install: build-release ## Install the binary locally
	@echo "$(BLUE)Installing $(BINARY_NAME)...$(RESET)"
	$(CARGO) install --path .

uninstall: ## Uninstall the binary
	@echo "$(BLUE)Uninstalling $(BINARY_NAME)...$(RESET)"
	$(CARGO) uninstall $(BINARY_NAME)

# Release targets
release-dry: ## Dry run of crates.io release
	@echo "$(BLUE)Dry run release to crates.io...$(RESET)"
	$(CARGO) publish --dry-run

release: ## Publish to crates.io
	@echo "$(YELLOW)Publishing $(BINARY_NAME) v$(VERSION) to crates.io...$(RESET)"
	@echo "$(RED)Warning: This will publish to crates.io!$(RESET)"
	@read -p "Continue? [y/N] " -n 1 -r; \
	if [[ $$REPLY =~ ^[Yy]$$ ]]; then \
		echo ""; \
		$(CARGO) publish; \
		echo "$(GREEN)Successfully published to crates.io!$(RESET)"; \
	else \
		echo ""; \
		echo "$(YELLOW)Release cancelled.$(RESET)"; \
	fi

tag: ## Create and push a git tag for current version
	@echo "$(BLUE)Creating tag v$(VERSION)...$(RESET)"
	git tag -a v$(VERSION) -m "Release v$(VERSION)"
	git push origin v$(VERSION)
	@echo "$(GREEN)Tag v$(VERSION) created and pushed!$(RESET)"

# Documentation targets
docs: ## Generate and open documentation
	@echo "$(BLUE)Generating documentation...$(RESET)"
	$(CARGO) doc --open

docs-build: ## Build documentation without opening
	@echo "$(BLUE)Building documentation...$(RESET)"
	$(CARGO) doc

# Shell completion targets
completion: completions ## Alias for completions

completions: build ## Generate shell completions
	@echo "$(BLUE)Generating shell completions...$(RESET)"
	@mkdir -p completions
	./$(TARGET_DIR)/debug/$(BINARY_NAME) completion bash > completions/$(BINARY_NAME).bash
	./$(TARGET_DIR)/debug/$(BINARY_NAME) completion zsh > completions/$(BINARY_NAME).zsh
	./$(TARGET_DIR)/debug/$(BINARY_NAME) completion fish > completions/$(BINARY_NAME).fish
	./$(TARGET_DIR)/debug/$(BINARY_NAME) completion power-shell > completions/$(BINARY_NAME).ps1
	@echo "$(GREEN)Completions generated in completions/$(RESET)"

# Example targets
examples: build ## Run example scripts
	@echo "$(BLUE)Running example scripts...$(RESET)"
	@if [ -d examples ]; then \
		for script in examples/*.sh; do \
			echo "$(YELLOW)Running $$script...$(RESET)"; \
			bash "$$script"; \
		done; \
	else \
		echo "$(RED)No examples directory found$(RESET)"; \
	fi

# Development setup targets
setup: ## Set up development environment
	@echo "$(BLUE)Setting up development environment...$(RESET)"
	@command -v pre-commit >/dev/null 2>&1 || { \
		echo "$(YELLOW)Installing pre-commit...$(RESET)"; \
		pip install pre-commit; \
	}
	@echo "$(BLUE)Installing pre-commit hooks...$(RESET)"
	pre-commit install
	@echo "$(GREEN)Development environment ready!$(RESET)"

pre-commit: ## Run pre-commit hooks manually
	@echo "$(BLUE)Running pre-commit hooks...$(RESET)"
	pre-commit run --all-files

# CI targets (for local verification)
ci-check: fmt-check lint test ## Run all CI checks locally
	@echo "$(GREEN)All CI checks passed!$(RESET)"

ci-build: ## Build for CI (all targets)
	@echo "$(BLUE)Building all targets for CI...$(RESET)"
	$(CARGO) build --all-targets
	$(CARGO) build --all-targets --release

# Utility targets
clean: ## Clean build artifacts
	@echo "$(BLUE)Cleaning build artifacts...$(RESET)"
	$(CARGO) clean
	rm -rf completions/

update: ## Update dependencies
	@echo "$(BLUE)Updating dependencies...$(RESET)"
	$(CARGO) update

audit: ## Run security audit
	@echo "$(BLUE)Running security audit...$(RESET)"
	$(CARGO) audit

# Version management
version: ## Show current version
	@echo "$(BOLD)Current version: $(GREEN)$(VERSION)$(RESET)"

bump-patch: ## Bump patch version (x.y.Z)
	@echo "$(BLUE)Bumping patch version...$(RESET)"
	@current=$$(grep '^version =' Cargo.toml | head -1 | cut -d '"' -f 2); \
	new=$$(echo $$current | awk -F. '{print $$1"."$$2"."$$3+1}'); \
	sed -i.bak "s/^version = \"$$current\"/version = \"$$new\"/" Cargo.toml; \
	rm Cargo.toml.bak; \
	echo "$(GREEN)Version bumped from $$current to $$new$(RESET)"

bump-minor: ## Bump minor version (x.Y.z)
	@echo "$(BLUE)Bumping minor version...$(RESET)"
	@current=$$(grep '^version =' Cargo.toml | head -1 | cut -d '"' -f 2); \
	new=$$(echo $$current | awk -F. '{print $$1"."$$2+1".0"}'); \
	sed -i.bak "s/^version = \"$$current\"/version = \"$$new\"/" Cargo.toml; \
	rm Cargo.toml.bak; \
	echo "$(GREEN)Version bumped from $$current to $$new$(RESET)"

bump-major: ## Bump major version (X.y.z)
	@echo "$(BLUE)Bumping major version...$(RESET)"
	@current=$$(grep '^version =' Cargo.toml | head -1 | cut -d '"' -f 2); \
	new=$$(echo $$current | awk -F. '{print $$1+1".0.0"}'); \
	sed -i.bak "s/^version = \"$$current\"/version = \"$$new\"/" Cargo.toml; \
	rm Cargo.toml.bak; \
	echo "$(GREEN)Version bumped from $$current to $$new$(RESET)"

# Release workflow
release-workflow: ci-check release-dry ## Run complete release checks
	@echo "$(GREEN)Release workflow complete. Ready to publish!$(RESET)"
	@echo "$(YELLOW)Run 'make release' to publish to crates.io$(RESET)"

# Quick targets for common tasks
all: clean build test lint ## Clean, build, test, and lint
dev: build test ## Quick development build and test
ready: ci-check build-release ## Verify project is ready for release