Automated Drupal 10 compatibility fixes

Fixed other compatibility issues and improvements.
- Remove deprecated code
- Add return types
- Update hook_help

Performing further refactoring.
- Remove the jquery dependency in the ckeditor-readmore.js file and using vanilla js
- Remove preprocess hook that was attaching js with each page. Instead we are using filter plugin now.
It selectively attaches the js with the element.

@mohit_aghera Thanks for the Work

I have reviewed and tested patch #4, it applied cleanly and the CKEditor Read More module is now compatible with druapl 10 after applying the patch. I've attached a before and after screenshot for reference. Please check.

@Akshay kashyap
This is not a right approach to RTBC issues.
Here https://www.drupal.org/community/contributor-guide/task/review-a-patch-o... → are the detailed steps about how to perform the review.
False RTBC doesn't grant any issue credits.

It still needs a lot of work to make it fully compatible.
Switching it to needs review, since it needs inputs from maintainers.

Running

vendor/bin/phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml modules/ckeditor_readmore/     

PHP Warning:  Module "fileinfo" is already loaded in Unknown on line 0
PHP Warning:  Module "gd" is already loaded in Unknown on line 0
PHP Warning:  Module "gettext" is already loaded in Unknown on line 0

FILE: /home/gai/drupal-git/drupal/modules/ckeditor_readmore/ckeditor_readmore.module
------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
------------------------------------------------------------------------------------
 1 | ERROR   | [x] Missing file doc comment
 3 | WARNING | [x] Unused use statement
------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/ckeditor_readmore/src/Plugin/CKEditorPlugin/ReadMore.php
-------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AND 3 WARNINGS AFFECTING 11 LINES
-------------------------------------------------------------------------------------------------------------------
  20 | ERROR   | [x] Opening brace should be on the same line as the declaration
  78 | ERROR   | [x] Doc comment long description must end with a full stop
  86 | ERROR   | [x] Separate the @param and @return sections by a blank line.
 107 | ERROR   | [x] No space found before comment text; expected "// dd($settings);" but found "//dd($settings);"
 112 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
 115 | WARNING | [x] A comma should follow the last multiline array item. Found: )
 124 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
 127 | WARNING | [x] A comma should follow the last multiline array item. Found: )
 133 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
 136 | WARNING | [x] A comma should follow the last multiline array item. Found: )
 140 | ERROR   | [x] Expected 1 blank line after function; 0 found
-------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 11 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/ckeditor_readmore/src/Plugin/Filter/ReadMoreFilter.php
------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------
 14 | ERROR | [x] There must be exactly one blank line before the tags in a doc comment
------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/ckeditor_readmore/README.txt
----------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
----------------------------------------------------------------------
 12 | WARNING | Line exceeds 80 characters; contains 94 characters
 13 | WARNING | Line exceeds 80 characters; contains 297 characters
 18 | WARNING | Line exceeds 80 characters; contains 86 characters
 23 | WARNING | Line exceeds 80 characters; contains 97 characters
----------------------------------------------------------------------

Gettings errors need to fix

This patch is based on #4 ... when I tried that one, my "Read more" link printed out multiple times. I've refactored the JS so that it makes use of the drupal/once library. It now works as expected. Please review.

Fix a bug that preventing patch being applied.

Hello,

To be sure patch #11 is compatible ck4 or cke5 ?

Thanks,

The entire module is only compatible with CKE 4 as far as I know.

Hi @vanilla-bear
This patch and module is for CKEditor 4 only.

For CK5:
- First we need to port ckeditor plugin itself to CK5 plugin.
- Later we can tweak the things based on the requirements.

Hello, thank you for your response.

I am in the process of upgrading my site from Drupal 9 to Drupal 10. However, for now, I will stick with CKEditor 4 as it suits my needs perfectly.

If I can assist someone, I am using this method: https://www.drupal.org/docs/develop/git/using-gitlab-to-contribute-to-dr... →

Within the composer.json file:

    "repositories": {
        "drupal": {
            "type": "composer",
            "url": "https://packages.drupal.org/8",
            "exclude": [
                "drupal/ckeditor_readmore"
            ]
        },
        "fork-ckeditor-readmore": {
            "type": "git",
            "url": "https://git.drupalcode.org/issue/ckeditor_readmore-3296772.git"
        },
    },

Command for composer:

composer require drupal/ckeditor_readmore:dev-3296772-D10-ck4-11#1358e3215c31ebb1b893071b841abb03dd9d636c

This is why I created a fork and integrated your patch, @jaydee1818.

I have simply added a composer.json file at the root.

Thanks for your help.

Drupal 10 with CKEditor 5 support can be found in #3388400.

asherry → changed the visibility of the branch 3296772-D10-ck4-#11 to hidden.

asherry → changed the visibility of the branch 3296772-D10-ck4 to hidden.

This is an automated patch generated by Drupal Rector. Please see the issue summary for more details.

It is important that any automated tests available are run with this patch and that you manually test this patch.

Drupal 10 Compatibility

According to the Upgrade Status module → this patch makes this module compatible with Drupal 10! 🎉
Therefore this patch updates the info.yml file for Drupal 10 compatibility.

Leaving this issue open, even after committing the current patch, will allow the Project Update Bot → to post additional Drupal 10 compatibility fixes as they become available in Drupal Rector.

Debug info

This patch was created using these packages:

1. mglaman/phpstan-drupal: 1.2.4
2. palantirnet/drupal-rector: 0.18.3

I think we can close this issue.
All the changes from this issue are added in #3388400 ✨ CKEditor 5 Support Fixed

The other issue has all the changes related to Drupal 10 and contains CKEditor5 related compatibility fixes as well.

Thank you all for the support! :)
I merged the code from #3388400 ✨ CKEditor 5 Support Fixed and created the 3.0.0-alpha1 release.