thailint 0.1.0__tar.gz

thailint-0.1.0/CHANGELOG.md

@@ -0,0 +1,337 @@
+# Changelog
+
+**Purpose**: Version history and release notes for all thailint package versions
+
+**Scope**: All public releases, API changes, features, bug fixes, and breaking changes
+
+**Overview**: Maintains comprehensive version history following Keep a Changelog format. Documents
+    all notable changes in each release including new features, bug fixes, breaking changes,
+    deprecations, and security updates. Organized by version with release dates. Supports
+    automated changelog extraction for GitHub releases and user upgrade planning.
+
+**Dependencies**: Semantic versioning (semver.org), Keep a Changelog format (keepachangelog.com)
+
+**Exports**: Release history, upgrade guides, breaking change documentation
+
+**Related**: pyproject.toml (version configuration), GitHub releases, docs/releasing.md
+
+**Implementation**: Keep a Changelog 1.1.0 format with semantic versioning and organized change categories
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2025-10-07
+
+**Nesting Depth Linter Release** - Adds comprehensive nesting depth analysis for Python and TypeScript code. Includes AST-based analysis with tree-sitter, configurable depth limits, and extensive refactoring patterns. Validated on the thai-lint codebase (zero violations after refactoring 23 functions).
+
+### Added
+
+- **Nesting Depth Linter** - Complete nesting depth analysis for Python and TypeScript
+  - AST-based depth calculation using Python `ast` module and `tree-sitter-typescript`
+  - Configurable `max_nesting_depth` (default: 4, thai-lint uses: 3)
+  - Detects excessive nesting in if/for/while/with/try/match (Python) and if/for/while/try/switch (TypeScript)
+  - Helpful violation messages with refactoring suggestions
+  - Depth calculation starts at 1 for function body (matches industry standards)
+
+- **CLI Command: `thai-lint nesting`**
+  - `thai-lint nesting [PATH]` - Check files for excessive nesting
+  - `--max-depth N` - Override configured max depth
+  - `--config PATH` - Use specific config file
+  - `--format json/text` - Output format selection
+  - `--help` - Comprehensive command documentation
+
+- **Library API**
+  - `nesting_lint(path, max_nesting_depth=4)` - Convenience function
+  - `NestingDepthRule` - Direct rule class for advanced usage
+  - `from src import nesting_lint, NestingDepthRule` - Exported in package
+
+- **Comprehensive Documentation**
+  - `docs/nesting-linter.md` - 400+ line comprehensive guide
+  - Configuration examples and best practices
+  - 5 refactoring patterns with before/after code examples
+  - Case study results and time estimates
+  - CI/CD integration examples (GitHub Actions, pre-commit hooks)
+  - Troubleshooting guide and common issues
+
+- **Example Code**
+  - `examples/nesting_usage.py` - Library API usage example
+  - Configuration templates in docs
+
+- **Test Suite**
+  - 76 tests for nesting linter (100% passing)
+  - Python nesting tests (15 tests)
+  - TypeScript nesting tests (15 tests)
+  - Configuration tests (8 tests)
+  - Integration tests (12 tests)
+  - Edge case tests (8 tests)
+  - Total project tests: 317 (100% passing, up from 221)
+
+- **Refactoring Patterns Documentation**
+  - Guard clauses (early returns) - Used in 7 functions
+  - Extract method pattern - Used in 13 functions
+  - Dispatch pattern (replace if-elif chains) - Used in 5 functions
+  - Flatten error handling - Used in 6 functions
+  - Invert conditions - Pattern documented
+
+### Changed
+
+- **Code Quality Improvements via Dogfooding**
+  - Refactored 23 functions with excessive nesting (18 in src/, 5 in tests/examples)
+  - Reduced max nesting depth from 4 to 3 project-wide
+  - All functions now comply with strict depth limit
+  - Improved readability and maintainability across codebase
+  - Zero nesting violations in production code
+
+- **Test Coverage**
+  - Increased from 87% to 90% overall coverage
+  - Added 96 new tests (221 → 317)
+  - 100% coverage on nesting analyzer modules
+
+- **README Updates**
+  - Added comprehensive nesting linter section with examples
+  - Updated feature list with nesting capabilities
+  - Added refactoring patterns and real-world results
+  - Updated test badges (317/317 passing, 90% coverage)
+
+- **Dependencies**
+  - Added `tree-sitter ^0.25.2` for AST parsing
+  - Added `tree-sitter-typescript ^0.23.2` for TypeScript support
+  - Pure Python solution (no Node.js required)
+
+### Fixed
+
+- Ignore directive parser now supports TypeScript comments (`//` and `/* */`)
+- Block ignore directives (`thailint: ignore-start` / `ignore-end`) working correctly
+- Rule matching supports prefix patterns (e.g., "nesting" matches "nesting.excessive-depth")
+
+### Performance
+
+- Single file analysis: ~10-30ms (well under 100ms target)
+- 100 files: ~500ms (under 2s target)
+- 1000 files: ~2-3s (under 10s target)
+- AST parsing optimized with caching
+
+### Documentation
+
+- Complete nesting linter guide (`docs/nesting-linter.md`)
+- Updated CLI reference with nesting command
+- Configuration examples for nesting rules
+- 5 refactoring patterns with code examples
+- Codebase refactoring case study
+
+### Validation: Codebase Refactoring
+
+**Baseline Assessment:**
+- 23 violations (depth 4, max configured: 3)
+- Files: src/cli.py (6), src/config.py (5), orchestrator (3), others (9)
+
+**Refactoring Applied:**
+- Time: ~4 hours for 23 functions (~10 min/function average)
+- Patterns: Extract method (13), Guard clauses (7), Dispatch (5), Flatten (6)
+- Tests: 317/317 passing (100%)
+- Quality: Pylint 10.00/10, all complexity A-grade
+
+**Results:**
+- Zero nesting violations
+- Improved code readability
+- No functionality broken
+- All integration tests passing
+
+### Infrastructure
+
+- Updated Makefile with `make lint-nesting` target
+- Integrated nesting checks into `make lint-full`
+- CI/CD ready (proper exit codes and JSON output)
+
+## [0.1.0] - 2025-10-06
+
+**Initial Alpha Release**
+
+### Breaking Changes
+
+**Configuration Format Update**: Multi-Linter Top-Level Sections
+
+The configuration format has been restructured to support multiple linters with separate top-level sections. This prepares the project for future linters while maintaining a clean separation of concerns.
+
+**Old Format** (v0.1.0 and earlier):
+```yaml
+# .thailint.yaml
+directories:
+  src/:
+    allow:
+      - "^src/.*\\.py$"
+global_patterns:
+  deny:
+    - pattern: ".*\\.tmp$"
+      reason: "No temp files"
+```
+
+**New Format** (v0.2.0+):
+```yaml
+# .thailint.yaml
+file-placement:
+  directories:
+    src/:
+      allow:
+        - "^src/.*\\.py$"
+  global_patterns:
+    deny:
+      - pattern: ".*\\.tmp$"
+        reason: "No temp files"
+```
+
+**Migration Steps**:
+1. Wrap your entire file-placement configuration under a `file-placement:` top-level key
+2. Use hyphens (`file-placement`) not underscores (`file_placement`)
+3. Indent all existing configuration one level
+4. Update any `.thailint.json` files similarly
+
+**Rationale**: This change allows multiple linters to coexist cleanly. Future linters like `code-quality:` and `security:` will have their own top-level sections, following the pattern of tools like `pyproject.toml`.
+
+### Added
+- Example configuration files (`.thailint.yaml.example`, `.thailint.json.example`)
+- Documentation for multi-linter configuration format
+
+### Changed
+- Configuration schema now uses top-level linter sections
+- File placement linter looks for config under `file-placement` key (hyphen, not underscore)
+
+### Deprecated
+- Old flat configuration format (still works in v0.1.x but will be removed in v1.0.0)
+
+## [0.1.0] - 2025-10-06
+
+**Initial Alpha Release** - This release represents early development status. Core features are functional but the API and configuration formats may change in future releases. Suitable for testing and evaluation.
+
+### Added
+- **Core Framework**: Pluggable linter architecture with base interfaces and rule registry
+  - `BaseLintRule` and `BaseLintContext` abstractions
+  - Automatic plugin discovery via `RuleRegistry`
+  - Binary severity model (ERROR only)
+  - Violation dataclass with file, line, rule_id, message, severity
+
+- **Configuration System**: Multi-format config loading with 5-level ignore system
+  - YAML and JSON config file support
+  - 5-level ignore directives (repo, directory, file, method, line)
+  - Wildcard rule matching for flexible ignore patterns
+  - Config validation and error reporting
+
+- **Multi-Language Orchestrator**: File routing and language detection engine
+  - Extension-based language detection with shebang fallback
+  - Per-language linter routing and execution
+  - Context creation and violation aggregation
+  - Recursive directory scanning
+
+- **File Placement Linter**: Complete file organization linter
+  - Pattern-based allow/deny rules with regex support
+  - Directory scoping for targeted enforcement
+  - Configurable via YAML/JSON with validation
+  - Helpful violation suggestions based on file type
+  - 81% test coverage, 42/50 tests passing
+
+- **CLI Interface**: Professional command-line interface
+  - `thailint lint file-placement [PATH]` command
+  - Inline JSON rules via `--rules` flag
+  - External config via `--config` flag
+  - Text and JSON output formats (`--format`)
+  - Recursive and non-recursive scanning modes
+  - Proper exit codes (0=pass, 1=violations, 2=error)
+
+- **Library API**: High-level programmatic interface
+  - `Linter` class with config_file and project_root parameters
+  - `lint(path, rules=[...])` method for filtered linting
+  - Autodiscovery of config files in project root
+  - Direct linter imports for backwards compatibility
+  - Usage examples (basic, advanced, CI integration)
+
+- **Docker Support**: Production-ready containerization
+  - Multi-stage Dockerfile with optimized layers
+  - Non-root user execution (UID 1000)
+  - Volume mounting at `/workspace`
+  - 270MB image size (Python 3.11-slim)
+  - docker-compose.yml for development workflows
+
+- **PyPI Distribution**: Complete packaging and publishing setup
+  - PyPI-ready package metadata with classifiers
+  - GitHub Actions workflow for automated publishing
+  - PyPI Trusted Publishing (OIDC) configuration
+  - Automated GitHub releases with changelog extraction
+  - MANIFEST.in for clean source distributions
+
+- **Comprehensive Testing**: TDD-driven test suite
+  - 181+ unit and integration tests
+  - 87% overall test coverage
+  - pytest with coverage reporting
+  - Docker integration tests
+
+- **Development Tooling**: Complete quality assurance stack
+  - Ruff (linting and formatting)
+  - MyPy (strict type checking)
+  - Pylint (comprehensive linting)
+  - Bandit (security scanning)
+  - Xenon (complexity analysis)
+  - Pre-commit hooks for quality gates
+
+### Changed
+- Package name: `thai-lint` → `thailint` (PyPI-friendly)
+- CLI command: `thai-lint` → `thailint` (both supported for compatibility)
+
+### Documentation
+- Comprehensive README with installation and usage guides
+- API examples for library usage
+- Docker usage documentation
+- Release process documentation (docs/releasing.md)
+- AI agent guides (.ai/ directory)
+
+### Infrastructure
+- GitHub Actions CI/CD pipelines (test, lint, security)
+- Pre-commit hooks for automated quality checks
+- Poetry-based dependency management
+- Docker multi-stage builds
+
+## [0.0.1] - Initial Development
+
+### Added
+- Basic project structure
+- Poetry configuration
+- Initial CLI scaffold
+
+---
+
+## Version History
+
+- **0.1.0** (2025-10-06): Initial alpha release with core feature set
+- **0.0.1**: Initial development version
+
+## Upgrade Guide
+
+### Using Version 0.1.0 (Alpha Release)
+
+This is an early alpha release for testing and feedback. Key notes:
+
+1. **CLI Command**: Use `thailint` instead of `thai-lint` (both work)
+2. **Package Name**: Install as `pip install thailint`
+3. **Library Import**: Use `from thailint import Linter`
+
+## Contributing
+
+When adding entries to this changelog:
+
+1. Add changes to `[Unreleased]` section during development
+2. Move to versioned section when releasing
+3. Use categories: Added, Changed, Deprecated, Removed, Fixed, Security
+4. Include user-facing changes only (not internal refactors)
+5. Link to issues/PRs when relevant
+6. Follow Keep a Changelog format
+
+## Links
+
+- [PyPI Package](https://pypi.org/project/thailint/)
+- [GitHub Repository](https://github.com/steve-e-jackson/thai-lint)
+- [Issue Tracker](https://github.com/steve-e-jackson/thai-lint/issues)
+- [Keep a Changelog](https://keepachangelog.com/)
+- [Semantic Versioning](https://semver.org/)

thailint-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Steve Jackson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.