3 declare(strict_types
= 1);
6 * This file is part of the TYPO3 CMS project.
8 * It is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, either version 2
10 * of the License, or any later version.
12 * For the full copyright and license information, please read the
13 * LICENSE.txt file that was distributed with this source code.
15 * The TYPO3 project - inspiring people to share!
18 use PhpParser\Comment\Doc
;
21 use PhpParser\NodeTraverser
;
22 use PhpParser\NodeVisitorAbstract
;
23 use PhpParser\ParserFactory
;
24 use Symfony\Component\Console\Output\ConsoleOutput
;
26 require_once __DIR__
. '/../../vendor/autoload.php';
31 class NodeVisitor
extends NodeVisitorAbstract
38 public function enterNode(Node
$node)
40 switch (get_class($node)) {
41 case Node\Stmt\Class_
::class:
42 case Node\Stmt\Property
::class:
43 case Node\Stmt\ClassMethod
::class:
44 /** Node\Stmt\ClassMethod $node */
45 if (!($docComment = $node->getDocComment()) instanceof Doc
) {
49 // These annotations are OK to have, everything else is denied
50 $negativeLookaheadMatches = [
52 'Annotation', 'Attribute', 'Attributes', 'Required', 'Target',
53 // Widely used tags (but not existent in phpdoc)
54 'fix', 'fixme', 'override',
55 // PHPDocumentor 1 tags
56 'abstract', 'access', 'code', 'deprec', 'endcode', 'exception', 'final', 'ingroup', 'inheritdoc', 'inheritDoc', 'magic', 'name', 'toc', 'tutorial', 'private', 'static', 'staticvar', 'staticVar', 'throw',
57 // PHPDocumentor 2 tags
58 'api', 'author', 'category', 'copyright', 'deprecated', 'example', 'filesource', 'global', 'ignore', 'internal', 'license', 'link', 'method', 'package', 'param', 'property', 'property-read', 'property-write', 'return', 'see', 'since', 'source', 'subpackage', 'throws', 'todo', 'TODO', 'usedby', 'uses', 'var', 'version',
60 'codeCoverageIgnore', 'codeCoverageIgnoreStart', 'codeCoverageIgnoreEnd', 'test', 'covers', 'dataProvider', 'group', 'skip', 'depends', 'expectedException', 'before', 'requires',
64 'SuppressWarnings', 'noinspection',
65 // Extbase related (deprecated)
66 'transient', 'cli', 'flushesCaches',
68 'TYPO3\\\\CMS\\\\Extbase\\\\Annotation\\\\Inject', 'Extbase\\\\Inject', 'Inject',
69 'TYPO3\\\\CMS\\\\Extbase\\\\Annotation\\\\Validate', 'Extbase\\\\Validate', 'Validate',
70 'Transient', 'Extbase\\\\ORM\\\\Lazy', 'IgnoreValidation', 'Enum',
71 'TYPO3\\\\CMS\\\\Extbase\\\\Annotation\\\\ORM\\\\Cascade', 'Extbase\\\\ORM\\\\Cascade', 'Cascade',
73 'extensionScannerIgnoreFile', 'extensionScannerIgnoreLine'
78 '/\*\s@(?!' . implode('|', $negativeLookaheadMatches) . ')(?<annotations>[a-zA-Z0-9\\\\]+)/',
79 $docComment->getText(),
83 if (!empty($matches['annotations'])) {
84 $this->matches
[$node->getLine()] = array_map(function ($value) {
86 }, $matches['annotations']);
96 $parser = (new ParserFactory
)->create(ParserFactory
::ONLY_PHP7
);
98 $finder = new Symfony\Component\Finder\
Finder();
100 ->in(__DIR__
. '/../../typo3/')
102 // black list some deprecated unit test fixture files that test old deprecations
103 ->notPath('/.*sysext\/extbase\/Tests\/UnitDeprecated\/Reflection\/Fixture/')
104 // black list some unit test fixture files from extension scanner that test matchers of old annotations
105 ->notName('MethodAnnotationMatcherFixture.php')
106 ->notName('PropertyAnnotationMatcherFixture.php')
109 $output = new ConsoleOutput();
112 foreach ($finder as $file) {
114 $ast = $parser->parse($file->getContents());
115 } catch (Error
$error) {
116 $output->writeln('<error>Parse error: ' . $error->getMessage() . '</error>');
120 $visitor = new NodeVisitor();
122 $traverser = new NodeTraverser();
123 $traverser->addVisitor($visitor);
125 $ast = $traverser->traverse($ast);
127 if (!empty($visitor->matches
)) {
128 $errors[$file->getRealPath()] = $visitor->matches
;
129 $output->write('<error>F</error>');
131 $output->write('<fg=green>.</>');
135 $output->writeln('');
137 if (!empty($errors)) {
138 $output->writeln('');
140 foreach ($errors as $file => $matchesPerLine) {
141 $output->writeln('');
142 $output->writeln('<error>' . $file . '</error>');
145 * @var array $matchesPerLine
147 * @var array $matches
149 foreach ($matchesPerLine as $line => $matches) {
150 $output->writeln($line . ': ' . implode(', ', $matches));