Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fpvcode/shrinkwrap

All-in-one web page minifier (HTML/JS/CSS), in PHP.
https://github.com/fpvcode/shrinkwrap

css-minification css-minifier html-minification html-minifier html-minify js-minification js-minifier mini minifier minify-css minify-html minify-javascript minify-js php

Last synced: about 1 month ago
JSON representation

All-in-one web page minifier (HTML/JS/CSS), in PHP.

Host: GitHub
URL: https://github.com/fpvcode/shrinkwrap
Owner: fpvcode
License: mit
Created: 2023-11-23T18:38:03.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-01-10T04:42:55.000Z (12 months ago)
Last Synced: 2024-11-19T12:36:56.885Z (about 1 month ago)
Topics: css-minification, css-minifier, html-minification, html-minifier, html-minify, js-minification, js-minifier, mini, minifier, minify-css, minify-html, minify-javascript, minify-js, php
Language: PHP
Homepage:
Size: 62.5 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        > # UKRAINE NEEDS YOUR HELP NOW!

>

> On 24 February 2022, Russian [President Vladimir Putin ordered an invasion of Ukraine by Russian Armed Forces](https://www.bbc.com/news/world-europe-60504334).

>

> Your support is urgently needed.

>

> - Donate to the volunteers. Here is the volunteer fund helping the Ukrainian army to provide all the necessary equipment:

>  https://bank.gov.ua/en/news/all/natsionalniy-bank-vidkriv-spetsrahunok-dlya-zboru-koshtiv-na-potrebi-armiyi or https://savelife.in.ua/en/donate/

> - Triple-check social media sources. Russian disinformation is attempting to coverup and distort the reality in Ukraine.

> - Help Ukrainian refugees who are fleeing Russian attacks and shellings: https://www.globalcitizen.org/en/content/ways-to-help-ukraine-conflict/

> - Put pressure on your political representatives to provide help to Ukraine.

> - Believe in the Ukrainian people, they will not surrender, they don't have another Ukraine.

>

> THANK YOU!

----

# ShrinkWrap

## Description

**ShrinkWrap** it's a wrapper for PHP minifiers of HTML/JS/CSS code. The main purpose of creating this wheel is the desire to have a more or less flexible tool for minifying ready-made HTML pages created by 3rd-party applications. Simply put - we submit an HTML page at the input, and at the output we have a page in which (optional):

 - HTML, inline JS-scripts and CSS-styles are minified.

 - JS and CSS files referenced by the page (except external ones) are minified (can also be combined) and cached, and the corresponding links are changed to point to the cache.

At the moment, **ShrinkWrap** uses the following tools:

- HTML DOM parser:

    - [Masterminds/HTML5-PHP](https://github.com/Masterminds/html5-php).

- Minifiers:

    - HTML:

	    - [voku/HtmlMin](https://github.com/voku/HtmlMin).

    - JS:

	    - [matthiasmullie/minify](https://github.com/matthiasmullie/minify).

    - CSS:

	    - [matthiasmullie/minify](https://github.com/matthiasmullie/minify).

## Requirments

- `PHP >= 7.3.0`

## Installation

Use `composer`: `composer require fpvcode/shrinkwrap`.  

Due to dependency requirements the package loaded by default requires PHP version `8.1.0`. To download the package compatible with PHP `7.3.0`, create a `composer.json` file with the following content:

```

{

    "config": {

        "vendor-dir": "vendor",

        "platform": {

            "php": "7.3"

        }

    }

}

```

## Usage

```

use fpvcode\ShrinkWrap;

$shrinkwrap = new ShrinkWrap();

// Global options

$shrinkwrap->doMinifyHtml(true);        // Allow to minify HTML Code. Default value is `false`.

$shrinkwrap->doMinifyInlineJs(true);    // Allow to minify inline scripts. The scripts combine and append in the bottom of related parent tag (`head` or `body`). Default value is `false`.

$shrinkwrap->doMinifyInlineCss(true);   // Allow to minify inline styles. The styles combine and append in the bottom of related parent tag (`head` or `body`). Default value is `false`.

$shrinkwrap->doMinifyJs(true);          // Allow to minify and cache non-minified JS-files. Default value is `false`.

$shrinkwrap->doCombineJs(true);         // Allow to combine all JS-files into one. Depends on `->doMinifyJS(true)`. Default value is `false`.

$shrinkwrap->doMinifyCss(true);         // Allow to minify and cache non-minified JS-files. Default value is `false`.

$shrinkwrap->doCombineCss(true);        // Allow to combine all CSS-files into one. Depends on `->doMinifyCSS(true)`. Default value is `false`.

$shrinkwrap->doLog(true);               // Show some info in the browser console. Default value is `false`.

$shrinkwrap->assetDir('assets');        // Directory to store minified files cache. Default value is `__DIR__/assets`.

/* --------------------------------------------------------------------------*/

// Configure minify engines and set their native options.

/* --------------------------------------------------------------------------*/

// Voku HtmlMin minify options. 
$voku_options = [ 
	'doOptimizeViaHtmlDomParser' 
	'doRemoveComments' 
	'doSumUpWhitespace' 
	'doRemoveWhitespaceAroundTags' 
	'doOptimizeAttributes' 
	'doRemoveHttpPrefixFromAttributes' 
	'doRemoveHttpsPrefixFromAttributes' 
	'doKeepHttpAndHttpsPrefixOnEx 
	'doMakeSameDomainsLinksRelative' 
	'doRemoveDefaultAttributes' 
	'doRemoveDeprecatedAnchorName' 
	'doRemoveDeprecatedScriptCharsetAttribute' 
	'doRemoveDeprecatedTypeFromScriptTag' 
	'doRemoveDeprecatedTypeFromStylesheetLink' 
	'doRemoveDeprecatedTypeFromSt 
	'doRemoveDefaultMediaTypeFrom 
	'doRemoveDefaultTypeFromButton' 
	'doRemoveEmptyAttributes' 
	'doRemoveValueFromEmptyInput' 
	'doSortCssClassNames' 
	'doSortHtmlAttributes' 
	'doRemoveSpacesBetweenTags' 
	'doRemoveOmittedQuotes' 
	'doRemoveOmittedHtmlTags'

=> true,  // optimize html via "HtmlDomParser()" => true,  // remove default HTML comments (depends on "doOptimizeViaHtmlDomParser(true)") => true,  // sum-up extra whitespace from the Dom (depends on "doOptimizeViaHtmlDomParser(true)") => true,  // remove whitespace around tags (depends on "doOptimizeViaHtmlDomParser(true)") => true,  // optimize html attributes (depends on "doOptimizeViaHtmlDomParser(true)") => true,  // remove optional "http:"-prefix from attributes (depends on "doOptimizeAttributes(true)") => true,  // remove optional "https:"-prefix from attributes (depends on "doOptimizeAttributes(true)") ternalAttributes' => true,  // keep "http:"- and "https:"-prefix for all external links => [],    // make some links relative, by removing the domain from attributes (['example.com']) => true,  // remove defaults (depends on "doOptimizeAttributes(true)" | disabled by default) => true,  // remove deprecated anchor-jump (depends on "doOptimizeAttributes(true)") => true,  // remove deprecated charset-attribute - the browser will use the charset from the HTTP-Header, anyway (depends on "doOptimizeAttributes(true)") => true,  // remove deprecated script-mime-types (depends on "doOptimizeAttributes(true)") => true,  // remove "type=text/css" for css links (depends on "doOptimizeAttributes(true)") yleAndLinkTag'    => true,  // remove "type=text/css" from all links and styles StyleAndLinkTag'  => true,  // remove "media="all" from all links and styles => false, // remove type="submit" from button tags => true,  // remove some empty attributes (depends on "doOptimizeAttributes(true)") => true,  // remove 'value=""' from empty  (depends on "doOptimizeAttributes(true)") => true,  // sort css-class-names, for better gzip results (depends on "doOptimizeAttributes(true)") => true,  // sort html-attributes, for better gzip results (depends on "doOptimizeAttributes(true)") => true,  // remove more (aggressive) spaces in the dom (disabled by default) => true,  // remove quotes e.g. class="lall" => class=lall => true,  // remove ommitted html tags e.g. 
lall
 => lall

];

$shrinkwrap->htmlEngineConfig('voku', $voku_options); // allows to customize the Voku HtmlMin minifier.

$html = '

  

    

    

    

    HTML page

    

      function a() {

        let a = 0;

      }

    

    

      .class-a {

        border-radius: 4px;

      }

    

    

    

    

    

    

    

  

  

    


      Test HTML

    


    

    

      function b() {

        let b = 0;

      }

    

    

      function c() {

        let c = 0;

      }

    

    

    

      .class-b {

        border-radius: 4px;

      }

    

    

      .class-c {

        border-radius: 4px;

      }

    

  

';

$html = $shrinkwrap->output($html);

```

Minified output:

```

HTML pagefunction a(){let a=0}.class-a{border-radius:4px}
 Test HTML function b(){let b=0};function c(){let c=0}.class-b{border-radius:4px}.class-c{border-radius:4px}

```

## Thanks

- Thanks to [Lars Moelleken](https://github.com/voku) for [HtmlMin](https://github.com/voku/HtmlMin) - HTML Compressor and Minifier for PHP.

- Thanks to [Matthias Mullie](https://github.com/matthiasmullie) for [Minify](https://github.com/matthiasmullie/minify) - CSS and JavaScript minifier.

- Thanks to [Masterminds](https://github.com/Masterminds) for [HTML5-PHP](https://github.com/Masterminds/html5-php) - An HTML5 parser and serializer for PHP.

- Thanks to [Microsoft](https://www.microsoft.com/) for [Visual Studio Code](https://code.visualstudio.com/) and [GitHub](https://github.com).