Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voku/phpdoctor
🏥 PHPDoctor: Check files, full directories or strings for missing or bad PHPDoc types.
https://github.com/voku/phpdoctor
hacktoberfest php phpdoc static-analysis types
Last synced: 3 months ago
JSON representation
🏥 PHPDoctor: Check files, full directories or strings for missing or bad PHPDoc types.
- Host: GitHub
- URL: https://github.com/voku/phpdoctor
- Owner: voku
- License: apache-2.0
- Created: 2020-08-31T20:48:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T10:21:24.000Z (almost 1 year ago)
- Last Synced: 2024-10-29T22:50:09.469Z (3 months ago)
- Topics: hacktoberfest, php, phpdoc, static-analysis, types
- Language: PHP
- Homepage:
- Size: 76.2 KB
- Stars: 53
- Watchers: 3
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/voku/PHPDoctor)
[](https://www.codacy.com/manual/voku/PHPDoctor?utm_source=github.com&utm_medium=referral&utm_content=voku/PHPDoctor&utm_campaign=Badge_Grade)
[](https://packagist.org/packages/voku/PHPDoctor)
[](https://packagist.org/packages/voku/PHPDoctor)
[](https://www.paypal.me/moelleken)
[](https://www.patreon.com/voku)
# 🏥 ***PHPDoc***tor
Check PHP files or directories for missing types.
If you already use [PHPStan](https://phpstan.org/r/db8ec6af-8815-444e-b533-2717ccb643c6) for your type checks but sometimes someone
in the team still commit non typed code, then PHPDoctor is for you.
### Install via "phar" (**recommended**)
https://github.com/voku/PHPDoctor/releases
### Install via "composer require"
```shell
composer require-dev voku/phpdoctor
```
### Quick Start
```
Usage:
analyse [options] [--]
Arguments:
path The path to analyse
Options:
--autoload-file[=AUTOLOAD-FILE] The path to your autoloader. [default: ""]
--access[=ACCESS] Check for "public|protected|private" methods. [default: "public|protected|private"]
--skip-ambiguous-types-as-error[=SKIP-AMBIGUOUS-TYPES-AS-ERROR] Skip check for ambiguous types. (false or true) [default: "false"]
--skip-deprecated-functions[=SKIP-DEPRECATED-FUNCTIONS] Skip check for deprecated functions / methods. (false or true) [default: "false"]
--skip-functions-with-leading-underscore[=SKIP-FUNCTIONS-WITH-LEADING-UNDERSCORE] Skip check for functions / methods with leading underscore. (false or true) [default: "false"]
--skip-parse-errors[=SKIP-PARSE-ERRORS] Skip parse errors in the output. (false or true) [default: "true"]
--path-exclude-regex[=PATH-EXCLUDE-REGEX] Skip some paths via regex e.g. "#/vendor/|/other/.*/path/#i" [default: "#/vendor/|/tests/#i"]
```
### Demo
Parse a string:
```php
$code = '
format(\'j. n. Y\');
}
}';
$phpdocErrors = PhpCodeChecker::checkFromString($code);
// [8]: missing parameter type for HelloWorld->sayHello() | parameter:date']
```
### Ignore errors
You can use `````` in @param or @return phpdocs to ignore the errors directly in your code.
```php
/**
* @param mixed $lall
this is mixed but it is ok, because ...
*
* @return array
*/
function foo_ignore($lall) {
return $lall;
}
```
### Building the PHAR file
Prepare: https://github.com/phar-io/phive
```bash
phive install humbug/box
php tools/box compile --debug
```
### Support
For support and donations please visit [Github](https://github.com/voku/simple_html_dom/) | [Issues](https://github.com/voku/simple_html_dom/issues) | [PayPal](https://paypal.me/moelleken) | [Patreon](https://www.patreon.com/voku).
For status updates and release announcements please visit [Releases](https://github.com/voku/simple_html_dom/releases) | [Twitter](https://twitter.com/suckup_de) | [Patreon](https://www.patreon.com/voku/posts).
For professional support please contact [me](https://about.me/voku).
### Thanks
- Thanks to [GitHub](https://github.com) (Microsoft) for hosting the code and a good infrastructure including Issues-Managment, etc.
- Thanks to [IntelliJ](https://www.jetbrains.com) as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!
- Thanks to [Travis CI](https://travis-ci.com/) for being the most awesome, easiest continous integration tool out there!
- Thanks to [StyleCI](https://styleci.io/) for the simple but powerfull code style check.
- Thanks to [PHPStan](https://github.com/phpstan/phpstan) && [Psalm](https://github.com/vimeo/psalm) for really great Static analysis tools and for discover bugs in the code!