Tlint Laravel Package

Product Decisions This Supports

• Enforce Laravel Coding Standards: Adopt a standardized, opinionated linting tool to ensure consistency across the codebase, reducing onboarding friction and improving maintainability.
• Developer Experience (DX) Improvements: Automate code quality checks to catch common Laravel anti-patterns (e.g., dd() usage, facade imports, route path formatting) early in the development cycle.
• Build vs. Buy Decision: Replace manual code reviews or ad-hoc linting with a dedicated, Laravel-specific tool, reducing reliance on generic PHP linters (e.g., PHP_CodeSniffer) or custom scripts.
• Scaling Code Quality: Integrate into CI/CD pipelines to enforce conventions automatically, reducing technical debt and improving collaboration in distributed teams.
• Roadmap for Laravel Modernization: Align with Laravel’s evolving best practices (e.g., anonymous migrations, fully qualified facades, Blade directive spacing) to future-proof the codebase.
• Onboarding Acceleration: Standardize code structure (e.g., class visibility ordering, request validation) to help new developers contribute faster by adhering to a predictable pattern.

When to Consider This Package

• Adopt if:

  • Your team uses Laravel 8+ and wants to enforce consistent coding conventions without reinventing the wheel.
  • You prioritize developer productivity and want to automate checks for Laravel-specific anti-patterns (e.g., dump() calls, facade usage, route formatting).
  • You’re scaling a mid-to-large Laravel codebase and need to reduce cognitive load for new contributors.
  • Your CI/CD pipeline lacks automated Laravel-specific linting and relies on manual reviews or generic tools.
  • You’re migrating to Laravel 11+ and want to adopt modern conventions (e.g., anonymous migrations, fully qualified facades).

• Look elsewhere if:

  • Your project uses PHP 7.3 or lower (TLint dropped support in v7.0.0).
  • You need deep static analysis (e.g., type safety, security vulnerabilities) beyond Laravel conventions—consider Psalm or PHPStan.
  • Your team prefers custom linting rules over opinionated presets (e.g., Tighten’s default rules may conflict with your style).
  • You’re using non-Laravel PHP frameworks (e.g., Symfony, Lumen) and need framework-agnostic linting.
  • Your project is small or experimental and lacks resources to integrate linting into workflows.

How to Pitch It (Stakeholders)

For Executives:

*"TLint is a Laravel-specific linting tool that automates code quality checks to save time and reduce errors. By enforcing best practices—like eliminating dd() calls, standardizing facade imports, and formatting Blade directives—we can:

• Cut debugging time by catching issues early in development.
• Improve onboarding with consistent code patterns, reducing ramp-up time for new hires.
• Future-proof our codebase by aligning with Laravel’s latest conventions (e.g., anonymous migrations, PHP 8.3+ support). Integration into our CI pipeline is lightweight and adds minimal overhead, while delivering measurable improvements in code consistency and maintainability."*

For Engineering Teams:

*"TLint is a Laravel-native linter that replaces manual code reviews for common anti-patterns. Key benefits:

• Out-of-the-box Laravel rules: Catches dump()/dd() usage, enforces fully qualified facades, validates route paths, and more—no configuration needed to start.
• Seamless CI integration: Runs in seconds, fails builds on violations, and integrates with GitHub Actions/GitLab CI.
• Developer-friendly: Fixes are often one-line changes (e.g., adding use statements, reformatting Blade directives).
• Extensible: Customize rules via tlint.json or add new linters for team-specific needs. Example: Before TLint, we spent hours reviewing PRs for dd() calls or inconsistent facade imports. Now, TLint catches these automatically, freeing us to focus on higher-value work."*

For Developers:

*"TLint is like a rubber duck for your code—it points out Laravel-specific issues before they become bugs. Here’s what it fixes:

• Debugging: Flags dd(), dump(), and @ray directives in production-like environments.
• Facades: Ensures you’re using fully qualified imports (e.g., use Illuminate\Support\Facades\Log;).
• Blade: Standardizes spacing around @if, @foreach, and directives.
• Migrations: Encourages anonymous migrations (Laravel 8.37+).
• Routes: Removes leading slashes from route paths (e.g., /users instead of /users/). Best part? It integrates with your IDE (via CLI) and CI, so you’ll see errors before you commit. Try running ./vendor/bin/tlint—it’s faster than manual reviews!"*