chore: prepping for release

Author: matdave

README.md

@@ -1,37 +1,25 @@
 # TinyMCE Rich Text Editor
 
-TinyMCE 5 for MODX Revolution
+TinyMCE 6 for MODX Revolution
 
 ## Features
 
 TinyMCE is a platform independent web based Javascript HTML WYSIWYG editor. It
 allows non-technical users to format content without knowing how to code. This
-package is based on the TinyMCE 5.
+package is based on the TinyMCE 6.
 
 To build and install the package from source you have to use [Git Package
-Management](https://github.com/TheBoxer/Git-Package-Management). The GitHub
+Management (GPM)](https://github.com/TheBoxer/Git-Package-Management). The GitHub
 repository of TinyMCE Rich Text Editor contains a
-[config.json](https://github.com/modxcms/tinymce-rte/blob/tinymce5/_build/config.json)
+[config.json](https://github.com/modxcms/tinymce-rte/blob/main/_build/config.json)
 to build that package locally. Use this option, if you want to debug TinyMCE
 Rich Text Editor and/or contribute bugfixes and enhancements.
 
-To update the TinyMCE core, you have to change the `tinymce_version` property in
-the `gulpfile.js` and run the `gulp update` task afterwards. This task will
-prepare all needed files in `assets/components/tinymcerte`. Please check, wether
-the TinyMCE image and link plugins are changed in the new version of TinyMCE and
-adopt the changes in the `src/modx/plugins` files and run the `gulp prepare`
-task afterwards.
-
-To modify the MODX skin, you have to open the [TinyMCE 5 Skin
-Tool](http://skin.tiny.cloud/t5/) and upload the current
-[skintool.json](https://github.com/modxcms/tinymce-rte/blob/tinymce5/src/modx/skintool.json).
-After modifying the skin, you must click on `Get Skin` and replace the skin
-folder in the src/modx folder with the extracted downloaded skin folder. Then
-you should run the `gulp update` task. This task will prepare all needed files
-in `assets/components/tinymcerte`.
-
-There is a `gulp prepare-debug` task, that copies not uglyfied script files to
-`assets/components/tinymcerte`.
+To update the plugin run `npm install` to install the dependencies. Run 
+`npm run build` to build the plugin. The source files are located in the `/src/`
+directory. The package is compiled using Node 20.
+
+To update the TinyMCE core, you have to change the `tinymcerte.tiny_url` system setting.
 
 ## Change Log
 https://github.com/modxcms/tinymce-rte/blob/master/core/components/tinymcerte/docs/changelog.md

_build/config.json

@@ -1,9 +1,9 @@
 {
   "name": "TinyMCE Rich Text Editor",
   "lowCaseName": "tinymcerte",
-  "description": "TinyMCE 5",
+  "description": "TinyMCE 6",
   "author": "John Peca/Thomas Jakobi",
-  "version": "3.0.0-beta2",
+  "version": "3.0.0",
   "package": {
     "elements": {
       "plugins": [
@@ -124,19 +124,24 @@
         "value": "500",
         "area": "tinymcerte.default"
       },
+      {
+        "key": "min_height",
+        "value": "100",
+        "area": "tinymcerte.default"
+      },
       {
         "key": "insert_toolbar",
         "value": "image media quicktable modxlink modai_generate",
         "area": "tinymcerte.toolbar"
       },
       {
         "key": "selection_toolbar",
-        "value": "bold italic underline | modxlink | h2 h3 h4 blockquote | modai_generate modai_enhance",
+        "value": "bold italic underline | modxlink | modai_enhance",
         "area": "tinymcerte.toolbar"
       },
       {
         "key": "toolbar1",
-        "value": "undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | modxlink | image",
+        "value": "undo redo | styleselect | bold italic underline | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | modxlink | image",
         "area": "tinymcerte.toolbar"
       },
       {
@@ -196,6 +201,11 @@
         "area": "modai",
         "type": "textarea",
         "value": "- This is not a conversation, do not include justifcation, suggestions, or explanation\n- The output should be usable as is, without requiring editing or modification\n- Format it with HTML markup so it will work in the TinyMCE rich text editor"
+      },
+      {
+        "key": "tiny_url",
+        "area": "tinymcerte.default",
+        "value": "https://cdnjs.cloudflare.com/ajax/libs/tinymce/6.8.5/tinymce.min.js"
       }
     ]
   },

_build/resolvers/resolve.update.php

@@ -238,9 +238,17 @@ function cleanupPlugin($modx, $name)
                 addToSetting($modx, 'tinymcerte.toolbar1', '| modai_generate modai_generate_image modai_enhance');
             }
 
-            if ($oldPackage && $oldPackage->compareVersion('2.1.1-pl', '>')) {
-                removeFromSetting($modx, 'tinymcerte.toolbar1', 'modai_generate_image');
-            }
+        if ($oldPackage && $oldPackage->compareVersion('2.1.1-pl', '>')) {
+            removeFromSetting($modx, 'tinymcerte.toolbar1', 'modai_generate_image');
+        }
+
+        if ($oldPackage && $oldPackage->compareVersion('2.1.1-pl', '>')) {
+            addToSetting($modx, 'tinymcerte.plugins', 'quickbars');
+            changeSetting($modx, 'skin', 'modx', 'oxide');
+            changeSetting($modx, 'tinymcerte.toolbar1', 'link', 'modxlink');
+            changeSetting($modx, 'tinymcerte.toolbar2', 'link', 'modxlink');
+            changeSetting($modx, 'tinymcerte.toolbar3', 'link', 'modxlink');
+        }
 
             break;
     }

core/components/tinymcerte/docs/changelog.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.0] - 2025-05-29
+
+### Changed
+
+- Refactored the project to use TinyMCE 6
+
 ## [2.1.1] - 2025-03-21
 
 ### Changed

core/components/tinymcerte/docs/readme.md

@@ -1,9 +1,10 @@
 # TinyMCE Rich Text Editor
 
-TinyMCE 5 for MODX Revolution.
+TinyMCE 6 for MODX Revolution.
 
 - Author: John Peca <john@modx.com>
 - Upgrade to TinyMCE 5: Thomas Jakobi <office@treehillstudio.com>
+- Upgrade to TinyMCE 6: Mat Dave Jones <mat@modx.com>
 - License: GNU GPLv2
 
 ## Features

core/components/tinymcerte/lexicon/en/setting.inc.php

@@ -34,7 +34,9 @@
 $_lang['setting_tinymcerte.links_across_contexts'] = 'Links across contexts';
 $_lang['setting_tinymcerte.links_across_contexts_desc'] = 'Lists resources from other contexts when creating internal links in the editor. Otherwise only Resources from the same context appear.';
 $_lang['setting_tinymcerte.max_height'] = 'Max height';
-$_lang['setting_tinymcerte.max_height_desc'] = 'The max_height option has two kinds of behaviors depending on the state of the autoresize plugin. Without the autoresize plugin, this option allows you to set the maximum height that a user can stretch the entire TinyMCE interface (by grabbing the dragable area in the bottom right of the editor interface). With the autoresize plugin, this option sets the maximum height the editor can automatically expand to.';
+$_lang['setting_tinymcerte.max_height_desc'] = 'The max_height option has two kinds of behaviors depending on the state of the autoresize plugin. Without the autoresize plugin, this option allows you to set the maximum height that a user can stretch the entire TinyMCE interface (by grabbing the draggable area in the bottom right of the editor interface). With the autoresize plugin, this option sets the maximum height the editor can automatically expand to.';
+$_lang['setting_tinymcerte.min_height'] = 'Min height';
+$_lang['setting_tinymcerte.min_height_desc'] = 'The min_height option has two kinds of behaviors depending on the state of the autoresize plugin. Without the autoresize plugin, this option allows you to set the minimum height that a user can shrink the entire TinyMCE interface (by grabbing the draggable area in the bottom right of the editor interface). With the autoresize plugin, this option sets the minimum height the editor can automatically shrink to.';
 $_lang['setting_tinymcerte.menubar'] = 'Menubar';
 $_lang['setting_tinymcerte.menubar_desc'] = 'This option allows you to configure the menus you want to appear in the menu bar. <a href="https://www.tiny.cloud/docs/configure/editor-appearance/#menubar">https://www.tiny.cloud/docs/configure/editor-appearance/#menubar</a>';
 $_lang['setting_tinymcerte.modai.global.text.base_prompt'] = 'Base Prompt';
@@ -69,3 +71,9 @@
 $_lang['setting_tinymcerte.toolbar3_desc'] = 'This controls what buttons you want show up in the toolbar. <a href="https://www.tiny.cloud/docs/configure/editor-appearance/#toolbar">https://www.tiny.cloud/docs/configure/editor-appearance/#toolbar</a>';
 $_lang['setting_tinymcerte.valid_elements'] = 'Valid elements';
 $_lang['setting_tinymcerte.valid_elements_desc'] = 'This option defines which elements will remain in the edited text when the editor saves. You can use this to limit the returned HTML to a subset. <a href="https://www.tiny.cloud/docs/configure/content-filtering/#valid_elements">https://www.tiny.cloud/docs/configure/content-filtering/#valid_elements</a>.';
+$_lang['setting_tinymcerte.selection_toolbar'] = 'Selection Toolbar';
+$_lang['setting_tinymcerte.selection_toolbar_desc'] = 'This option defines what is shown in the toolbar when selecting text. <a href="https://www.tiny.cloud/docs/tinymce/latest/quickbars/#quickbars_selection_toolbar">https://www.tiny.cloud/docs/tinymce/latest/quickbars/#quickbars_selection_toolbar</a>.';
+$_lang['setting_tinymcerte.insert_toolbar'] = 'Insert Toolbar';
+$_lang['setting_tinymcerte.insert_toolbar_desc'] = 'This option defines what is shown in the toolbar when the cursor is at the start of an empty line. <a href="https://www.tiny.cloud/docs/tinymce/latest/quickbars/#quickbars_insert_toolbar">https://www.tiny.cloud/docs/tinymce/latest/quickbars/#quickbars_insert_toolbar</a>.';
+$_lang['setting_tinymcerte.tiny_url'] = 'TinyMCE URL';
+$_lang['setting_tinymcerte.tiny_url_desc'] = 'The URL or path to the TinyMCE JavaScript file.';

core/components/tinymcerte/src/Plugins/Events/OnRichTextEditorInit.php

@@ -50,7 +50,7 @@ public function process()
      */
     private function initTinyMCE()
     {
-        $this->modx->controller->addJavascript('https://cdnjs.cloudflare.com/ajax/libs/tinymce/6.8.5/tinymce.min.js');
+        $this->modx->controller->addJavascript($this->tinymcerte->getOption('tiny_url'));
         $this->modx->controller->addJavascript($this->tinymcerte->getOption('assetsUrl') . 'mgr/tinymcerte.min.js?v=' . $this->tinymcerte->version);
         $this->modx->controller->addCss($this->tinymcerte->getOption('assetsUrl') . 'mgr/tinymcerte.css?v=' . $this->tinymcerte->version);
 
@@ -109,10 +109,10 @@ private function getTinyConfig()
         }
 
         $config = array_merge([
-            'plugins' => $this->tinymcerte->getOption('plugins', [], 'advlist autoresize autolink lists charmap preview anchor visualblocks searchreplace code fullscreen insertdatetime media table image quickbars link modxlink modai'),
+            'plugins' => $this->tinymcerte->getOption('plugins', [], 'advlist autoresize autolink lists charmap preview anchor visualblocks searchreplace code fullscreen insertdatetime media table image quickbars modxlink modai'),
             'quickbars_insert_toolbar' => $this->tinymcerte->getOption('insert_toolbar', [], 'image media quicktable modxlink modai_generate'),
-            'quickbars_selection_toolbar' => $this->tinymcerte->getOption('selection_toolbar', [], 'bold italic underline | modxlink h2 h3 h4 blockquote | modai_generate modai_enhance'),
-            'toolbar1' => $this->tinymcerte->getOption('toolbar1', [], 'undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image | modai_generate modai_generate_image modai_enhance'),
+            'quickbars_selection_toolbar' => $this->tinymcerte->getOption('selection_toolbar', [], 'bold italic underline | modxlink | modai_enhance'),
+            'toolbar1' => $this->tinymcerte->getOption('toolbar1', [], 'undo redo | styleselect | bold italic underline | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | modxlink | image'),
             'toolbar2' => $this->tinymcerte->getOption('toolbar2', [], ''),
             'toolbar3' => $this->tinymcerte->getOption('toolbar3', [], ''),
             'connector_url' => $this->tinymcerte->getOption('connectorUrl'),
@@ -135,6 +135,7 @@ private function getTinyConfig()
             'entity_encoding' => $this->tinymcerte->getOption('entity_encoding', [], 'named'),
             'enable_link_list' => $this->tinymcerte->getOption('enable_link_list', [], true) == 1,
             'max_height' => (int)$this->tinymcerte->getOption('max_height', [], 500),
+            'min_height' => (int)$this->tinymcerte->getOption('min_height', [], 100),
             'branding' => $this->tinymcerte->getOption('branding', [], false) == 1,
             'cache_suffix' => '?v=' . $this->tinymcerte->version,
             'promotion' => false