---

Peck is a powerful CLI tool designed to identify wording or spelling mistakes in your codebase. Built for speed, simplicity, and seamless integration, Peck fits naturally into your workflow, much like tools such as Pint or Pest.

Leveraging the robust capabilities of GNU Aspell via the github.com/tigitz/php-spellchecker PHP wrapper, Peck inspects every corner of your codebase — including folder names, file names, method names, comments, and beyond — ensuring your work maintains a high standard of clarity and professionalism.

Note: Peck is still under active development and is not yet ready for production use. Currently, only the filesystem checker is implemented, focusing exclusively on detecting spelling mistakes in file and folder names.

Installation

Requires PHP 8.3+

You can require Peck using Composer with the following command:

composer require peckphp/peck

Usage

To check your project for spelling mistakes, run:

./vendor/bin/peck

Configuration

Peck can be configured using a peck.json file in the root of your project. Here's an example configuration:

{
    "ignore": {
        "words": [
            "config",
            "namespace"
        ],
        "directories": [
            "app/MyNamespace"
        ]
    }
}

You can also specify the path to the configuration file using the --config option:

./vendor/bin/peck --config relative/path/to/peck.json

---

Peck is an open-sourced software licensed under the MIT license.

---

Command Options

The behaviour of peck can be modified with the following options:

--path

The path to check can be overwritten with the --path option. If the path is one you always need checking you can place it in your peck.json file.