tysonandre/phantypocheck

A plugin for Phan that checks for typos (using codespell's dictionary).

1.1.2 2020-03-27 02:18 UTC

README

Build Status Latest Stable Version License

This Phan plugin checks for typos in PHP files, with low false positives.

It checks all string literals, inline html, and doc comments (on by default). It also checks variables, element names, and element usages (using heuristics to guess individual words of camelCase or snake_case identifiers).

This also emits warnings if strings with typos are passed to calls to gettext(), _(), and ngettext().

Installing

This can be installed with composer

composer require --dev tysonandre/phantypocheck

After it is installed, add the relative path to TypoCheckPlugin.php to the plugins section of .phan/config.php, e.g.

    'plugins' => [
       // other plugins,
       'vendor/tysonandre/phantypocheck/src/TypoCheckPlugin.php',
    ],

This can also be manually downloaded (the current version doesn't have external dependencies).

Running (standalone)

This can be run as vendor/bin/phptypocheck path/to/file.php path/to/folder.

When passed a folder name, this will check for .php files within that folder, recursively.

Details

The typo checks use dictionary.txt from https://github.com/codespell-project/codespell/

  • It might be easier to just use codespell, depending on the use case.

    However, that would not tell you what type of identifier the string occurred in (and allow filtering by that).

    codespell also has issues analyzing the start/end of single quoted strings.

Options

Options can be passed in your .phan/config.php.

    'plugin_config' => [
        // can provide a path to a file with a list of typos to not warn about (case insensitive)
        // See tests/phantypocheck_ignore.txt for an example file.
        'typo_check_ignore_words_file' => 'phantypocheck_ignore.txt'

        // can be added to Phan configuration to make this skip checking comments, strings, and inline HTML for typos.
        // (will *only* check uses of gettext()/_()/ngettext())
        'typo_check_comments_and_strings' => false,
    ],

License

dictionary.txt is a derived work of English Wikipedia and is released under the Creative Commons Attribution-Share-Alike License 3.0 http://creativecommons.org/licenses/by-sa/3.0/ (according to https://github.com/codespell-project/codespell#license)

PhanTypoCheck is available under the GPL v3 License (see LICENSE)

PhanTypoCheck is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

PhanTypoCheck is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with PhanTypoCheck.  If not, see <https://www.gnu.org/licenses/>.