Coding Standard Issues

Created on 29 November 2024, 19 days ago

Problem/Motivation

Currently, the module contains inconsistencies in code formatting that do not adhere to the Drupal Coding Standards (Drupal Coding Standards and DrupalPractice). These inconsistencies make the code less readable and can create challenges during code review, in addition to impacting long-term maintainability.

The motivation for this issue is to align the module's code with the recommended standards, making it easier for the community to contribute and ensuring the code is clearer, more maintainable, and compatible with static analysis tools.

By implementing these changes, the module will better align with the Drupal community’s policies, and the effort required for future updates or reviews will be reduced.

Steps to reproduce

  1. Clone the repo
  2. cd search_api_attachments
  3. run phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml,css .

Proposed resolution

Fix reported errors and warnings

FILE                                                  ERRORS  WARNINGS
----------------------------------------------------------------------
...ontrib/search_api_attachments/coding_standard.txt  1       0
.../modules/contrib/search_api_attachments/README.md  0       1
...ch_api_attachments/search_api_attachments.api.php  2       0
...rch_api_attachments/search_api_attachments.module  9       0
...h_api_attachments/src/TextExtractorPluginBase.php  3       0
...ttachments/src/Form/TextExtractorFormSettings.php  1       2
...src/Plugin/Field/FieldFormatter/ExtractedText.php  1       0
...chments/src/Plugin/QueueWorker/ExtractorQueue.php  1       0
...rc/Plugin/search_api/processor/FilesExtractor.php  5       0
...search_api_attachments/PythonPdf2txtExtractor.php  1       0
...c/Plugin/search_api_attachments/TikaExtractor.php  1       1
...in/search_api_attachments/TikaServerExtractor.php  4       2
...ch_api_attachments/tests/src/Unit/ExtractBody.php  3       0
----------------------------------------------------------------------
A TOTAL OF 32 ERRORS AND 6 WARNINGS WERE FOUND IN 13 FILES

Remaining tasks

User interface changes

API changes

Data model changes

πŸ“Œ Task
Status

Active

Version

9.0

Component

Code

Created by

πŸ‡¨πŸ‡΄Colombia ismaelromero Somewhere in the exotic Colombia

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024