thailint 0.1.0__py3-none-any.whl

thailint-0.1.0.dist-info/METADATA

@@ -0,0 +1,601 @@
+Metadata-Version: 2.3
+Name: thailint
+Version: 0.1.0
+Summary: The AI Linter - Enterprise-grade linting and governance for AI-generated code across multiple languages
+License: MIT
+Keywords: linter,ai,code-quality,static-analysis,file-placement,governance,multi-language,cli,docker,python
+Author: Steve Jackson
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Dist: click (>=8.1.0,<9.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: tree-sitter (>=0.25.2,<0.26.0)
+Requires-Dist: tree-sitter-typescript (>=0.23.2,<0.24.0)
+Project-URL: Documentation, https://github.com/be-wise-be-kind/thai-lint#readme
+Project-URL: Homepage, https://github.com/be-wise-be-kind/thai-lint
+Project-URL: Repository, https://github.com/be-wise-be-kind/thai-lint
+Description-Content-Type: text/markdown
+
+# thai-lint
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![Tests](https://img.shields.io/badge/tests-317%2F317%20passing-brightgreen.svg)](tests/)
+[![Coverage](https://img.shields.io/badge/coverage-90%25-brightgreen.svg)](htmlcov/)
+
+The AI Linter - Enterprise-ready linting and governance for AI-generated code across multiple languages.
+
+## Overview
+
+thailint is a modern, enterprise-ready multi-language linter designed specifically for AI-generated code. It enforces project structure, file placement rules, and coding standards across Python, TypeScript, and other languages.
+
+## ✨ Features
+
+### Core Capabilities
+- 🎯 **File Placement Linting** - Enforce project structure and organization
+- 🔄 **Nesting Depth Linting** - Detect excessive code nesting with AST analysis
+  - Python and TypeScript support with tree-sitter
+  - Configurable max depth (default: 4, recommended: 3)
+  - Helpful refactoring suggestions (guard clauses, extract method)
+- 🔌 **Pluggable Architecture** - Easy to extend with custom linters
+- 🌍 **Multi-Language Support** - Python, TypeScript, JavaScript, and more
+- ⚙️ **Flexible Configuration** - YAML/JSON configs with pattern matching
+- 🚫 **5-Level Ignore System** - Repo, directory, file, method, and line-level ignores
+
+### Deployment Modes
+- 💻 **CLI Mode** - Full-featured command-line interface
+- 📚 **Library API** - Python library for programmatic integration
+- 🐳 **Docker Support** - Containerized deployment for CI/CD
+
+### Enterprise Features
+- 📊 **Performance** - <100ms for single files, <5s for 1000 files
+- 🔒 **Type Safety** - Full type hints and MyPy strict mode
+- 🧪 **Test Coverage** - 90% coverage with 317 tests
+- 📈 **CI/CD Ready** - Proper exit codes and JSON output
+- 📝 **Comprehensive Docs** - Complete documentation and examples
+
+## Installation
+
+### From Source
+
+```bash
+# Clone repository
+git clone https://github.com/be-wise-be-kind/thai-lint.git
+cd thai-lint
+
+# Install dependencies
+pip install -e ".[dev]"
+```
+
+### From PyPI (once published)
+
+```bash
+pip install thai-lint
+```
+
+### With Docker
+
+```bash
+# Build image
+docker-compose -f docker-compose.cli.yml build
+
+# Run CLI
+docker-compose -f docker-compose.cli.yml run cli --help
+```
+
+## Quick Start
+
+### CLI Mode
+
+```bash
+# Check file placement
+thai-lint file-placement .
+
+# Check nesting depth
+thai-lint nesting src/
+
+# With config file
+thai-lint nesting --config .thailint.yaml src/
+
+# JSON output for CI/CD
+thai-lint nesting --format json src/
+```
+
+### Library Mode
+
+```python
+from src import Linter
+
+# Initialize linter
+linter = Linter(config_file='.thailint.yaml')
+
+# Lint directory
+violations = linter.lint('src/', rules=['file-placement'])
+
+# Process results
+if violations:
+    for v in violations:
+        print(f"{v.file_path}: {v.message}")
+```
+
+### Docker Mode
+
+```bash
+# Run with volume mount
+docker run --rm -v $(pwd):/workspace \
+  thailint/thailint file-placement /workspace
+
+# With docker-compose
+docker-compose run cli file-placement .
+```
+
+## Configuration
+
+Create `.thailint.yaml` in your project root:
+
+```yaml
+# File placement linter configuration
+file-placement:
+  # Global patterns apply to entire project
+  global_patterns:
+    deny:
+      - pattern: "^(?!src/|tests/).*\\.py$"
+        message: "Python files must be in src/ or tests/"
+
+  # Directory-specific rules
+  directories:
+    src:
+      allow:
+        - ".*\\.py$"
+      deny:
+        - "test_.*\\.py$"
+
+    tests:
+      allow:
+        - "test_.*\\.py$"
+        - "conftest\\.py$"
+
+  # Files/directories to ignore
+  ignore:
+    - "__pycache__/"
+    - "*.pyc"
+    - ".venv/"
+```
+
+**JSON format also supported** (`.thailint.json`):
+
+```json
+{
+  "file-placement": {
+    "directories": {
+      "src": {
+        "allow": [".*\\.py$"],
+        "deny": ["test_.*\\.py$"]
+      }
+    },
+    "ignore": ["__pycache__/", "*.pyc"]
+  }
+}
+```
+
+See [Configuration Guide](docs/configuration.md) for complete reference.
+
+## Nesting Depth Linter
+
+### Overview
+
+The nesting depth linter detects deeply nested code (if/for/while/try statements) that reduces readability and maintainability. It uses AST analysis to accurately calculate nesting depth.
+
+### Quick Start
+
+```bash
+# Check nesting depth in current directory
+thai-lint nesting .
+
+# Use strict limit (max depth 3)
+thai-lint nesting --max-depth 3 src/
+
+# Get JSON output
+thai-lint nesting --format json src/
+```
+
+### Configuration
+
+Add to `.thailint.yaml`:
+
+```yaml
+nesting:
+  enabled: true
+  max_nesting_depth: 3  # Default: 4, recommended: 3
+```
+
+### Example Violation
+
+**Code with excessive nesting:**
+```python
+def process_data(items):
+    for item in items:              # Depth 2
+        if item.is_valid():         # Depth 3
+            try:                    # Depth 4 ← VIOLATION (max=3)
+                if item.process():
+                    return True
+            except Exception:
+                pass
+    return False
+```
+
+**Refactored with guard clauses:**
+```python
+def process_data(items):
+    for item in items:              # Depth 2
+        if not item.is_valid():
+            continue
+        try:                        # Depth 3 ✓
+            if item.process():
+                return True
+        except Exception:
+            pass
+    return False
+```
+
+### Refactoring Patterns
+
+Common patterns to reduce nesting (used to fix 23 violations in thai-lint):
+
+1. **Guard Clauses (Early Returns)**
+   - Replace `if x: do_something()` with `if not x: return`
+   - Exit early, reduce nesting
+
+2. **Extract Method**
+   - Move nested logic to separate functions
+   - Improves readability and testability
+
+3. **Dispatch Pattern**
+   - Replace if-elif-else chains with dictionary dispatch
+   - More extensible and cleaner
+
+4. **Flatten Error Handling**
+   - Combine multiple try-except blocks
+   - Use tuple of exception types
+
+### Language Support
+
+- ✅ **Python**: Full support (if/for/while/with/try/match)
+- ✅ **TypeScript**: Full support (if/for/while/try/switch)
+- ✅ **JavaScript**: Supported via TypeScript parser
+
+### Refactoring Case Study
+
+The thai-lint codebase serves as a validation of the nesting linter:
+- Identified: 23 functions requiring refactoring (depth 4 → depth ≤3)
+- Refactored using documented patterns
+- Time estimate: ~10 minutes per function
+- Result: Zero violations, improved readability
+
+See [Nesting Linter Guide](docs/nesting-linter.md) for comprehensive documentation and refactoring patterns.
+
+## Pre-commit Hooks
+
+Automate code quality checks before every commit and push with pre-commit hooks.
+
+### Quick Setup
+
+```bash
+# 1. Install pre-commit framework
+pip install pre-commit
+
+# 2. Install git hooks
+pre-commit install
+pre-commit install --hook-type pre-push
+
+# 3. Test it works
+pre-commit run --all-files
+```
+
+### What You Get
+
+**On every commit:**
+- 🚫 Prevents commits to main/master branch
+- 🎨 Auto-fixes formatting issues
+- ✅ Runs thai-lint on changed files (fast)
+
+**On every push:**
+- 🔍 Full linting on entire codebase
+- 🧪 Runs complete test suite
+
+### Example Configuration
+
+```yaml
+# .pre-commit-config.yaml
+repos:
+  - repo: local
+    hooks:
+      # Prevent commits to protected branches
+      - id: no-commit-to-main
+        name: Prevent commits to main branch
+        entry: bash -c 'branch=$(git rev-parse --abbrev-ref HEAD); if [ "$branch" = "main" ]; then echo "❌ Use a feature branch!"; exit 1; fi'
+        language: system
+        pass_filenames: false
+        always_run: true
+
+      # Auto-format code
+      - id: format
+        name: Auto-fix formatting
+        entry: make format
+        language: system
+        pass_filenames: false
+
+      # Run thai-lint on changed files
+      - id: lint-changed
+        name: Lint changed files
+        entry: make lint-full FILES=changed
+        language: system
+        pass_filenames: false
+```
+
+See **[Pre-commit Hooks Guide](docs/pre-commit-hooks.md)** for complete documentation, troubleshooting, and advanced configuration.
+
+## Common Use Cases
+
+### CI/CD Integration
+
+```yaml
+# GitHub Actions example
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install thailint
+        run: pip install thailint
+      - name: Run file placement linter
+        run: thailint file-placement .
+      - name: Run nesting linter
+        run: thailint nesting src/ --config .thailint.yaml
+```
+
+### Editor Integration
+
+```python
+# VS Code extension example
+from src import Linter
+
+linter = Linter(config_file='.thailint.yaml')
+violations = linter.lint(file_path)
+```
+
+### Test Suite
+
+```python
+# pytest integration
+import pytest
+from src import Linter
+
+def test_no_violations():
+    linter = Linter()
+    violations = linter.lint('src/')
+    assert len(violations) == 0
+```
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Install pre-commit hooks (if using)
+pre-commit install
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=src --cov-report=html
+
+# Run specific test
+pytest tests/test_cli.py::test_hello_command
+```
+
+### Code Quality
+
+```bash
+# Lint code
+ruff check src tests
+
+# Format code
+ruff format src tests
+
+# Type checking
+mypy src/
+```
+
+### Building
+
+```bash
+# Build Python package
+python -m build
+
+# Build Docker image
+docker-compose -f docker-compose.cli.yml build
+```
+
+## Docker Usage
+
+```bash
+# Build image
+docker-compose -f docker-compose.cli.yml build
+
+# Run CLI help
+docker-compose -f docker-compose.cli.yml run cli --help
+
+# Run hello command
+docker-compose -f docker-compose.cli.yml run cli hello --name Docker
+
+# With config volume
+docker-compose -f docker-compose.cli.yml run \
+    -v $(pwd)/config:/config:ro \
+    cli --config /config/config.yaml hello
+```
+
+## Documentation
+
+### Comprehensive Guides
+
+- 📖 **[Getting Started](docs/getting-started.md)** - Installation, first lint, basic config
+- ⚙️ **[Configuration Reference](docs/configuration.md)** - Complete config options (YAML/JSON)
+- 📚 **[API Reference](docs/api-reference.md)** - Library API documentation
+- 💻 **[CLI Reference](docs/cli-reference.md)** - All CLI commands and options
+- 🚀 **[Deployment Modes](docs/deployment-modes.md)** - CLI, Library, and Docker usage
+- 📁 **[File Placement Linter](docs/file-placement-linter.md)** - Detailed linter guide
+- 🔄 **[Nesting Depth Linter](docs/nesting-linter.md)** - Nesting depth analysis guide
+- 🪝 **[Pre-commit Hooks](docs/pre-commit-hooks.md)** - Automated quality checks
+- 📦 **[Publishing Guide](docs/releasing.md)** - Release and publishing workflow
+- ✅ **[Publishing Checklist](docs/publishing-checklist.md)** - Post-publication validation
+
+### Examples
+
+See [`examples/`](examples/) directory for working code:
+
+- **[basic_usage.py](examples/basic_usage.py)** - Simple library API usage
+- **[advanced_usage.py](examples/advanced_usage.py)** - Advanced patterns and workflows
+- **[ci_integration.py](examples/ci_integration.py)** - CI/CD integration example
+
+## Project Structure
+
+```
+thai-lint/
+├── src/                      # Application source code
+│   ├── api.py               # High-level Library API
+│   ├── cli.py               # CLI commands
+│   ├── core/                # Core abstractions
+│   │   ├── base.py         # Base linter interfaces
+│   │   ├── registry.py     # Rule registry
+│   │   └── types.py        # Core types (Violation, Severity)
+│   ├── linters/             # Linter implementations
+│   │   └── file_placement/ # File placement linter
+│   ├── linter_config/       # Configuration system
+│   │   ├── loader.py       # Config loader (YAML/JSON)
+│   │   └── ignore.py       # Ignore directives
+│   └── orchestrator/        # Multi-language orchestrator
+│       ├── core.py         # Main orchestrator
+│       └── language_detector.py
+├── tests/                   # Test suite (221 tests, 87% coverage)
+│   ├── unit/               # Unit tests
+│   ├── integration/        # Integration tests
+│   └── conftest.py         # Pytest fixtures
+├── docs/                    # Documentation
+│   ├── getting-started.md
+│   ├── configuration.md
+│   ├── api-reference.md
+│   ├── cli-reference.md
+│   ├── deployment-modes.md
+│   └── file-placement-linter.md
+├── examples/                # Working examples
+│   ├── basic_usage.py
+│   ├── advanced_usage.py
+│   └── ci_integration.py
+├── .ai/                     # AI agent documentation
+├── Dockerfile               # Multi-stage Docker build
+├── docker-compose.yml       # Docker orchestration
+└── pyproject.toml           # Project configuration
+```
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Run tests and linting
+5. Commit your changes (`git commit -m 'Add amazing feature'`)
+6. Push to the branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
+### Development Guidelines
+
+- Write tests for new features
+- Follow existing code style (enforced by Ruff)
+- Add type hints to all functions
+- Update documentation for user-facing changes
+- Run `pytest` and `ruff check` before committing
+
+## Performance
+
+thailint is designed for speed and efficiency:
+
+| Operation | Performance | Target |
+|-----------|-------------|--------|
+| Single file lint | ~20ms | <100ms ✅ |
+| 100 files | ~300ms | <1s ✅ |
+| 1000 files | ~900ms | <5s ✅ |
+| Config loading | ~10ms | <100ms ✅ |
+
+*Performance benchmarks run on standard hardware, your results may vary.*
+
+## Exit Codes
+
+thailint uses standard exit codes for CI/CD integration:
+
+- **0** - Success (no violations)
+- **1** - Violations found
+- **2** - Error occurred (invalid config, file not found, etc.)
+
+```bash
+thai-lint file-placement .
+if [ $? -eq 0 ]; then
+    echo "✅ Linting passed"
+else
+    echo "❌ Linting failed"
+fi
+```
+
+## Architecture
+
+See [`.ai/docs/`](.ai/docs/) for detailed architecture documentation and [`.ai/howtos/`](.ai/howtos/) for development guides.
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+- **Issues**: https://github.com/be-wise-be-kind/thai-lint/issues
+- **Documentation**: `.ai/docs/` and `.ai/howtos/`
+
+## Acknowledgments
+
+Built with:
+- [Click](https://click.palletsprojects.com/) - CLI framework
+- [pytest](https://pytest.org/) - Testing framework
+- [Ruff](https://docs.astral.sh/ruff/) - Linting and formatting
+- [Docker](https://www.docker.com/) - Containerization
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.
+

thailint-0.1.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+src/.ai/layout.yaml,sha256=yF79hvJOQDCm8Y75OpMfJzVr0ORR4n4MpokIh3Ff84w,953
+src/__init__.py,sha256=E0i84M6mA2-YIK8SN3zcQ2mw1gG-EXbRvl0Z3WE0cIg,1746
+src/api.py,sha256=C-Co8fjY8ewT0O5IttAX045Fhr34MuXz_YL0wT5Q0x4,4644
+src/cli.py,sha256=s11vSyouEY4Jqu6bx7QyP-jvIefpTOso-JpkpiK7Bhk,20409
+src/config.py,sha256=ANDs6EF3IQbwHyNEVWXbpnNQMEe9wDqP3Bm2w_4zTU8,13139
+src/core/__init__.py,sha256=5FtsDvhMt4SNRx3pbcGURrxn135XRbeRrjSUxiXwkNc,381
+src/core/base.py,sha256=x_3swLyVwaIjPgtCNisEFEuMR2caFAuV20izok5afN0,4323
+src/core/registry.py,sha256=wjrxmyVyh0qW9q5ZOTDfCwVStcE_hFlVv8s4eUiJ3P4,6208
+src/core/types.py,sha256=dIYLaCDNtCAzVaplx5S5yxywkLIuX0BN9No_l2zCfV0,2887
+src/linter_config/__init__.py,sha256=_I2VVlZlfKyT-tKukuUA5-aVcHLOe3m6C2cev43AiEc,298
+src/linter_config/ignore.py,sha256=Ffjq6zpjh15FrcoGxt09goXn67QmZb8E_stT4VQ4wls,16239
+src/linter_config/loader.py,sha256=o3-ezigI9K3o4w478eR6l0fLVVLBQ_t11WwpOvePUvA,2879
+src/linters/__init__.py,sha256=-nnNsL8E5-2p9qlLKp_TaShHAjPH-NacOEU1sXmAR9k,77
+src/linters/file_placement/__init__.py,sha256=vJ43GZujcbAk-K3DwfsQZ0J3yP_5G35CKssatLyntXk,862
+src/linters/file_placement/linter.py,sha256=xUD7Kb0aJNSj1Vc-sqTGTXUU5_cXxJcvkm1-OeKFHxk,21973
+src/linters/nesting/__init__.py,sha256=zBxZJPhxTO91ezWwXJ72wyxUS7i8t6lehjlJFJKRYvA,3134
+src/linters/nesting/config.py,sha256=SC-TbKvC_llhkU-_9sC7ya1K7fkH1nLf-1HUzbHXcs8,1755
+src/linters/nesting/linter.py,sha256=h5lVuWgXqanwjg6F9AuWkEdRqYDYWosXGyTZP0qfb7c,9529
+src/linters/nesting/python_analyzer.py,sha256=DF2lVnxYstakOpP_Zizox583Ypkb4eUpgQYEpu6x8gk,3078
+src/linters/nesting/typescript_analyzer.py,sha256=rec4N0NccB9mQ2452g2hcz521-kHxSr5uItjCt1DlLs,6870
+src/orchestrator/__init__.py,sha256=XXLDJq2oaB-TpP2Y97GRnde9EkITGuFCmuLrDfxI9nY,245
+src/orchestrator/core.py,sha256=6LqaDcSBlH-hJmTpPRDTMo-tHTzEwVRQg4sZ0wyKdE0,7092
+src/orchestrator/language_detector.py,sha256=rHyVMApit80NTTNyDH1ObD1usKD8LjGmH3DwqNAWYGc,2736
+thailint-0.1.0.dist-info/LICENSE,sha256=kxh1J0Sb62XvhNJ6MZsVNe8PqNVJ7LHRn_EWa-T3djw,1070
+thailint-0.1.0.dist-info/METADATA,sha256=HUZ-YiivxAiQIKbi1zBYY08Ljq6WhDC8T5raQDFGLoU,16485
+thailint-0.1.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+thailint-0.1.0.dist-info/entry_points.txt,sha256=l7DQJgU18sVLDpSaXOXY3lLhnQHQIRrSJZTQjG1cEAk,62
+thailint-0.1.0.dist-info/RECORD,,

thailint-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.1.3
+Root-Is-Purelib: true
+Tag: py3-none-any

thailint-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+thai-lint=src.cli:cli
+thailint=src.cli:cli
+