lochmueller/sourceopt

Optimization of the final page: reformatting the (x)HTML output & removal of new-lines, comments and generator-info including search and replace strings using your regular expressions. In addition combines all SVG selected within content-elements into one <symbol> file and replaces <img> by <use>.

5.1.2 2023-10-14 17:44 UTC

Requires

• php: ^7.4||^8.0
• typo3/cms-core: ^9.5||^10.4||^11.5||^12.4

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.3
• phpmd/phpmd: ^2.10
• typo3/testing-framework: ^6.4

Replaces

• maxserv/replacecontent: *
• typo3-ter/replacecontent: *
• typo3-ter/sourceopt: 5.1.2

GPL-2.0-or-later

README

• SourceOpt : reformatting the (x)HTML output & removal of new-lines, comments and generator-info
• RegExRep : search and replace strings using your regular expressions ; embrace regex and migrate now
• SVGstore : combines all SVG selected within elements into one <symbol> file and replaces <img> by <use>

Installation

sourceopt/composer.json

Lines 19 to 20 in 2346673

	"php": "^7.4||^8.0",
	"typo3/cms-core": "^9.5||^10.4||^11.5||^12.0"

composer require lochmueller/sourceopt

• via TypoScript

  [constants]

  @import 'EXT:sourceopt/Configuration/TypoScript/constants'
  

  [setup]

  @import 'EXT:sourceopt/Configuration/TypoScript/setup'
  

• via input device

  • add [EXT:sourceopt/Configuration/TypoScript] into Include static at Includes in Template

Configuration

Include the extension and go to the Constant Editor of a template where you find all options under PLUGIN

Performance

The PHP process need server performance, because there are several search/replace operations in the logic

Reference

Note: The following features are executed in reverse order

SourceOpt

TypoScript [constants] || prepend config. at [setup]

Property	Type	Description	Default
sourceopt.enabled	boolean	Is the optimization enabled for this template	1
sourceopt.removeGenerator	boolean	Remove <meta name="generator" content="TYPO3 CMS">	1
sourceopt.removeComments	boolean	Remove HTML-Comments	1
sourceopt.removeComments.keep	array	Spare these listed comments: Regular expressions that match comments that should not be removed. Very useful e.g. to keep the TYPO3SEARCH-Comments so indexed_search can work properly	.10
sourceopt.removeComments.keep.10	string	Spare TYPO3SEARCH-Comments from removal	/^TYPO3SEARCH_/usi
sourceopt.headerComment	string	Your additional (appended) header comment	[empty]
sourceopt.formatHtml	integer	Formats the code beautiful and easy readable. New lines and tabs are used in the usual way of illustrating the structure of an XML code. Options sourceopt/Classes/Service/CleanHtmlService.php Lines 156 to 161 in 2346673 * 0 => off * 1 => no line break at all (code in one line) * 2 => minimalistic line breaks (structure defining box-elements) * 3 => aesthetic line breaks (important box-elements) * 4 => logic line breaks (all box-elements) * 5 => max line breaks (all elements).	4
sourceopt.formatHtml.tabSize	integer	Defines the size of the tabs used for formating. If blank one tab is used. If a number is specified the specified number of blank spaces is used instead. This will only work together with formatHtml	[empty]
sourceopt.formatHtml.debugComment	boolean	Includes a comment at the end of the html source code that points the numbers of open html tags. This will only work together with formatHtml	[empty]

RegEx Replace

TypoScript [setup] incl. stdWrap

config.replacer {
  search {
    1 = /(?<="|')\/?(fileadmin|typo3temp|uploads)/

    give-me-cherries = /fruit/

    wrapBoldly < tmp.find
    wrapBoldly.wrap = /|/
  }
  replace {
    1 = //cdn.tld/$1

    give-me-cherries = cherry

    wrapBoldly < tmp.repl
    wrapBoldly.wrap = <b>|</b>
  }
}

Note: both arrays will be ksort'ed in "natural order"

HowTo migrate

from jweiland/replacer : 1.4 - 2.x

• regex replace config\.tx_(?:\w*replace\w*) to config.replacer
• remove config.tx_replacer.enable_regex = 1

from maxserv/replacecontent 2013 - 2017

• regex replace config\.tx_(?:\w*replace\w*) to config.replacer

from typo3-ter/ja_replacer 2009 - 2013 || phorax/ja-replacer 2016

composer install jweiland/replacer

& replace config.tx_ja_replacer to config.tx_replacer

from typo3-ter/n84_contentreplacer 2016

• regex replace config\.tx_(?:\w*replace\w*) to config.replacer

from typo3-ter/fereplace 2011

composer install jweiland/replacer

& replace plugin.fereplace.pairs to config.tx_replacer .. ah .. and one regex

• search (\n\s*)(\d+)(?:{\s+|\.)old\s*=\s*([^\n]+).+?new\s*=\s*([^\n]+)
• replace $1search.$2 = $3\n$1replace.$2 = $4

from typo3-ter/regex 2009

• regex replace config\.regex to config.replacer
• regex replace (?:\s)(\w+)\s*=\s* to search.$1 =
• regex replace (\w+)\.replacement\s*=\s* to replace.$1 =

from any other tool or just for regex

• regex replace (?:config|plugin)\.tx_any_other_tool to config.replacer
• inside block search
  • regex replace \/ to \\/ (carefully)
  • regex replace \s*=\s*(.+) to = /$1/
• inside block replace
  • regex replace \s*=\s*(.+) to = $1
  • consider a PR for conversion specifics

SVGstore

TypoScript [constants] || prepend config. at [setup]

Property	Type	Description	Default
svgstore.enabled	boolean	Is the SVG extract & merge enabled for this template	1
svgstore.fileSize	integer	Maximum file size of a SVG to include (in [byte])	50000

ToDo:

• Try external packages like https://github.com/ArjanSchouten/HtmlMinifier