[TASK] Tighten rst validation rule for keyword 94/59794/4
authorAnja Leichsenring <anja.leichsenring@typo3.com>
Sun, 24 Feb 2019 07:59:41 +0000 (08:59 +0100)
committerAnja Leichsenring <aleichsenring@ab-softlab.de>
Fri, 1 Mar 2019 10:16:49 +0000 (11:16 +0100)
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
Reviewed-on: https://review.typo3.org/c/59794
Tested-by: Stephan Großberndt <stephan.grossberndt@typo3.org>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Jürgen Venne <venne@schaffrath-digital.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Stephan Großberndt <stephan.grossberndt@typo3.org>
Reviewed-by: Susanne Moog <susanne.moog@typo3.org>
Reviewed-by: Jürgen Venne <venne@schaffrath-digital.de>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
19 files changed:
Build/Scripts/validateRstFiles.php
typo3/sysext/core/Documentation/Changelog/8.7.x/Important-85689-ReplacedDefaultValueWithPlaceholderInExternalUrlLinkHandler.rst
typo3/sysext/core/Documentation/Changelog/9.0/Breaking-81775-ExtFormSuffixFormIdentifierWithContentElementUid.rst
typo3/sysext/core/Documentation/Changelog/9.0/Deprecation-82903-DeprecateClientUtility.rst
typo3/sysext/core/Documentation/Changelog/9.2/Breaking-83475-AggregateValidatorInformationInClassSchema.rst
typo3/sysext/core/Documentation/Changelog/9.2/Deprecation-84637-TemplateService-linkDataFunctionalityMovedInPageLinkBuilder.rst
typo3/sysext/core/Documentation/Changelog/9.2/Important-84658-KeepSortingForDeletedRecords.rst
typo3/sysext/core/Documentation/Changelog/9.3/Breaking-85036-RemoveSupportForNonNamespacedClassesInExtbase.rst
typo3/sysext/core/Documentation/Changelog/9.3/Deprecation-85005-DeprecateMethodsAndConstantsInValidatorResolver.rst
typo3/sysext/core/Documentation/Changelog/9.4/Breaking-85080-MethodIsEnabledAddedToRenderableInterfaceAndFinisherInterface.rst
typo3/sysext/core/Documentation/Changelog/9.4/Breaking-85398-DropDocumentationExtension.rst
typo3/sysext/core/Documentation/Changelog/9.4/Deprecation-84387-DeprecatedMethodAndPropertyInSchedulerModuleController.rst
typo3/sysext/core/Documentation/Changelog/9.4/Deprecation-85004-DeprecateMethodsInReflectionService.rst
typo3/sysext/core/Documentation/Changelog/9.4/Deprecation-85727-DatabaseIntegrityCheckMovedToEXTlowlevel.rst
typo3/sysext/core/Documentation/Changelog/9.4/Deprecation-85892-VariousMethodsRegardingSysDomainResolving.rst
typo3/sysext/core/Documentation/Changelog/9.4/Deprecation-85977-ExtbaseCommandControllersAndCliAnnotation.rst
typo3/sysext/core/Documentation/Changelog/9.5/Deprecation-85980-InternalAnnotationInExtbaseCommands.rst
typo3/sysext/core/Documentation/Changelog/9.5/Deprecation-86288-FrontendBackendUserAuthenticationMethods.rst
typo3/sysext/core/Documentation/Changelog/9.5/Deprecation-86338-ChangeVisibilityOfPageRepository-init.rst

index 81784e1..f1571dd 100755 (executable)
@@ -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',
             ],
         ];
 
index 427affa..f8f1a13 100644 (file)
@@ -15,4 +15,4 @@ to duplicate HTTP protocols, for example: `http://https://typo3.org/`
 
 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
index 35ab25c..c64f530 100644 (file)
@@ -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
index ce736db..495ac0b 100644 (file)
@@ -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
index 6a6833b..5b40458 100644 (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
index 932954e..660dffe 100644 (file)
@@ -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
index de2db39..ffa414f 100644 (file)
@@ -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
index 02adc11..93f51bf 100644 (file)
@@ -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
 :php:`TYPO3\CMS\Extbase\Reflection\ReflectionService::getClassSchema()`.
 
-.. index:: FullyScanned, PHP-API, ext:extbase
+.. index:: PHP-API, ext:extbase, FullyScanned
index ca2a374..be7d458 100644 (file)
@@ -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
index c7da3d7..cb7273f 100644 (file)
@@ -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
index d5d8835..13df083 100644 (file)
@@ -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
 :php:`Bootstrap::initializeBackendAuthentication();`.
 
-.. index:: FullyScanned, ext:scheduler
+.. index:: ext:scheduler, FullyScanned
index fe0ceca..484debf 100644 (file)
@@ -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