Skip to content

Commit ad8749e

Browse files
corpseecorpsee
committed
Fork PHP Docblock Checker to PHPDoc Checker.
1 parent 73febd5 commit ad8749e

12 files changed

+125
-748
lines changed

‎.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
1-
.DS_Store
2-
.idea
31
vendor
4-
phpdoccheck.phar
2+
phpdoc-checker.phar

‎LICENSE.md renamed to ‎LICENSE

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Copyright (c) 2018, PHP Censor
2+
All rights reserved.
3+
14
Copyright (c) 2014, Block 8 Limited
25
All rights reserved.
36

@@ -6,4 +9,4 @@ Redistribution and use in source and binary forms, with or without modification,
69
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
710
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
811

9-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
12+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
# PHP DocBlock Checker
2-
Check PHP files within a directory for appropriate use of Docblocks.
1+
# PHPDoc Checker
2+
3+
Check PHP files within a directory for appropriate use of PHPDocs (Docblocks). PHPDoc Checker is fork of
4+
[PHP DocBlock Checker](https://github.com/Block8/php-docblock-checker).
35

46
## Installation
57
**Composer**:<br>
6-
<code>
7-
composer require block8/php-docblock-checker
8-
</code>
8+
9+
```bash
10+
composer require php-censor/phpdoc-checker
11+
```
912

1013
## Usage
1114
**CMD**:<br>
12-
<code>
13-
call vendor/bin/phpdoccheck {params}
14-
</code>
15+
16+
```bash
17+
vendor/bin/phpdoccheck {params}
18+
```
1519

1620
## Parameters
1721

@@ -32,4 +36,5 @@ none | --skip-signatures | Don't check docblocks against method signatures.
3236
none | --ansi | Force ANSI output.
3337
none | --no-ansi | Disable ANSI output.
3438
-n | --no-interaction | Do not ask any interactive question.
35-
-v -vv -vvv | --verbose | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
39+
-v -vv -vvv | --verbose | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3
40+
for debug.

‎bin/phpdoc-checker

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#!/usr/bin/env php
2+
3+
<?php
4+
/**
5+
* PHP Docblock Checker
6+
*
7+
* @copyright Copyright 2014, Block 8 Limited.
8+
* @license https://github.com/Block8/php-docblock-checker/blob/master/LICENSE.md
9+
* @link http://www.phptesting.org/
10+
*/
11+
12+
$ownVendorAutoloader = dirname(__DIR__) . '/vendor/autoload.php';
13+
$parentVendorAutoloader = dirname(__DIR__) . '/../../autoload.php';
14+
15+
if (file_exists($ownVendorAutoloader)) {
16+
require_once($ownVendorAutoloader);
17+
} elseif (file_exists($parentVendorAutoloader)) {
18+
require_once($parentVendorAutoloader);
19+
}
20+
21+
$command = new PhpDocChecker\CheckerCommand();
22+
23+
$application = new PhpDocChecker\CheckerApplication('PHP Docblock Checker', '@package_version@');
24+
$application->add($command);
25+
$application->run();

‎box.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"."
55
],
66
"files": [
7-
"LICENSE.md"
7+
"LICENSE"
88
],
99
"finder": [
1010
{
@@ -13,8 +13,9 @@
1313
"in": "vendor"
1414
}
1515
],
16+
"compression": "GZ",
1617
"git-version": "package_version",
17-
"main": "phpdoccheck",
18-
"output": "phpdoccheck.phar",
19-
"stub": true
20-
}
18+
"main": "bin/phpdoc-checker",
19+
"output": "phpdoc-checker.phar",
20+
"stub": true
21+
}

‎composer.json

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,40 @@
11
{
2-
"name" : "block8/php-docblock-checker",
3-
"description" : "A simple tool for checking that your PHP classes and methods use docblocks.",
2+
"name" : "php-censor/phpdoc-checker",
3+
"description" : "A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).",
44
"minimum-stability": "stable",
55
"type" : "library",
6-
"keywords" : ["php", "phpci", "testing", "docblock", "comment", "checker", "code quality"],
7-
"homepage" : "https://www.phptesting.org/",
6+
"keywords" : ["php", "php-censor", "testing", "docblock", "phpdoc", "comment", "checker", "code quality"],
7+
"homepage" : "https://github.com/php-censor/phpdoc-checker",
88
"license" : "BSD-2-Clause",
9-
10-
"authors": [
9+
"authors": [
1110
{
12-
"name" : "Dan Cryer",
13-
"email" : "dan.cryer@block8.co.uk",
11+
"name": "Dmitry Khomutov",
12+
"email": "poisoncorpsee@gmail.com",
13+
"homepage": "http://corpsee.com",
14+
"role": "PHPDoc Checker"
15+
},
16+
{
17+
"name": "Dan Cryer",
18+
"email": "dan.cryer@block8.co.uk",
1419
"homepage": "http://www.block8.co.uk",
15-
"role" : "Developer"
20+
"role": "PHP DocBlocks Checker developer"
1621
}
1722
],
18-
1923
"support": {
20-
"issues": "https://github.com/Block8/php-docblock-checker/issues",
21-
"source": "https://github.com/Block8/php-docblock-checker"
24+
"issues": "https://github.com/php-censor/phpdoc-checker/issues",
25+
"source": "https://github.com/php-censor/phpdoc-checker"
26+
},
27+
"autoload": {
28+
"psr-4": {
29+
"PhpDocChecker\\": "src/"
30+
}
2231
},
23-
2432
"require": {
25-
"php": ">=5.3.3",
33+
"php": ">=5.6.0",
2634
"nikic/php-parser": "3.*",
27-
"symfony/console": "3.*"
28-
},
29-
30-
"require-dev": {
31-
"phpmd/phpmd": "~2.0",
32-
"squizlabs/php_codesniffer": "~1.5",
33-
"phploc/phploc": "~2.0"
35+
"symfony/console": "~3.4.0"
3436
},
35-
3637
"bin": [
37-
"phpdoccheck"
38+
"bin/phpdoc-checker"
3839
]
3940
}

0 commit comments

Comments
 (0)