Skip to content

Commit

Permalink
[TASK] Use @import instead of <INCLUDE_TYPOSCRIPT
Browse files Browse the repository at this point in the history
To be an example of best practice, this patch changes
all usages of "<INCLUDE_TYPOSCRIPT ..." to "@import".

Tests are adapted as well, as long as they are not
tailored to actually test INCLUDE_TYPOSCRIPT syntax.

Resolves: #101813
Related: #97816
Releases: main, 12.4
Change-Id: I01c4eb19dfd0106c5577457cd0e1836865112d6a
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80797
Tested-by: core-ci <typo3@b13.com>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
  • Loading branch information
lolli42 committed Aug 31, 2023
1 parent b72cc6c commit 5d193b1
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 37 deletions.
@@ -1,4 +1,4 @@
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:test_irre_foreignfield/Configuration/TypoScript/setup.typoscript">
@import './setup.typoscript'

page {
20 = COA
Expand Down
Expand Up @@ -38,14 +38,12 @@ public static function extensionPathSoftReferenceParserDataProvider(): array
foo = bar
@import "EXT:foobar/Configuration/TypoScript/setup2.typoscript"
# some comment
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:foobar/Configuration/TypoScript/setup3.typoscript">
',
'content' => '
@import \'EXT:foobar/Configuration/TypoScript/setup1.typoscript\'
foo = bar
@import "EXT:foobar/Configuration/TypoScript/setup2.typoscript"
# some comment
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:foobar/Configuration/TypoScript/setup3.typoscript">
',
'elements' => [
2 => [
Expand All @@ -54,9 +52,6 @@ public static function extensionPathSoftReferenceParserDataProvider(): array
5 => [
'matchString' => 'EXT:foobar/Configuration/TypoScript/setup2.typoscript',
],
8 => [
'matchString' => 'EXT:foobar/Configuration/TypoScript/setup3.typoscript',
],
],
'hasMatched' => true,
],
Expand Down
Expand Up @@ -97,7 +97,18 @@ lib.viewConfig {
}
[end]

<INCLUDE_TYPOSCRIPT: source="FILE: ./FluidTemplateContentObject.typoscript" condition="[traverse(request.getQueryParams(), 'mode') == 'fluidTemplate' || traverse(request.getParsedBody(), 'mode') == 'fluidTemplate']">
<INCLUDE_TYPOSCRIPT: source="FILE: ./ExtbasePlugin.typoscript" condition="[traverse(request.getQueryParams(), 'mode') == 'plugin' || traverse(request.getParsedBody(), 'mode') == 'plugin']">
<INCLUDE_TYPOSCRIPT: source="FILE: ./ExtbaseController.typoscript" condition="[traverse(request.getQueryParams(), 'mode') == 'controller' || traverse(request.getParsedBody(), 'mode') == 'controller']">
<INCLUDE_TYPOSCRIPT: source="FILE: ./ExtbaseTwoPlugins.typoscript" condition="[traverse(request.getQueryParams(), 'mode') == '2plugins' || traverse(request.getParsedBody(), 'mode') == '2plugins']">
[traverse(request.getQueryParams(), 'mode') == 'fluidTemplate' || traverse(request.getParsedBody(), 'mode') == 'fluidTemplate']
@import './FluidTemplateContentObject.typoscript'
[end]

[traverse(request.getQueryParams(), 'mode') == 'plugin' || traverse(request.getParsedBody(), 'mode') == 'plugin']
@import './ExtbasePlugin.typoscript'
[end]

[traverse(request.getQueryParams(), 'mode') == 'controller' || traverse(request.getParsedBody(), 'mode') == 'controller']
@import './ExtbaseController.typoscript'
[end]

[traverse(request.getQueryParams(), 'mode') == '2plugins' || traverse(request.getParsedBody(), 'mode') == '2plugins']
@import './ExtbaseTwoPlugins.typoscript'
[end]
@@ -1,32 +1,30 @@
# Include setup
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/Helper/ContentElement.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/Helper/ParseFunc.typoscript">

@import './Helper/ContentElement.typoscript'
@import './Helper/ParseFunc.typoscript'

# Typical content elements
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Bullets.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Div.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Header.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Html.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Image.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/List.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Shortcut.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Table.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Text.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Textmedia.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Textpic.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/Uploads.typoscript">

@import './ContentElement/Bullets.typoscript'
@import './ContentElement/Div.typoscript'
@import './ContentElement/Header.typoscript'
@import './ContentElement/Html.typoscript'
@import './ContentElement/Image.typoscript'
@import './ContentElement/List.typoscript'
@import './ContentElement/Shortcut.typoscript'
@import './ContentElement/Table.typoscript'
@import './ContentElement/Text.typoscript'
@import './ContentElement/Textmedia.typoscript'
@import './ContentElement/Textpic.typoscript'
@import './ContentElement/Uploads.typoscript'

# Menu content elements
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuAbstract.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuCategorizedContent.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuCategorizedPages.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuPages.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuSubpages.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuSection.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuSectionPages.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuRecentlyUpdated.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuRelatedPages.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuSitemap.typoscript">
<INCLUDE_TYPOSCRIPT: source="FILE:EXT:fluid_styled_content/Configuration/TypoScript/ContentElement/MenuSitemapPages.typoscript">
@import './ContentElement/MenuAbstract.typoscript'
@import './ContentElement/MenuCategorizedContent.typoscript'
@import './ContentElement/MenuCategorizedPages.typoscript'
@import './ContentElement/MenuPages.typoscript'
@import './ContentElement/MenuSubpages.typoscript'
@import './ContentElement/MenuSection.typoscript'
@import './ContentElement/MenuSectionPages.typoscript'
@import './ContentElement/MenuRecentlyUpdated.typoscript'
@import './ContentElement/MenuRelatedPages.typoscript'
@import './ContentElement/MenuSitemap.typoscript'
@import './ContentElement/MenuSitemapPages.typoscript'

0 comments on commit 5d193b1

Please sign in to comment.