Initial commit

Author: jensscherbl

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 kenshō digital
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,52 @@
+# Kirby HTMLDoc
+
+Minifies HTML5 output for [Kirby][1] templates.
+
+## General
+
+Integrates [Hexydec’s][2] excellent [HTMLDoc library][3] into Kirby projects to minify HTML5 output.
+
+## Installation
+
+```shell
+composer require kenshodigital/kirby-htmldoc ^1.0
+```
+
+## Usage
+
+Basically works out of the box without any additional configuration. 
+
+### Configuration
+
+However, applicable content types as well as the library’s [default configuration][4] can be easily modified in your site’s [`config.php`][5].
+
+```php
+<?php
+
+return [
+    'kensho.htmldoc' => [
+        'contentTypes' = [
+            'htm',
+            'html',                    
+        ],
+        'options' => [
+            'quotes' => false,
+            'urls'   => [
+                'relative' => false,
+                'parent'   => false,
+            ],
+            ...
+        ],
+    ],
+];
+```
+
+#### Defaults
+
+Applicable content types are set to `htm` and `html` by default. For the library, only the setting for quotes deviates from the library’s default and is set to `false` in this plugin.
+
+[1]: https://getkirby.com
+[2]: https://github.com/hexydec
+[3]: https://github.com/hexydec/htmldoc
+[4]: https://github.com/hexydec/htmldoc/blob/master/docs/api/minify.md#options
+[5]: https://getkirby.com/docs/guide/configuration#the-config-php

composer.json

@@ -0,0 +1,29 @@
+{
+    "name":        "kenshodigital/kirby-htmldoc",
+    "description": "Minifies HTML5 output for Kirby templates.",
+    "type":        "kirby-plugin",
+    "version":     "1.0.0",
+    "homepage":    "https://github.com/kenshodigital/kirby-htmldoc",
+    "license":     "MIT",
+    "authors":
+    [
+        {
+            "name":  "Jens Scherbl",
+            "email": "[email protected]"
+        }
+    ],
+    "require":
+    {
+        "php":                         "^8.2",
+        "getkirby/cms":                "^4.0",
+        "getkirby/composer-installer": "^1.2",
+        "hexydec/htmldoc":             "^1.8"
+    },
+    "autoload":
+    {
+        "psr-4":
+        {
+            "Kensho\\HTMLDoc\\": "src"
+        }
+    }
+}

index.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+
+use hexydec\html;
+use Kensho\HTMLDoc\HTMLDoc;
+use Kirby\Cms\App;
+
+App::plugin('kensho/htmldoc', [
+    'options' => [
+        'contentTypes' => [
+            'htm',
+            'html',
+        ],
+        'options' => [
+            'quotes' => true,
+        ],
+    ],
+    'hooks' => [
+        'page.render:after' => function (string $contentType, array $data, string $html): string {
+            $kirby   = App::instance();
+            $lib     = new html\htmldoc;
+            $HTMLDoc = new HTMLDoc($kirby, $lib);
+
+            if ($HTMLDoc->isApplicable($contentType)) {
+                return $HTMLDoc->getMinified($html);
+            }
+            return $html;
+        },
+    ],
+]);

src/HTMLDoc.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+
+namespace Kensho\HTMLDoc;
+
+use hexydec\html;
+use Kirby\Cms\App;
+
+readonly class HTMLDoc
+{
+    private const OPTION_CONTENT_TYPES = 'kensho.htmldoc.contentTypes';
+    private const OPTION_OPTIONS       = 'kensho.htmldoc.options';
+
+    public function __construct(
+        private App          $kirby,
+        private html\htmldoc $lib,
+    ) {}
+
+    public function isApplicable(string $contentType): bool
+    {
+        $contentTypes = $this->getContentTypes();
+
+        return \in_array($contentType, $contentTypes);
+    }
+
+    private function getContentTypes(): array
+    {
+        return $this->kirby->option(self::OPTION_CONTENT_TYPES, []);
+    }
+
+    public function getMinified(string $html): string
+    {
+        if ($this->lib->load($html)) {
+            $options = $this->getOptions();
+            $this->lib->minify($options);
+            return $this->lib->html();
+        }
+        return $html;
+    }
+
+    private function getOptions(): array
+    {
+        return $this->kirby->option(self::OPTION_OPTIONS, []);
+    }
+}