Function run_platformio_lint

ci/lint_platformio/run_all_checkers.py:116–164

Run the PlatformIO-internal-usage checker. Args: warn_only: If True, always return True (warn mode). If False, return False when violations exist (error mode). If None, consult ``FASTLED_LINT_PLATFORMIO_ERROR`` (defaults to warn). Returns: True if cl

(warn_only: bool | None = None)

def run_platformio_lint(warn_only: bool | None = None) -> bool:
    """Run the PlatformIO-internal-usage checker.

    Args:
        warn_only: If True, always return True (warn mode). If False,
            return False when violations exist (error mode). If None,
            consult ``FASTLED_LINT_PLATFORMIO_ERROR`` (defaults to warn).

    Returns:
        True if clean OR warn-only mode is active.
    """
    if warn_only is None:
        warn_only = os.environ.get("FASTLED_LINT_PLATFORMIO_ERROR", "") != "1"

    files = _collect_files(PROJECT_ROOT)
    if not files:
        return True

    checkers: list[FileContentChecker] = [NoInternalPlatformIOChecker()]
    processor = MultiCheckerFileProcessor()
    processor.process_files_with_checkers(files, checkers)

    violations = _collect_violations(checkers)
    if not violations:
        print("✅ PlatformIO-internal-usage check: no violations")
        return True

    total = sum(len(v) for v in violations.values())
    mode_label = "WARN" if warn_only else "ERROR"
    print(f"\n{'=' * 80}")
    print(
        f"[PlatformIO-internal-usage] {mode_label} mode — "
        f"found {total} violation(s) in {len(violations)} file(s):"
    )
    print("=" * 80)
    _print_violations(violations)
    print(f"\n{'=' * 80}")

    if warn_only:
        print(
            f"⚠️  PlatformIO-internal-usage: {total} violation(s) (warn-only — "
            f"not failing CI). See issue #2701."
        )
        print("=" * 80)
        return True

    print(f"❌ PlatformIO-internal-usage: {total} violation(s) (gating).")
    print("=" * 80)
    return False


def main() -> int: