Commit a9a1c2d4 authored by Anja Leichsenring's avatar Anja Leichsenring Committed by Anja Leichsenring
Browse files

[TASK] Tighten rst validation rule for keyword

Ignore FullyScanned|PartiallyScanned|NotScanned when looking for valid
keywords on rst files and update existing Changelog files accordingly.

Resolves: #87774
Relates: #87772
Releases: master, 9.5, 8.7
Change-Id: I5e9a9c690ddb55ef11c52bde074d4e0175b17837

Tested-by: Stephan Großberndt's avatarStephan Großberndt <>
Tested-by: default avatarTYPO3com <>
Tested-by: Jürgen Venne's avatarJürgen Venne <>
Tested-by: Anja Leichsenring's avatarAnja Leichsenring <>
Reviewed-by: Stephan Großberndt's avatarStephan Großberndt <>
Reviewed-by: Susanne Moog's avatarSusanne Moog <>
Reviewed-by: Jürgen Venne's avatarJürgen Venne <>
Reviewed-by: Anja Leichsenring's avatarAnja Leichsenring <>
parent 8e64eda6
......@@ -166,9 +166,9 @@ class validateRstFiles
$checkFor = [
'type' => 'index',
'regex' => '#^\.\. index:: (?:(?:FullyScanned|PartiallyScanned|NotScanned|TypoScript|TSConfig|TCA|FlexForm|LocalConfiguration|Fluid|FAL|Database|JavaScript|PHP-API|Frontend|Backend|CLI|RTE|ext:[a-zA-Z_0-9]+)(?:,\\s|$))+#',
'regex' => '#^\.\. index:: (?:(?:TypoScript|TSConfig|TCA|FlexForm|LocalConfiguration|Fluid|FAL|Database|JavaScript|PHP-API|Frontend|Backend|CLI|RTE|ext:[a-zA-Z_0-9]+)(?:,\\s|$))+#',
'title' => 'no or wrong index',
'message' => 'insert \'.. index:: <at least one valid keyword>\' at last line of the file. See Build/Scripts/validateRstFiles.php for allowed keywords',
'message' => 'insert \'.. index:: <at least one valid keyword>\' at the last line of the file. See Build/Scripts/validateRstFiles.php for allowed keywords',
......@@ -15,4 +15,4 @@ to duplicate HTTP protocols, for example: `http://`
A placeholder is now used instead of a default value. Editors can paste links directly and do not have to remove a default value first.
.. index:: NotScanned
\ No newline at end of file
.. index:: PHP-API, Backend
\ No newline at end of file
......@@ -37,4 +37,4 @@ Affected Installations
All instances, that render forms through the "form" content element.
.. index:: NotScanned, Frontend, ext:form
.. index:: Frontend, ext:form, NotScanned
......@@ -33,4 +33,4 @@ Migration
Use a 3rd party API like
.. index:: FullyScanned, PHP-API
.. index:: PHP-API, FullyScanned
......@@ -54,4 +54,4 @@ inside a model validator, that is automatically registered and loaded if defined
When using that feature with regular objects, you need to write custom validators and call the desired property
validators in there.
.. index:: NotScanned
.. index:: ext:extbase, PHP-API, NotScanned
......@@ -40,4 +40,4 @@ Migration
Access the corresponding new methods within :php:`PageLinkBuilder` instead of the TemplateService-related
methods, or use the existing hook to modify parameters for a URL.
.. index:: FullyScanned
\ No newline at end of file
.. index:: PHP-API, FullyScanned
\ No newline at end of file
......@@ -31,4 +31,4 @@ Migration
Check your functional tests fixtures and set the expected sorting value for deleted records equal to
the starting value.
.. index:: NotScanned
.. index:: PHP-API, Database
......@@ -36,4 +36,4 @@ Migration
Use namespaced class names for Extbase.
.. index:: NotScanned, ext:extbase
.. index:: ext:extbase, NotScanned
......@@ -41,4 +41,4 @@ Migration
There is none.
.. index:: PartiallyScanned, PHP-API, ext:extbase
.. index:: PHP-API, ext:extbase, PartiallyScanned
......@@ -31,4 +31,4 @@ Migration
Third party code implementing these interfaces must be updated to implement the :php:`isEnabled()` method, preferably
by extending :php:`AbstractRenderable` (or one of its subclasses) or :php:`AbstractFinisher`.
.. index:: NotScanned, ext:form
.. index:: ext:form, NotScanned
......@@ -51,4 +51,4 @@ they existed before.
.. _docs:
.. index:: NotScanned
.. index:: ext:documentation, NotScanned
......@@ -35,4 +35,4 @@ Instead of calling the method :php:`SchedulerModuleController::addMessage()`, in
you can now extend :php:`TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider` which provides a method :php:`addMessage()`
with the same API like before.
.. index:: FullyScanned, Backend, PHP-API
.. index:: Backend, PHP-API, FullyScanned
......@@ -43,4 +43,4 @@ Instead of fetching reflection data via :php:`TYPO3\CMS\Extbase\Reflection\Refle
directly be fetched from a :php:`TYPO3\CMS\Extbase\Reflection\ClassSchema` instance. An instance can be created by calling
.. index:: FullyScanned, PHP-API, ext:extbase
.. index:: PHP-API, ext:extbase, FullyScanned
......@@ -33,4 +33,4 @@ Ensure that the system extension `lowlevel` is installed, and the caller code us
For TYPO3 v9, the old class is kept in place and will be removed in TYPO3 v10.
.. index:: FullyScanned, ext:lowlevel
.. index:: ext:lowlevel, FullyScanned
......@@ -41,4 +41,4 @@ Migration
Migrate to either the new Routing API (finalized for 9 LTS) or implement the functionality in your own, or use the :php:`LegacyDomainResolver` class,
but since the concept of sys_domain handling will be removed in TYPO3 v10, consider use of the Site handling functionality instead.
.. index:: FullyScanned, Frontend, Backend
.. index:: Frontend, Backend, FullyScanned
......@@ -53,4 +53,4 @@ Model / Repositories and ORM, or if native database queries will suit your task
If anything related to DataHandler and Backend permission handling is necessary, you should run
.. index:: FullyScanned, ext:scheduler
.. index:: ext:scheduler, FullyScanned
......@@ -37,4 +37,4 @@ Migration
Just remove the annotation from the affected controllers.
.. index:: NotScanned, ext:extbase
.. index:: ext:extbase, NotScanned
......@@ -37,4 +37,4 @@ Migration
Use either methods from :php:`BackendUserAuthentication` directly, or - if in context of Admin Panel or
Frontend Editing - use the API methods within these modules directly, if necessary.
.. index:: FullyScanned, PHP-API, Frontend, Backend
.. index:: PHP-API, Frontend, Backend, FullyScanned
......@@ -29,4 +29,4 @@ Migration
Remove the call to the :php:`PageRepository::init()` function. The constructor is taking care of calling the method.
.. index:: NotScanned, ext:frontend
.. index:: ext:frontend, NotScanned
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment