Merge pull request #3 from programmatordev/1.x

v0.2.0

Author: andrepimpao

.ddev/config.yaml

@@ -20,27 +20,31 @@ disable_upload_dirs_warning: true
 
 # name: <projectname> # Name of the project, automatically provides
 #   http://projectname.ddev.site and https://projectname.ddev.site
+# If the name is omitted, the project will take the name of the enclosing directory,
+# which is useful if you want to have a copy of the project side by side with this one.
 
 # type: <projecttype>  # backdrop, cakephp, craftcms, drupal, drupal6, drupal7, drupal8, drupal9, drupal10, drupal11, generic, laravel, magento, magento2, php, shopware6, silverstripe, symfony, typo3, wordpress
-# See https://ddev.readthedocs.io/en/stable/users/quickstart/ for more
+# See https://docs.ddev.com/en/stable/users/quickstart/ for more
 # information on the different project types
 
 # docroot: <relative_path> # Relative path to the directory containing index.php.
 
-# php_version: "8.3"  # PHP version to use, "5.6" through "8.4"
+# php_version: "8.3"  # PHP version to use, "5.6" through "8.5"
 
 # You can explicitly specify the webimage but this
 # is not recommended, as the images are often closely tied to DDEV's' behavior,
 # so this can break upgrades.
 
-# webimage: <docker_image>  # nginx/php docker image.
+# webimage: <docker_image>
+# It’s unusual to change this option, and we don’t recommend it without Docker experience and a good reason.
+# Typically, this means additions to the existing web image using a .ddev/web-build/Dockerfile.*
 
 # database:
 #   type: <dbtype> # mysql, mariadb, postgres
 #   version: <version> # database version, like "10.11" or "8.0"
-#   MariaDB versions can be 5.5-10.8, 10.11, and 11.4.
-#   MySQL versions can be 5.5-8.0.
-#   PostgreSQL versions can be 9-17.
+#   MariaDB versions can be 5.5-10.8, 10.11, 11.4, 11.8
+#   MySQL versions can be 5.5-8.0, 8.4
+#   PostgreSQL versions can be 9-18
 
 # router_http_port: <port>  # Port to be used for http (defaults to global configuration, usually 80)
 # router_https_port: <port> # Port for https (defaults to global configuration, usually 443)
@@ -50,24 +54,16 @@ disable_upload_dirs_warning: true
 # "ddev xdebug" to enable Xdebug and "ddev xdebug off" to disable it work better,
 # as leaving Xdebug enabled all the time is a big performance hit.
 
-# xhgui_https_port: 8142
-# Can be used to change the router https port for xhgui application
+# xhgui_http_port: "8143"
+# xhgui_https_port: "8142"
+# The XHGui ports can be changed from the default 8143 and 8142
 # Very rarely used
 
-# xhgui_http_port: 8143
-# Can be used to change the router http port for xhgui application
-# Very rarely used
-
-# host_xhgui_port: 8142
-# Can be used to change the host binding port of the xhgui
-# application. Rarely used; only when port conflict and 
+# host_xhgui_port: "8142"
+# Can be used to change the host binding port of the XHGui
+# application. Rarely used; only when port conflict and
 # bind_all_ports is used (normally with router disabled)
 
-# xhprof_enabled: false  # Set to true to enable Xhprof and "ddev start" or "ddev restart"
-# Note that for most people the commands
-# "ddev xhprof" to enable Xhprof and "ddev xhprof off" to disable it work better,
-# as leaving Xhprof enabled all the time is a big performance hit.
-
 # xhprof_mode: [prepend|xhgui|global]
 # Set to "xhgui" to enable XHGui features
 # "xhgui" will become default in a future major release
@@ -100,7 +96,7 @@ disable_upload_dirs_warning: true
 
 # nodejs_version: "22"
 # change from the default system Node.js version to any other version.
-# See https://ddev.readthedocs.io/en/stable/users/configuration/config/#nodejs_version for more information
+# See https://docs.ddev.com/en/stable/users/configuration/config/#nodejs_version for more information
 # and https://www.npmjs.com/package/n#specifying-nodejs-versions for the full documentation,
 # Note that using of 'ddev nvm' is discouraged because "nodejs_version" is much easier to use,
 # can specify any version, and is more robust than using 'nvm'.
@@ -136,7 +132,7 @@ disable_upload_dirs_warning: true
 
 # ddev_version_constraint: ""
 # Example:
-# ddev_version_constraint: ">= 1.22.4"
+# ddev_version_constraint: ">= 1.24.8"
 # This will enforce that the running ddev version is within this constraint.
 # See https://github.com/Masterminds/semver#checking-version-constraints for
 # supported constraint formats
@@ -165,8 +161,8 @@ disable_upload_dirs_warning: true
 #   - "mutagen": enables Mutagen for this project.
 #   - "nfs":     enables NFS for this project.
 #
-# See https://ddev.readthedocs.io/en/stable/users/install/performance/#nfs
-# See https://ddev.readthedocs.io/en/stable/users/install/performance/#mutagen
+# See https://docs.ddev.com/en/stable/users/install/performance/#nfs
+# See https://docs.ddev.com/en/stable/users/install/performance/#mutagen
 
 # fail_on_hook_fail: False
 # Decide whether 'ddev start' should be interrupted by a failing hook
@@ -215,7 +211,7 @@ disable_upload_dirs_warning: true
 
 # ngrok_args: --basic-auth username:pass1234
 # Provide extra flags to the "ngrok http" command, see
-# https://ngrok.com/docs/ngrok-agent/config or run "ngrok http -h"
+# https://ngrok.com/docs/agent/config/v3/#agent-configuration or run "ngrok http -h"
 
 # disable_settings_management: false
 # If true, DDEV will not create CMS-specific settings files like
@@ -293,7 +289,7 @@ disable_upload_dirs_warning: true
 # Many DDEV commands can be extended to run tasks before or after the
 # DDEV command is executed, for example "post-start", "post-import-db",
 # "pre-composer", "post-composer"
-# See https://ddev.readthedocs.io/en/stable/users/extend/custom-commands/ for more
+# See https://docs.ddev.com/en/stable/users/extend/custom-commands/ for more
 # information on the commands that can be extended and the tasks you can define
 # for them. Example:
 #hooks:

README.md

@@ -1,6 +1,6 @@
 # Kinky
 
-[Inky](https://get.foundation/emails/docs/inky.html) email templating language for [Kirby CMS](https://getkirby.com/).
+[Kirby](https://getkirby.com/) + [Inky](https://get.foundation/emails/docs/inky.html) = Kinky.
 
 Converts simple HTML tags into the complex table required for emails. Oh là là!
 
@@ -97,7 +97,7 @@ Transformed HTML (clean example without the whole document and CSS inlining):
 
 - PHP `8.2` or higher;
 - PHP [`dom`](http://www.php.net/manual/en/dom.installation.php) extension;
-- Kirby CMS `4.0` or higher.
+- Kirby CMS `5.0` or higher.
 
 ## Installation
 
@@ -130,7 +130,7 @@ This method can be useful to help creating and previewing email templates:
 ```php
 // templates/default.php
 
-// template will be located at /site/templates/emails/notification.html.php
+// the template will be located at /site/templates/emails/notification.html.php
 <?= kinky()->transformTemplate('notification', [
     'name' => 'Kinky',
     'text' => 'Oh là là'
@@ -162,7 +162,7 @@ kinky()->email([
 ]);
 ```
 
-It is basically the sames as doing the following:
+It is basically the same as doing the following:
 
 ```php
 kirby()->email([
@@ -185,7 +185,7 @@ kirby()->email([
 
 ### Custom CSS
 
-To use your own custom CSS, you can just include a `<style>` element in the template and all selectors will be inlined for you.
+To use your own custom CSS, you can include a `<style>` element in the template and all selectors will be inlined for you.
 
 Template:
 

composer.json

@@ -3,7 +3,7 @@
   "description": "Inky email templating language for Kirby CMS",
   "type": "kirby-plugin",
   "license": "MIT",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "keywords": ["kirby", "kirby-cms", "kirby-plugin", "inky", "email", "email-template"],
   "homepage": "https://github.com/programmatordev/kinky",
   "support": {
@@ -12,21 +12,21 @@
   },
   "authors": [
     {
-      "name": "André Pimpão",
-      "email": "a.pimpao@programmator.dev",
+      "name": "Programmator",
+      "email": "hotline@programmator.dev",
       "homepage": "https://programmator.dev"
     }
   ],
   "require": {
     "php": ">=8.2.0",
     "getkirby/composer-installer": "^1.2",
     "lorenzo/pinky": "^1.1",
-    "tijsverkoyen/css-to-inline-styles": "^2.3",
+    "tijsverkoyen/css-to-inline-styles": "^2.4",
     "ext-dom": "*"
   },
   "require-dev": {
-    "getkirby/cms": "^4.7",
-    "symfony/var-dumper": "^7.2"
+    "getkirby/cms": "^5.0",
+    "symfony/var-dumper": "^7.4"
   },
   "autoload": {
     "psr-4": {

src/Kinky.php

@@ -56,12 +56,12 @@ private function buildEmailProps(array $props): array
             throw new InvalidArgumentException('The property "template" is required');
         }
 
-        // set body with transpiled template
-        // important: do not run transformTemplate directly in props or email will be triggered twice for some reason
+        // set the body with the transpiled template
+        // important: do not run transformTemplate directly in props, or the email will be triggered twice for some reason
         $bodyHtml = $this->transformTemplate($template, $data);
         $props['body']['html'] = $bodyHtml;
 
-        // template property must be removed from props at this point
+        // template property must be removed from props at this point,
         // otherwise kirby will ignore the body property
         unset($props['template']);
 
@@ -87,7 +87,7 @@ private function transformHtml(string $html): string
         // transpile Inky template
         $document = Pinky\transformString($html);
 
-        // create Content-Type <meta> element so charset is detected correctly when inlining CSS
+        // create a Content-Type <meta> element so charset is detected correctly when inlining CSS
         // https://github.com/tijsverkoyen/CssToInlineStyles?tab=readme-ov-file#known-issues
         $metaContentTypeElement = $document->createElement('meta');
         $metaContentTypeElement->setAttribute('http-equiv', 'Content-Type');
@@ -100,13 +100,13 @@ private function transformHtml(string $html): string
 
         // get Inky base CSS to inject in HTML
         $inkyCss = F::read(__DIR__ . '/../assets/styles/foundation-emails.css');
-        // create <style> element with Inky base CSS
+        // create a <style> element with Inky base CSS
         $styleElement = $document->createElement('style', sprintf("\n%s", $inkyCss));
 
         // prepend the <meta> and <style> elements to the document
         // this may seem a little bit weird to add <head> specific elements directly in the document,
         // but the transpiler and inliner will automatically wrap <meta> and <style> elements in a <head> element,
-        // so there is no need to do it ourselves, and opens the possibility to include custom <style>s directly in the template
+        // so there is no need to do it ourselves, and opens the possibility to include a custom <style> directly in the template
         $document->documentElement->prepend($metaContentTypeElement, $metaViewportElement, $styleElement);
 
         // inline Inky base CSS (for best results in Gmail and Outlook)