Peck Laravel Package

Product Decisions This Supports

• Code Quality & Developer Experience: Automates spelling/grammar checks in PHP codebases (filenames, class/method names, docblocks, strings), reducing manual review and improving consistency. Aligns with initiatives to enforce "clean code" standards.
• Customer-Facing Text Accuracy: Proactively catches typos in error messages, UI copy, or documentation, directly improving user trust and reducing support overhead. Critical for public-facing Laravel applications.
• CI/CD Pipeline Enrichment: Low-effort integration into existing workflows (e.g., GitHub Actions, GitLab CI) as a pre-commit or pre-merge check, with minimal maintenance.
• Internationalization (i18n) & Accessibility: Supports multilingual projects by validating spelling across languages (via GNU Aspell dictionaries), ensuring error-free translations and inclusive terminology.
• Build vs. Buy Decision: Eliminates the need for custom tooling by providing a free, MIT-licensed solution with Laravel presets, reducing development time and licensing costs.
• Onboarding & Documentation: Ideal for teams adopting Laravel, as it addresses common pain points (e.g., inconsistent naming conventions, typos in tutorials) without requiring deep technical expertise.

When to Consider This Package

Adopt Peck when:

• Your Laravel/PHP codebase contains human-readable text (e.g., string literals, docblocks, Markdown, YAML configs, or error messages) that requires spelling/grammar validation.
• You lack automated checks for developer-facing terminology (e.g., class names, method names, or framework-specific terms like eloquent, blade, or laravel).
• Your team prioritizes proactive quality control in CI/CD pipelines, especially for open-source or public-facing projects where typos reflect poorly on the brand.
• You need a lightweight, CLI-first tool that integrates with existing workflows (e.g., Composer scripts, Git hooks) without IDE dependencies.

Look elsewhere if:

• Your primary need is advanced grammar analysis (e.g., syntax, sentence structure) beyond basic spelling (consider tools like LanguageTool).
• Your project is non-PHP or has minimal textual content (e.g., binary files, data-driven APIs).
• You require GUI/IDE integrations (e.g., VS Code extensions like Code Spell Checker).
• Your target language lacks GNU Aspell dictionary support (e.g., non-Latin scripts, niche dialects).
• You need production-ready stability—Peck is actively developed but not yet "ready for production" (as noted in the README).
• Your team prefers self-hosted solutions over open-source dependencies (e.g., for air-gapped environments).

How to Pitch It (Stakeholders)

To Executives/Stakeholders: "Peck is a zero-cost, zero-maintenance tool that catches spelling errors in our codebase—like typos in error messages, documentation, or class names—before they reach customers. This protects our brand reputation, reduces support tickets, and ensures professionalism in every line of code. Since it integrates seamlessly into our CI pipeline, it’s a no-brainer addition that pays for itself by preventing small but costly mistakes. And because it’s open-source, we avoid licensing fees entirely."

Key Messaging:

• Risk Reduction: "One typo in an error message can cost us customer trust—and Peck catches these automatically."
• Efficiency: "No more manual reviews of docblocks or commit messages—Peck does it in seconds during our CI checks."
• Scalability: "As we grow, Peck ensures consistency across teams and languages, whether we’re adding new features or translating content."
• Cost: "Free to use, MIT-licensed, and maintained by the community—no vendor lock-in or hidden costs."

To Engineering Teams: *"Peck is like Pint for spelling—it’s a fast, CLI-based tool that scans your codebase for typos in strings, comments, and even filenames. With Laravel presets and GNU Aspell under the hood, it’s tailored for PHP projects and integrates effortlessly into your workflow. Run it in CI, add it to pre-commit hooks, or use it locally to catch errors early. It’s especially useful for:

• Developer-facing text: Class/method names, docblocks, or framework-specific terms.
• User-facing text: Error messages, UI copy, or documentation.
• Internationalization: Supports multiple languages via Aspell dictionaries.

Just install it (composer require peckphp/peck), configure a few ignores for false positives, and let it run in the background. It’s lightweight, fast, and saves us time on manual reviews."*

Key Messaging:

• Integration: "Works with Composer, Git hooks, and CI—just add it to your composer.json scripts."
• Customization: "Ignore false positives (e.g., laravel, eloquent) via peck.json or inline comments."
• Performance: "Runs in seconds and plays well with other tools like Pest or Pint."
• Future-Proof: "Supports PHP 8.2+ and Laravel’s ecosystem out of the box."