Add the experimental HTML converter (#47)

* Update wptelegram-bot-api * Update wptelegram-bot-api * Add format-text library * Move wptelegram-bot-api to bot-api * Update format-text * Fix VS Code config * Update composer and PHPCS config * Update format-text * Add the experimental HTML converter * Update gulpfile.esm.js * Prepare for v3.2.0 Co-authored-by: irshadahmad21 <[email protected]>
wpsocio · Jan 19, 2023 · 9d02cab · 9d02cab
1 parent f5bc9ac
commit 9d02cab
Show file tree

Hide file tree

Showing 32 changed files with 194 additions and 85 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -10,7 +10,7 @@ jobs:
       - name: Checkout the commit
         uses: actions/checkout@v2
         with:
-          # Ensure to checkout wptelegram-bot-api submodule
+          # Ensure to checkout git submodules
           submodules: recursive
 
       # Remove everything except src/, .wordpress-org and .distignore

diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,6 @@
-[submodule "src/includes/wptelegram-bot-api"]
-	path = src/includes/wptelegram-bot-api
-	url = https://github.com/manzoorwanijk/wptelegram-bot-api.git
+[submodule "src/includes/bot-api"]
+	path = src/includes/bot-api
+	url = [email protected]:wpsocio/wptelegram-bot-api.git
+[submodule "src/includes/format-text"]
+	path = src/includes/format-text
+	url = [email protected]:wpsocio/wptelegram-format-text.git
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,3 +1,6 @@
 {
-	"recommendations": ["emeraldwalk.runonsave", "ikappas.phpcs", "bmewburn.vscode-intelephense-client"]
+	"recommendations": [
+		"wongjn.php-sniffer",
+		"bmewburn.vscode-intelephense-client",
+	]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,14 +1,7 @@
 {
-	"phpcs.standard": "${workspaceFolder}/phpcs.xml",
-	"emeraldwalk.runonsave": {
-		"commands": [
-			{
-				"match": "\\.php$",
-				"cmd": "\"vendor/bin/phpcbf\" --standard=phpcs.xml \"${file}\""
-			}
-		]
-	},
-	"[php]": {
-		"editor.formatOnSave": false
-	}
+    "[php]": {
+        "editor.defaultFormatter": "wongjn.php-sniffer",
+        "editor.formatOnSave": true
+    },
+    "phpSniffer.standard": "phpcs.xml",
 }
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 **Requires at least:** 5.8  
 **Requires PHP:** 7.0  
 **Tested up to:** 6.1.1  
-**Stable tag:** 3.1.15  
+**Stable tag:** 3.2.0  
 **License:** GPLv2 or later  
 **License URI:** [http://www.gnu.org/licenses/gpl-2.0.html](http://www.gnu.org/licenses/gpl-2.0.html)
 

diff --git a/changelog.md b/changelog.md
@@ -4,6 +4,13 @@ All notable changes to this project are documented in this file.
 
 ## Unreleased
 
+## [3.2.0 - 2023-01-19](https://github.com/wpsocio/wptelegram/releases/tag/v3.2.0)
+
+### Enhancements
+
+- Added the new experimental HTML converter for better formatting of email notifications
+- The new can be enabled using `add_filter( 'wptelegram_notify_use_experimental_text', '__return_true' );`
+
 ## [3.1.15 - 2023-01-5](https://github.com/wpsocio/wptelegram/releases/tag/v3.1.15)
 
 ### Bug fixes

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
 	"name": "wptelegram/core",
-	"version": "3.1.15",
+	"version": "3.2.0",
 	"description": "Integrate your WordPress site perfectly with Telegram with full control.",
 	"require-dev": {
 		"dealerdirect/phpcodesniffer-composer-installer": "*",
@@ -17,7 +17,7 @@
 			"\"vendor/bin/phpcs\" --config-set installed_paths ../../../vendor/wp-coding-standards/wpcs",
 			"\"vendor/bin/phpcs\" --config-set default_standard WordPress"
 		],
-		"lint": "\"vendor/bin/phpcs\" --ignore=src/assets/*,src/languages/*,*/index.php,src/includes/html2text/* src/",
+		"lint": "\"vendor/bin/phpcs\" --ignore=src/assets/*,src/languages/*,*/index.php,src/includes/html2text/*,src/includes/format-text/* src/",
 		"lint:skip-warnings": "\"vendor/bin/phpcs\" -n",
 		"lint:fix": "\"vendor/bin/phpcbf\" --standard=phpcs.xml --ignore=src/assets/*,src/languages/*,*/index.php,src/includes/html2text/* src/"
 	},

diff --git a/gulpfile.esm.js b/gulpfile.esm.js
@@ -201,7 +201,7 @@ const createVersionUpdateCB = (forFile, version) => {
 			patterns = [/Version:\s*(\d+\.\d+\.\d+)/i, new RegExp("'" + versionConst + "',\\s*'(\\d+\\.\\d+\\.\\d+)'")];
 			break;
 		case 'since-xyz':
-			patterns = [/@since[\s\t]*(x\.y\.z)/gi];
+			patterns = [/@since[\s\t]*(x\.y\.z)/gi, /((?:since:)x\.y\.z)/gi];
 			break;
 	}
 	return through2.obj(function (file, _, cb) {

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "wptelegram",
 	"title": "WP Telegram",
-	"version": "3.1.15",
+	"version": "3.2.0",
 	"description": "Integrate your WordPress site perfectly with Telegram with full control.",
 	"repository": {
 		"type": "git",

diff --git a/phpcs.xml b/phpcs.xml
@@ -1,24 +1,29 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <ruleset name="WPTelegram">
 
-     <!-- Enable colors in report -->
-     <arg name="colors"/>
+	<!-- Enable colors in report -->
+	<arg name="colors" />
 
-     <!-- Add source codes in the report -->
-     <arg value="s"/>
+	<!-- Add source codes in the report -->
+	<arg value="s" />
 
-     <!-- Load WordPress Coding standards -->
-     <rule ref="WordPress"/>
+	 <exclude-pattern>*/includes/format-text/*</exclude-pattern>
+	 <exclude-pattern>*/includes/html2text/*</exclude-pattern>
 
-     <!-- Customize -->
-     <rule ref="WordPress">
-          <!-- Disable File Name warning -->
-          <exclude name="WordPress.Files.FileName" />
-          <!-- Disable short array syntax warning -->
-          <exclude name="Generic.Arrays.DisallowShortArraySyntax" />
-     </rule>
-     <!-- Disallow Long Array Syntax -->
-     <rule ref="Generic.Arrays.DisallowLongArraySyntax.Found">
-          <type>warning</type>
-     </rule>
+	<!-- Load WordPress Coding standards -->
+	<rule ref="WordPress" />
+
+	<!-- Customize -->
+	<rule ref="WordPress">
+		<!-- Disable File Name warning -->
+		<exclude name="WordPress.Files.FileName" />
+
+		<!-- Disable short array syntax warning -->
+		<exclude name="Generic.Arrays.DisallowShortArraySyntax" />
+	</rule>
+
+	<!-- Disallow Long Array Syntax -->
+	<rule ref="Generic.Arrays.DisallowLongArraySyntax.Found">
+		<type>warning</type>
+	</rule>
 </ruleset>
diff --git a/src/README.txt b/src/README.txt
@@ -5,7 +5,7 @@ Tags: telegram, notifications, posts, channel, group
 Requires at least: 5.8
 Tested up to: 6.1.1
 Requires PHP: 7.0
-Stable tag: 3.1.15
+Stable tag: 3.2.0
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
@@ -205,6 +205,10 @@ Yes, all you need to do is to setup **Private Notifications** module and use the
 
 == Changelog ==
 
+= 3.2.0 =
+- Added the new experimental HTML converter for better formatting of email notifications
+- The new can be enabled using `add_filter( 'wptelegram_notify_use_experimental_text', '__return_true' );`
+
 = 3.1.15 =
 - Fixed PHP warning when not using message thread ID
 

diff --git a/src/changelog.md b/src/changelog.md
@@ -4,6 +4,13 @@ All notable changes to this project are documented in this file.
 
 ## Unreleased
 
+## [3.2.0 - 2023-01-19](https://github.com/wpsocio/wptelegram/releases/tag/v3.2.0)
+
+### Enhancements
+
+- Added the new experimental HTML converter for better formatting of email notifications
+- The new can be enabled using `add_filter( 'wptelegram_notify_use_experimental_text', '__return_true' );`
+
 ## [3.1.15 - 2023-01-5](https://github.com/wpsocio/wptelegram/releases/tag/v3.1.15)
 
 ### Bug fixes

diff --git a/src/includes/Main.php b/src/includes/Main.php
@@ -196,7 +196,12 @@ private function load_dependencies() {
 		/**
 		 * The class responsible for loading \WPTelegram\BotAPI library
 		 */
-		require_once $this->dir( '/includes/wptelegram-bot-api/src/index.php' );
+		require_once $this->dir( '/includes/bot-api/src/index.php' );
+
+		/**
+		 * The class responsible for loading \WPTelegram\FormatText library
+		 */
+		require_once $this->dir( '/includes/format-text/autoload-wp.php' );
 
 		/**
 		 * The library responsible for converting HTML to plain text

diff --git a/src/includes/bot-api b/src/includes/bot-api
diff --git a/src/includes/format-text b/src/includes/format-text
diff --git a/src/includes/wptelegram-bot-api b/src/includes/wptelegram-bot-api
diff --git a/src/languages/wptelegram-ar.po b/src/languages/wptelegram-ar.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 01:37+0530\n"
 "Last-Translator: \n"
 "Language-Team: WPTelegram\n"
@@ -29,7 +29,7 @@ msgid ""
 "and do lot more :)"
 msgstr ""
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""
 

diff --git a/src/languages/wptelegram-ca.po b/src/languages/wptelegram-ca.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 01:37+0530\n"
 "Last-Translator: \n"
 "Language-Team: WPTelegram\n"
@@ -29,7 +29,7 @@ msgid ""
 "and do lot more :)"
 msgstr ""
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""
 

diff --git a/src/languages/wptelegram-de_DE.po b/src/languages/wptelegram-de_DE.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 01:37+0530\n"
 "Last-Translator: Robert Skiba <[email protected]>\n"
 "Language-Team: Deutsch\n"
@@ -30,7 +30,7 @@ msgstr ""
 "Mit diesem Plugin kann man Posts an Telegram senden, Benachrichtigungen "
 "erhalten und vieles mehr :)"
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""
 

diff --git a/src/languages/wptelegram-es_ES.po b/src/languages/wptelegram-es_ES.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 01:37+0530\n"
 "Last-Translator: Robert Skiba <[email protected]>\n"
 "Language-Team: Deutsch\n"
@@ -28,7 +28,7 @@ msgid ""
 "and do lot more :)"
 msgstr ""
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""
 

diff --git a/src/languages/wptelegram-fa_IR.po b/src/languages/wptelegram-fa_IR.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 02:02+0530\n"
 "Last-Translator: \n"
 "Language-Team: Taktaweb Group <[email protected]>\n"
@@ -31,7 +31,7 @@ msgstr ""
 "با این افزونه، شما می توانید نوشته‌ها را به تلگرام بفرستید و اعلان دریافت "
 "کنید و کلی کارهای دیگه انجام بدید :)"
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""
 

diff --git a/src/languages/wptelegram-id_ID.po b/src/languages/wptelegram-id_ID.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 01:59+0530\n"
 "Last-Translator: \n"
 "Language-Team: WPTelegram\n"
@@ -30,7 +30,7 @@ msgstr ""
 "Dengan plugin ini, Anda dapat mengirim posting ke Telegram dan menerima "
 "notifikasi dan melakukan lebih banyak lagi :)"
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""
 

diff --git a/src/languages/wptelegram-it_IT.po b/src/languages/wptelegram-it_IT.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-21 12:14+0530\n"
 "Last-Translator: \n"
 "Language-Team: WPTelegram\n"
@@ -30,7 +30,7 @@ msgstr ""
 "Con questo plugin puoi spedire i tuoi articoli a Telegram, ricevere "
 "notifiche e molto altro :)"
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr "WP Telegram"
 

diff --git a/src/languages/wptelegram-pl_PL.po b/src/languages/wptelegram-pl_PL.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 02:09+0530\n"
 "Last-Translator: \n"
 "Language-Team: Polski\n"
@@ -34,7 +34,7 @@ msgstr ""
 "Dzięki tej wtyczce możesz wysyłać posty do Telegrama, otrzymywać "
 "powiadomienia i robić wiele więcej :)"
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""
 

diff --git a/src/languages/wptelegram-pt_BR.po b/src/languages/wptelegram-pt_BR.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 02:11+0530\n"
 "Last-Translator: \n"
 "Language-Team: WPTelegram\n"
@@ -28,7 +28,7 @@ msgid ""
 "and do lot more :)"
 msgstr ""
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""
 

diff --git a/src/languages/wptelegram-ru_RU.po b/src/languages/wptelegram-ru_RU.po
@@ -3,7 +3,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: WP Telegram - Stable\n"
 "Report-Msgid-Bugs-To: https://github.com/wpsocio/wptelegram\n"
-"POT-Creation-Date: 2022-12-08 11:44:38+00:00\n"
+"POT-Creation-Date: 2023-01-19 15:14:07+00:00\n"
 "PO-Revision-Date: 2021-03-14 02:21+0530\n"
 "Last-Translator: \n"
 "Language-Team: WPTelegram\n"
@@ -31,7 +31,7 @@ msgstr ""
 "С помощью этого плагина вы можете отправлять сообщения в Telegram, получать "
 "уведомления и делать многое другое :)"
 
-#: includes/Main.php:314
+#: includes/Main.php:319
 msgid "WP Telegram"
 msgstr ""