Transformer: Strip comments

[schlessera]

Feature description

Add logic to the existing Minify transformer so that it strips unneeded comments.

A configuration will be needed to let users add to that patterns of comments to skip.

Related ampproject/amp-wp#4213

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• Generated HTML output from the Optimizer is minified
• All non-essential HTML comments in the minified output have been removed
• Users can use a configuration value to retain a given comment or family of comments

Implementation brief

• See https://github.com/ampproject/amp-toolbox/pull/588/files

QA testing instructions

1. Verify: AMP optimization is enabled
2. Go to the AMP version of a page
3. use "View Source..." on the page to see the generated HTML markup
4. Verify: The generated HTML markup is minified
5. Verify: Non-essential comments have been removed

Demo

Changelog entry

[westonruter]

Previously: ampproject/amp-wp#2842.

[schlessera]

Fixed via #251

[DrLightman]

Hello, I need HTML comments to be present in my AMP page.

I don't understand if is this feature that is removing them, how can I verify?
I don't see an option to toggle this on/off in the settings screen.

[ediamin]

@DrLightman Yes, the MinifyHTML transformer strips out the comments by default.

I don't see an option to toggle this on/off in the settings screen.

Are you using AMP WP plugin?

[DrLightman]

Hi @ediamin

Yes the official plugin from here https://wordpress.org/plugins/amp/ (/wp-content/plugins/amp/amp.php)

Ok so I mighy hack in the code you kindly provided by setting that to false, if a filter is not available.

[ediamin]

You can use the amp_optimizer_config filter. You can try this snippet,

use AmpProject\Optimizer\Configuration\MinifyHtmlConfiguration;
use AmpProject\Optimizer\Transformer\MinifyHtml;

function minifyhtml_disable_remove_comments( $config ) {
	$config[ MinifyHtml::class ] = [
		MinifyHtmlConfiguration::REMOVE_COMMENTS => false,
	];

	return $config;
}

add_filter( 'amp_optimizer_config', 'minifyhtml_disable_remove_comments' );

[DrLightman]

Thank you very much @ediamin !