thailint 0.2.0__py3-none-any.whl → 0.15.3__py3-none-any.whl

src/templates/thailint_config_template.yaml

@@ -0,0 +1,354 @@
+# thai-lint Configuration File
+# Generated by: thailint init-config
+#
+# For non-interactive mode (AI agents): thailint init-config --non-interactive
+#
+# Full documentation: https://github.com/your-org/thai-lint
+
+# ============================================================================
+# MAGIC NUMBERS LINTER
+# ============================================================================
+# Detects unnamed numeric literals that should be extracted as constants
+#
+# Preset: {{PRESET}}
+#
+magic-numbers:
+  enabled: true
+
+  # Numbers that are acceptable without being named constants
+  # Default: [-1, 0, 1, 2, 3, 4, 5, 10, 100, 1000]
+  allowed_numbers: {{ALLOWED_NUMBERS}}
+
+  # Maximum integer allowed in range() or enumerate() without flagging
+  # Default: 10
+  max_small_integer: {{MAX_SMALL_INTEGER}}
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: Uncomment to add time conversions (lenient mode)
+  # -------------------------------------------------------------------------
+  # allowed_numbers: [-1, 0, 1, 2, 3, 4, 5, 10, 60, 100, 1000, 3600]
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: Uncomment to add common HTTP status codes
+  # -------------------------------------------------------------------------
+  # allowed_numbers: [-1, 0, 1, 2, 3, 4, 5, 10, 100, 200, 201, 204, 400, 401, 403, 404, 500, 502, 503, 1000]
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: Uncomment to add decimal proportions (0.0-1.0)
+  # -------------------------------------------------------------------------
+  # allowed_numbers: [-1, 0, 1, 2, 3, 4, 5, 10, 100, 1000, 0.0, 0.1, 0.2, 0.25, 0.3, 0.4, 0.5, 0.6, 0.7, 0.75, 0.8, 0.9, 1.0]
+
+# ============================================================================
+# NESTING LINTER
+# ============================================================================
+# Checks for excessive nesting depth (if/for/while/try statements)
+#
+nesting:
+  enabled: true
+
+  # Maximum nesting depth allowed
+  # Default: 4
+  max_nesting_depth: 4
+
+# ============================================================================
+# SINGLE RESPONSIBILITY PRINCIPLE (SRP) LINTER
+# ============================================================================
+# Detects classes that may have too many responsibilities
+#
+srp:
+  enabled: true
+
+  # Maximum methods per class
+  # Default: 7
+  max_methods: 7
+
+  # Maximum lines of code per class
+  # Default: 200
+  max_loc: 200
+
+# ============================================================================
+# DRY (DON'T REPEAT YOURSELF) LINTER
+# ============================================================================
+# Detects duplicate code blocks
+#
+dry:
+  enabled: true
+
+  # Minimum lines for a block to be considered duplicate
+  # Default: 6
+  min_duplicate_lines: 6
+
+  # Enable SQLite caching for faster incremental scans
+  # Default: true
+  cache_enabled: true
+
+  # Cache file location (relative to project root)
+  # Default: .thailint-cache/dry.db
+  cache_path: .thailint-cache/dry.db
+
+# ============================================================================
+# FILE PLACEMENT LINTER
+# ============================================================================
+# Ensures files are in appropriate directories
+#
+file-placement:
+  enabled: true
+
+  # Rules for file placement
+  rules:
+    # Test files should be in tests/ directory
+    - pattern: "test_*.py"
+      required_dir: "tests/"
+      message: "Test files must be in tests/ directory"
+
+    # Config files should be in config/ or root
+    - pattern: "*config*.py"
+      required_dir: ["config/", "./"]
+      message: "Config files should be in config/ or project root"
+
+# ============================================================================
+# PRINT STATEMENTS LINTER
+# ============================================================================
+# Detects print()/console.* statements that should use proper logging
+#
+print-statements:
+  enabled: true
+
+  # Allow print() in if __name__ == "__main__": blocks (Python only)
+  # Default: true
+  allow_in_scripts: true
+
+  # Console methods to detect in TypeScript/JavaScript
+  # Default: [log, warn, error, debug, info]
+  console_methods:
+    - log
+    - warn
+    - error
+    - debug
+    - info
+
+  # File patterns to ignore (glob syntax)
+  # ignore:
+  #   - "scripts/**"
+  #   - "**/debug.py"
+
+# ============================================================================
+# STRINGLY-TYPED LINTER
+# ============================================================================
+# Detects "stringly typed" code patterns where strings are used instead of
+# proper enums - e.g., if env == "production": ... repeated across files
+#
+stringly-typed:
+  enabled: true
+
+  # Minimum occurrences across files to flag a violation
+  # Default: 2
+  min_occurrences: 2
+
+  # Minimum unique string values to suggest creating an enum
+  # Default: 2
+  min_values_for_enum: 2
+
+  # Maximum unique string values to suggest an enum (above this, probably not enum-worthy)
+  # Default: 6
+  max_values_for_enum: 6
+
+  # Whether to require cross-file occurrences to flag violations
+  # Default: true
+  require_cross_file: true
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: String value sets that are acceptable (won't be flagged)
+  # -------------------------------------------------------------------------
+  # allowed_string_sets:
+  #   - ["debug", "info", "warning", "error"]  # Log levels
+  #   - ["ASC", "DESC"]                         # Sort directions
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: Variable names to exclude from analysis
+  # -------------------------------------------------------------------------
+  # exclude_variables:
+  #   - log_level
+  #   - severity
+
+# ============================================================================
+# FILE HEADER LINTER
+# ============================================================================
+# Validates that files have proper documentation headers
+#
+file-header:
+  enabled: true
+
+  # Enforce atemporal language (no "currently", "now", dates)
+  # Default: true
+  enforce_atemporal: true
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: Override required fields by language
+  # -------------------------------------------------------------------------
+  # required_fields:
+  #   python: [Purpose, Scope, Overview, Dependencies, Exports, Interfaces, Implementation]
+  #   typescript: [Purpose, Scope, Overview, Dependencies, Exports, Props/Interfaces, State/Behavior]
+  #   bash: [Purpose, Scope, Overview, Dependencies, Exports, Usage, Environment]
+  #   markdown: [purpose, scope, overview, audience, status]
+  #   css: [Purpose, Scope, Overview, Dependencies, Exports, Interfaces, Environment]
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: File patterns to ignore
+  # -------------------------------------------------------------------------
+  # ignore:
+  #   - "test/**"
+  #   - "**/migrations/**"
+  #   - "**/__init__.py"
+
+# ============================================================================
+# METHOD PROPERTY LINTER
+# ============================================================================
+# Detects methods that should be @property (no args, simple return)
+#
+method-property:
+  enabled: true
+
+  # Maximum statements in method body to suggest @property
+  # Default: 3
+  max_body_statements: 3
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: Methods to ignore (exact names)
+  # -------------------------------------------------------------------------
+  # ignore_methods:
+  #   - "__str__"
+  #   - "__repr__"
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: Additional action verb prefixes to exclude
+  # -------------------------------------------------------------------------
+  # exclude_prefixes:
+  #   - "fetch_"
+  #   - "load_"
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: File patterns to ignore
+  # -------------------------------------------------------------------------
+  # ignore:
+  #   - "tests/**"
+
+# ============================================================================
+# STATELESS CLASS LINTER
+# ============================================================================
+# Detects classes with no instance state (should be modules or functions)
+#
+stateless-class:
+  enabled: true
+
+  # Minimum methods to flag a stateless class
+  # Default: 2
+  min_methods: 2
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: File patterns to ignore
+  # -------------------------------------------------------------------------
+  # ignore:
+  #   - "tests/**"
+
+# ============================================================================
+# COLLECTION PIPELINE LINTER
+# ============================================================================
+# Detects "embedded loop filtering" anti-pattern (if/continue in loops)
+# Suggests using filter(), list comprehensions, or generator expressions
+#
+pipeline:
+  enabled: true
+
+  # Minimum if/continue patterns in a loop to flag
+  # Default: 1
+  min_continues: 1
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: File patterns to ignore
+  # -------------------------------------------------------------------------
+  # ignore:
+  #   - "tests/**"
+
+# ============================================================================
+# LAZY IGNORES LINTER
+# ============================================================================
+# Detects unjustified linting suppressions (noqa, type: ignore, etc.)
+# without proper documentation in file headers
+#
+lazy-ignores:
+  enabled: true
+
+  # Pattern-specific toggles
+  check_noqa: true
+  check_type_ignore: true
+  check_pylint_disable: true
+  check_nosec: true
+  check_ts_ignore: true
+  check_eslint_disable: true
+  check_thailint_ignore: true
+  check_test_skips: true
+
+  # Check for orphaned suppressions (documented but not used)
+  check_orphaned: true
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: File patterns to ignore
+  # -------------------------------------------------------------------------
+  # ignore_patterns:
+  #   - "tests/**"
+
+# ============================================================================
+# PERFORMANCE LINTER
+# ============================================================================
+# Detects performance anti-patterns in loops that cause O(n²) behavior
+#
+performance:
+  enabled: true
+
+  # String concatenation in loops (O(n²) pattern)
+  # Detects: result += str in for/while loops
+  # Suggests: Use "".join() or list append + join
+  string-concat-loop:
+    enabled: true
+    # Report each += separately, or one violation per loop
+    # Default: false (one per loop)
+    report_each_concat: false
+
+  # Regex compilation in loops
+  # Detects: re.match(), re.search(), re.sub() etc. in loops
+  # Suggests: Use re.compile() outside loop
+  regex-in-loop:
+    enabled: true
+
+  # -------------------------------------------------------------------------
+  # OPTIONAL: File patterns to ignore
+  # -------------------------------------------------------------------------
+  # ignore:
+  #   - "tests/**"
+  #   - "scripts/**"
+
+# ============================================================================
+# GLOBAL SETTINGS
+# ============================================================================
+#
+# Exclude patterns (files/directories to ignore)
+exclude:
+  - ".git/"
+  - ".venv/"
+  - "venv/"
+  - "node_modules/"
+  - "__pycache__/"
+  - "*.pyc"
+  - ".pytest_cache/"
+  - "dist/"
+  - "build/"
+  - ".eggs/"
+
+# Output format (text or json)
+# Default: text
+output_format: text
+
+# Exit with error code if violations found
+# Default: true
+fail_on_violations: true

src/utils/project_root.py

@@ -4,29 +4,55 @@ Purpose: Centralized project root detection for consistent file placement
 Scope: Single source of truth for finding project root directory
 
 Overview: Uses pyprojroot package to provide reliable project root detection across
-    different environments (development, CI/CD, user installations). Delegates all
-    project root detection logic to the industry-standard pyprojroot library which
-    handles various project markers and edge cases that we cannot anticipate.
+    different environments (development, CI/CD, user installations). Falls back to
+    manual detection if pyprojroot is not available (e.g., in test environments).
+    Searches for standard project markers like .git, .thailint.yaml, and pyproject.toml.
 
-Dependencies: pyprojroot for robust project root detection
+Dependencies: pyprojroot (optional, with manual fallback)
 
 Exports: is_project_root(), get_project_root()
 
 Interfaces: Path-based functions for checking and finding project roots
 
-Implementation: Pure delegation to pyprojroot with fallback to start_path when no root found
+Implementation: pyprojroot delegation with manual fallback for test environments
+
+Suppressions:
+    - type:ignore[arg-type]: pyprojroot external library typing issue with Path conversion
 """
 
 from pathlib import Path
 
-from pyprojroot import find_root
+# Try to import pyprojroot, but don't fail if it's not available
+try:
+    from pyprojroot import find_root
+
+    HAS_PYPROJROOT = True
+except ImportError:
+    HAS_PYPROJROOT = False
+
+
+def _has_marker(path: Path, marker_name: str, is_dir: bool = False) -> bool:
+    """Check if a directory contains a specific marker.
+
+    Args:
+        path: Directory path to check
+        marker_name: Name of marker file or directory
+        is_dir: True if marker is a directory, False if it's a file
+
+    Returns:
+        True if marker exists, False otherwise
+    """
+    marker_path = path / marker_name
+    if is_dir:
+        return marker_path.is_dir()
+    return marker_path.is_file()
 
 
 def is_project_root(path: Path) -> bool:
     """Check if a directory is a project root.
 
-    Uses pyprojroot to detect if the given path is a project root by checking
-    if finding the root from this path returns the same path.
+    Uses pyprojroot if available, otherwise checks for common project markers
+    like .git, .thailint.yaml, or pyproject.toml.
 
     Args:
         path: Directory path to check
@@ -43,6 +69,21 @@ def is_project_root(path: Path) -> bool:
     if not path.exists() or not path.is_dir():
         return False
 
+    if HAS_PYPROJROOT:
+        return _check_root_with_pyprojroot(path)
+
+    return _check_root_with_markers(path)
+
+
+def _check_root_with_pyprojroot(path: Path) -> bool:
+    """Check if path is project root using pyprojroot.
+
+    Args:
+        path: Directory path to check
+
+    Returns:
+        True if path is a project root, False otherwise
+    """
     try:
         # Find root from this path - if it equals this path, it's a root
         found_root = find_root(path)
@@ -52,14 +93,74 @@ def is_project_root(path: Path) -> bool:
         return False
 
 
+def _check_root_with_markers(path: Path) -> bool:
+    """Check if path contains project root markers.
+
+    Args:
+        path: Directory path to check
+
+    Returns:
+        True if path contains .git, .thailint.yaml, or pyproject.toml
+    """
+    return (
+        _has_marker(path, ".git", is_dir=True)
+        or _has_marker(path, ".thailint.yaml", is_dir=False)
+        or _has_marker(path, "pyproject.toml", is_dir=False)
+    )
+
+
+def _try_find_with_criterion(criterion: object, start_path: Path) -> Path | None:
+    """Try to find project root with a specific criterion.
+
+    Args:
+        criterion: pyprojroot criterion function (e.g., has_dir(".git"))
+        start_path: Path to start searching from
+
+    Returns:
+        Found project root or None if not found
+    """
+    try:
+        return find_root(criterion, start=start_path)  # type: ignore[arg-type]
+    except (OSError, RuntimeError):
+        return None
+
+
+def _find_root_manual(start_path: Path) -> Path:
+    """Manually find project root by walking up directory tree.
+
+    Fallback implementation when pyprojroot is not available.
+
+    Args:
+        start_path: Directory to start searching from
+
+    Returns:
+        Path to project root, or start_path if no markers found
+    """
+    current = start_path.resolve()
+
+    # Walk up the directory tree
+    for parent in [current] + list(current.parents):
+        # Check for project markers
+        if (
+            _has_marker(parent, ".git", is_dir=True)
+            or _has_marker(parent, ".thailint.yaml", is_dir=False)
+            or _has_marker(parent, "pyproject.toml", is_dir=False)
+        ):
+            return parent
+
+    # No markers found, return start path
+    return current
+
+
 def get_project_root(start_path: Path | None = None) -> Path:
     """Find project root by walking up the directory tree.
 
     This is the single source of truth for project root detection.
     All code that needs to find the project root should use this function.
 
-    Uses pyprojroot which searches for standard project markers defined by the
-    pyprojroot library (git repos, Python projects, etc).
+    Uses pyprojroot if available, otherwise uses manual detection searching for
+    standard project markers (.git directory, pyproject.toml, .thailint.yaml, etc)
+    starting from start_path and walking upward.
 
     Args:
         start_path: Directory to start searching from. If None, uses current working directory.
@@ -76,9 +177,30 @@ def get_project_root(start_path: Path | None = None) -> Path:
 
     current = start_path.resolve()
 
-    try:
-        # Use pyprojroot to find the project root
-        return find_root(current)
-    except (OSError, RuntimeError):
-        # No project markers found, return the start path
-        return current
+    if HAS_PYPROJROOT:
+        return _find_root_with_pyprojroot(current)
+
+    # Manual fallback for test environments
+    return _find_root_manual(current)
+
+
+def _find_root_with_pyprojroot(current: Path) -> Path:
+    """Find project root using pyprojroot library.
+
+    Args:
+        current: Current path to start searching from
+
+    Returns:
+        Path to project root, or current if no markers found
+    """
+    from pyprojroot import has_dir, has_file
+
+    # Search for project root markers in priority order
+    # Try .git first (most reliable), then .thailint.yaml, then pyproject.toml
+    for criterion in [has_dir(".git"), has_file(".thailint.yaml"), has_file("pyproject.toml")]:
+        root = _try_find_with_criterion(criterion, current)
+        if root is not None:
+            return root
+
+    # No markers found, return start path
+    return current