Download the PHP package khalyomede/php-typo without Composer
On this page you can find all versions of the php package khalyomede/php-typo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download khalyomede/php-typo
More information about khalyomede/php-typo
Files in khalyomede/php-typo
Package php-typo
Short Description A command line tool to validate files do not have English typo in variables, methods, functions, ...
License MIT
Informations about the package php-typo
php-typo/php-typo
A command line tool to validate files do not have English typo in variables, methods, functions, ...
Summary
- About
- Installation
- Examples
- Tests
About
I searched for a tool to correct english typos across a code base, but only ended up finding VSCode plugins. I know there is PHPStorm plugins as well (and probably similar tools on others code editors), but I need a single, unique way to correct my english typos so that other contributors to my code base will also have the same results, and do not need to install anything on their editor.
English words list based on dwyl/english-words.
Features
- Validates your code do not have typos in
- class names and their properties, methods and their parameters
- interfaces names
- enum names and their cases
- variables names
- function names and their parameters
- constants and class constants
- Shipped with a list of known english words for fast quick start
- Dead simple way to ignore/whitelist additional words
Installation
On your root folder, on the terminal type this command:
This will create a file php-typo.json
at the root of your folder with the following content:
Examples
- 1. Run your first check
- 2. Add more words/whitelist words
1. Run your first check
In this example, we will just run the command, which by default will search on the files you specified in your "php-typo.json" config file.
We will assume we have the following file content in "src/index.php":
Run the command:
2. Add more words/whitelist words
In this example, we will use an additional list of English words to extend the base list of words shipped with this package. This is equivalent to "ignoring" some words.
In the config file at "php-typo.json", add your custom JSON word list:
The list of words should be an array of strings. Here is what you could have in your file "custom.json":
On the next check, the words "greting" and "php" will be counted as correct words.
Tests
Or
All versions of php-typo with dependencies
nikic/php-parser Version 4.17.1
symfony/console Version 6.3.8
aminnairi/string-extra Version 0.1.0