Review main Merged

70277[TASK] Remove docBlockChecker integrity test

Christian Kuhn CR +2 V +2 Hard +0 −355 updated 08/06/21, 18:43

Commit message

We have the annotationChecker and the ever growing
phpstan ruleset that scan our codebase for code and
documentation code block violations.

For the additional script docBlockChecker.php it's
unclear what it actually does and when it should fail.
It never went red to my knowledge. The patch author
didn't know what was going on and I've been unable to
make the script fail with local tests. The mentioned
phpdocumentor/phpdocumentor seems to have never
materialized in our world, and tools like api.typo3.org
rely on doxygen.

The patch drops that integrity test script and removes
usages in runTests.sh and gitlab-ci.

Review

  • Code review CR +2 Done
    • Christian Kuhn +2
    • Jochen Roth +1
    • Wouter Wolters +1
  • Verified V +2 Done
    • Christian Kuhn +2
    • Jochen Roth +1
    • Wouter Wolters +1
    • core-ci +1 CI

Issues 2

Files 5

Review log 89

  1. Christian Kuhn uploaded patch set 1 08/06/21, 17:02

  2. Wouter Wolters voted on patch set 1 CR +1 08/06/21, 17:11

  3. core-ci voted on patch set 1 V +1 08/06/21, 17:17 Core CI is happy: https://gitlab.typo3.org/typo3/CI/cms/-/pipelines/14219

  4. Wouter Wolters voted on patch set 1 V +1 08/06/21, 17:29

  5. Jochen Roth voted on patch set 1 V +1 CR +1 08/06/21, 17:43

  6. Alexander Schnitzler commented on patch set 1 08/06/21, 17:50

    Just to clarify. This check had something to do with issues that occurred when creating a class map for classes of the core. The patch that introduced the checker explains this visually quite well. https://review.typo3.org/c/Packages/TYPO3.CMS/+/61557 I don't know why this check doesn't produce errors anymore. Maybe nobody ever introduced invalid phpdoc any more or it broke due to an update of the library. However this checker has nothing to do with beautifying doc blocks or preparing them for rendering an api or something. People had actual issues with our code back then. If phpstan can fully take over this job is unclear to me.
  7. Christian Kuhn commented on patch set 1 08/06/21, 18:14

    Reply

    Thanks alex! I tried various things by reverting the changes that have been introduced with https://review.typo3.org/c/Packages/TYPO3.CMS/+/61557 trying to make this script fail (I also did that some month ago when gitlab has been introduced), and I'm still unable to find a scenario where this script actually fails. From my testing (which of course may be incomplete), the script does not add value. We have 2 options: a) Try to find out what it does and try to fix and document it, or b) drop it. Are you available to go with a)? Otherwise I'd go with b) as the patch proposes.
  8. Christian Kuhn commented on patch set 1 V +2 CR +2 08/06/21, 18:42

    small chat with alex: 'merge it, wanted to document some details in the patch, though'
  9. Christian Kuhn merged patch set 2 08/06/21, 18:43