README

Hit is a powerful CLI tool designed to identify wording or spelling mistakes in your codebase. Built for speed, simplicity, and seamless integration.

Leveraging the robust capabilities of github.com/tigitz/php-spellchecker

Note: Hit 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.

Prerequisites

To use Hit, you need to have Aspell installed on your system. Aspell is a spelling checker tool that Hit uses to detect spelling errors.

Installing Aspell

On Ubuntu or Debian-based distributions, you can install Aspell using the following commands:

sudo apt-get install aspell aspell-pt

If you need the English dictionary, use the command below:

sudo apt-get install -y aspell aspell-en

Installation

Requires PHP 8.3+

You can require Hit using Composer with the following command:

composer require hbg-php/hit

Usage

To check your project for spelling mistakes, run:

./vendor/bin/hit

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