Download the PHP package tysonandre/phantypocheck without Composer
On this page you can find all versions of the php package tysonandre/phantypocheck. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tysonandre/phantypocheck
More information about tysonandre/phantypocheck
Files in tysonandre/phantypocheck
Package phantypocheck
Short Description A plugin for Phan that checks for typos (using codespell's dictionary).
License GPL-3.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package phantypocheck
PhanTypoCheck
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
After it is installed, add the relative path to TypoCheckPlugin.php to the plugins section of .phan/config.php, e.g.
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).
codespellalso has issues analyzing the start/end of single quoted strings.
Options
Options can be passed in your .phan/config.php.
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/>.