@@ -139,16 +139,42 @@ If you installed via PyPI, you can use t-linter from the command line:
139139t-linter lsp
140140```
141141
142- ** Check individual files** :
142+ ** Check files for issues ** (🚧 Coming soon) :
143143``` bash
144+ # Check Python files for template string issues
144145t-linter check file.py
146+ t-linter check src/
147+
148+ # Output formats (when implemented)
149+ t-linter check file.py --format json
150+ t-linter check file.py --format github # GitHub Actions annotations
151+ t-linter check file.py --error-on-issues # Exit with error code if issues found
145152```
146153
147- ** Get statistics** about template strings in a file :
154+ ** Get template string statistics** (🚧 Coming soon) :
148155``` bash
149- t-linter stats file.py
156+ # Analyze template string usage in your codebase
157+ t-linter stats . # Current directory
158+ t-linter stats src/ # Specific directory
159+
160+ # Expected output (when implemented):
161+ # - Number of template strings by language
162+ # - Template string locations
163+ # - Language detection methods used
164+ # - Type alias usage statistics
150165```
151166
167+ ## Roadmap
168+
169+ ### Planned Features
170+ - ✅ ** Language Server Protocol (LSP)** - Fully implemented
171+ - ✅ ** Syntax Highlighting** - Supports HTML, SQL, JavaScript, CSS, JSON
172+ - ✅ ** Type Alias Support** - Recognizes ` type html = Annotated[Template, "html"] `
173+ - 🚧 ** Linting (` check ` command)** - Validate template strings for syntax errors
174+ - 🚧 ** Statistics (` stats ` command)** - Analyze template string usage across codebases
175+ - 📋 ** Cross-file Type Resolution** - Track type aliases across module boundaries
176+ - 📋 ** Auto-completion** - Context-aware completions within template strings
177+
152178## Quick Start Example
153179
154180Here's how to use template strings with automatic syntax highlighting:
0 commit comments