Fix the issues reported by phpcs

Issue was unassigned.
Status changed to Needs work almost 2 years ago6:17pm 17 January 2023
First commit to issue fork.
Comment almost 2 years ago →
🇮🇳India himanshu_jhaloya Indore
#13 patch not applying.
Assigned to surya pratap
Comment almost 2 years ago →
🇮🇳India surya pratap
Issue was unassigned.
Status changed to Needs review almost 2 years ago11:26am 9 February 2023
Comment almost 2 years ago →
🇮🇳India surya pratap
Patch applied please review
Assigned to sidharth_soman
Comment almost 2 years ago →
🇮🇳India sidharth_soman Bangalore
Issue was unassigned.
Status changed to Needs work almost 2 years ago1:01pm 9 February 2023
Comment almost 2 years ago →
🇮🇳India sidharth_soman Bangalore
phpcs_issue_3328996-14.patch does not apply.
Comment almost 2 years ago →
🇩🇪Germany mkalkbrenner 🇩🇪
I appreciate any help on this issue. But the patch in #20 makes no sense. It doesn't address anything related to this issue.

https://git.drupalcode.org/project/search_api_solr/-/commit/61cfedd0b676... has been committed already.
And there's a first patch and comments(!) for the remaining issues at https://github.com/mkalkbrenner/search_api_solr/pull/86

I already mentioned that the test suite on drupal.org doesn't run any Solr integration tests. So please use Pull requests on github!
Comment almost 2 years ago →
🇮🇳India rassoni Bangalore
Merge request !21fix other left PHP coding standards and warning → (Open) created by sahil.goyal
Open in Jenkins → Open on Drupal.org →
Core: 9.5.x + Environment: PHP 8.0 & MySQL 5.7
last update over 1 year ago
31 pass

There are still some warnings shown below left, so still in NW state

FILE: /Users/sahil.goyal/Documents/MySites/101/drupal/modules/contrib/search_api_solr/search_api_solr.install
-------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
-------------------------------------------------------------------------------------------------------------
 655 | WARNING | There must be no blank line following an inline comment
 741 | WARNING | There must be no blank line following an inline comment
-------------------------------------------------------------------------------------------------------------


FILE: ...MySites/101/drupal/modules/contrib/search_api_solr/tests/modules/search_api_solr_test/search_api_solr_test.module
-----------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------------
 10 | WARNING | Unused variable $_search_api_solr_test_index_fallback_test.
-----------------------------------------------------------------------------------------------------------------------


FILE: ...tes/101/drupal/modules/contrib/search_api_solr/modules/search_api_solr_legacy/tests/src/Kernel/SolrLegacyTest.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------------
 109 | WARNING | Unused variable $backend.
-----------------------------------------------------------------------------------------------------------------------


FILE: ...rupal/modules/contrib/search_api_solr/src/Plugin/Field/FieldFormatter/SearchApiSolrHighlightedStringFormatter.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
-----------------------------------------------------------------------------------------------------------------------
 35 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead
 37 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead
-----------------------------------------------------------------------------------------------------------------------


FILE: ...s/sahil.goyal/Documents/MySites/101/drupal/modules/contrib/search_api_solr/src/Commands/SearchApiSolrCommands.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------------
 197 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead
-----------------------------------------------------------------------------------------------------------------------


FILE: ...hil.goyal/Documents/MySites/101/drupal/modules/contrib/search_api_solr/src/Utility/StreamingExpressionBuilder.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 27 ERRORS AFFECTING 27 LINES
-----------------------------------------------------------------------------------------------------------------------
 224 | ERROR | Public method name "StreamingExpressionBuilder::_collection" is not in lowerCamel format
 234 | ERROR | Public method name "StreamingExpressionBuilder::_checkpoints_collection" is not in lowerCamel format
 251 | ERROR | Public method name "StreamingExpressionBuilder::_field" is not in lowerCamel format
 275 | ERROR | Public method name "StreamingExpressionBuilder::_field_list" is not in lowerCamel format
 300 | ERROR | Public method name "StreamingExpressionBuilder::_all_fields_list" is not in lowerCamel format
 329 | ERROR | Public method name "StreamingExpressionBuilder::_all_doc_value_fields_list" is not in lowerCamel format
 360 | ERROR | Public method name "StreamingExpressionBuilder::_escaped_value" is not in lowerCamel format
 395 | ERROR | Public method name "StreamingExpressionBuilder::_field_value" is not in lowerCamel format
 415 | ERROR | Public method name "StreamingExpressionBuilder::_field_escaped_value" is not in lowerCamel format
 438 | ERROR | Public method name "StreamingExpressionBuilder::_escape_and_implode" is not in lowerCamel format
 459 | ERROR | Public method name "StreamingExpressionBuilder::_select_renamed_field" is not in lowerCamel format
 476 | ERROR | Public method name "StreamingExpressionBuilder::_select_copied_field" is not in lowerCamel format
 509 | ERROR | Public method name "StreamingExpressionBuilder::_intersect" is not in lowerCamel format
 540 | ERROR | Public method name "StreamingExpressionBuilder::_merge" is not in lowerCamel format
 565 | ERROR | Public method name "StreamingExpressionBuilder::_export_all" is not in lowerCamel format
 590 | ERROR | Public method name "StreamingExpressionBuilder::_search_all" is not in lowerCamel format
 612 | ERROR | Public method name "StreamingExpressionBuilder::_update" is not in lowerCamel format
 637 | ERROR | Public method name "StreamingExpressionBuilder::_commit" is not in lowerCamel format
 665 | ERROR | Public method name "StreamingExpressionBuilder::_commit_update" is not in lowerCamel format
 678 | ERROR | Public method name "StreamingExpressionBuilder::_index_filter_query" is not in lowerCamel format
 688 | ERROR | Public method name "StreamingExpressionBuilder::_index_id" is not in lowerCamel format
 700 | ERROR | Public method name "StreamingExpressionBuilder::_site_hash" is not in lowerCamel format
 710 | ERROR | Public method name "StreamingExpressionBuilder::_request_time" is not in lowerCamel format
 720 | ERROR | Public method name "StreamingExpressionBuilder::_timestamp_value" is not in lowerCamel format
 730 | ERROR | Public method name "StreamingExpressionBuilder::_topic" is not in lowerCamel format
 745 | ERROR | Public method name "StreamingExpressionBuilder::_topic_all" is not in lowerCamel format
 767 | ERROR | Public method name "StreamingExpressionBuilder::_checkpoint" is not in lowerCamel format
-----------------------------------------------------------------------------------------------------------------------

Assigned to sakthi_dev
Comment over 1 year ago →
🇮🇳India sakthi_dev
Open in Jenkins → Open on Drupal.org →
Core: 9.5.x + Environment: PHP 8.0 & MySQL 5.7
last update over 1 year ago
PHPLint Failed
Issue was unassigned.
Status changed to Needs review over 1 year ago8:00am 19 April 2023
Comment over 1 year ago →
🇮🇳India sakthi_dev
Please review.
Status changed to Needs work over 1 year ago3:33pm 1 May 2023
Comment over 1 year ago →
🇮🇹Italy apaderno Brescia, 🇮🇹
The issue summary should always describe what the issue is trying to fix and, in the case, of coding standards issues, show which command has been used, which arguments have been used, and which report that command shown.
First commit to issue fork.
Open on Drupal.org →
Core: 10.1.x + Environment: PHP 8.1 & MySQL 8
last update about 1 year ago
Not currently mergeable.
Comment about 1 year ago →
🇷🇺Russia zniki.ru
Update IS, provide check run results on latest 4.x-dev.
Open on Drupal.org →
Core: 10.1.x + Environment: PHP 8.1 & MySQL 8
last update about 1 year ago
Not currently mergeable.
Merge request !29Issue #3328996: PHP code style fix → (Closed) created by zniki.ru
Open in Jenkins → Open on Drupal.org →
Core: 10.1.x + Environment: PHP 8.1 & MySQL 8
last update about 1 year ago
PHPLint Failed

Comment about 1 year ago →

🇷🇺Russia zniki.ru

MR #21 have merge conflict and changes in code base is pretty big.

I used changes from #21 I create new MR #29, added phpcs.xml.dist to module.
Remove some unwanted changes.

Anyone please feel free to continue working on MR #29.

Command to run check:

phpcs --standard=modules/contrib/search_api_solr/phpcs.xml.dist modules/contrib/search_api_solr/ -s
<code>

Issues left:
<code>

FILE: tests/modules/search_api_solr_test/search_api_solr_test.module
--------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
--------------------------------------------------------------------------------
 1 | ERROR   | [x] Missing file doc comment
 3 | WARNING | [ ] Unused variable $_search_api_solr_test_index_fallback_test.
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------


FILE: tests/modules/search_api_solr_test/src/EventSubscriber/SearchApiSubscriber.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AND 1 WARNING AFFECTING 3 LINES
--------------------------------------------------------------------------------
 25 | ERROR   | [x] Missing function doc comment
 35 | ERROR   | [x] Missing function doc comment
 42 | WARNING | [ ] Line exceeds 80 characters; contains 81 characters
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------


FILE: search_api_solr.install
---------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
---------------------------------------------------------------------------
 2249 | WARNING | Line exceeds 80 characters; contains 93 characters
---------------------------------------------------------------------------


FILE: src/Utility/ZipStream3Factory.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 12 | ERROR | Parameter $name is not described in comment
--------------------------------------------------------------------------------


FILE: src/Utility/StreamingExpressionBuilder.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 749 | ERROR | Missing parameter comment
--------------------------------------------------------------------------------


FILE: src/Utility/CommandHelper.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 1 LINE
--------------------------------------------------------------------------------
 8 | ERROR | The text '@deprecated Use \Drupal\search_api_solr\Utility\SolrCommandHelper instead.' does not match the standard format: @deprecated in %deprecation-version% and is removed from %removal-version%.
   |       | %extra-info%.
 8 | ERROR | Each @deprecated tag must have a @see tag immediately following it
--------------------------------------------------------------------------------


FILE: src/Utility/ZipStreamFactory.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 12 | ERROR | Parameter $name is not described in comment
--------------------------------------------------------------------------------


FILE: src/Utility/Utility.php
---------------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
---------------------------------------------------------------------------
 927 | WARNING | Line exceeds 80 characters; contains 119 characters
 928 | WARNING | Line exceeds 80 characters; contains 120 characters
 929 | WARNING | Line exceeds 80 characters; contains 114 characters
 930 | WARNING | Line exceeds 80 characters; contains 118 characters
---------------------------------------------------------------------------


FILE: src/SolrConnector/SolrConnectorPluginBase.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 1179 | ERROR | Description for the @return value is missing
--------------------------------------------------------------------------------


FILE: src/Event/PostCreateIndexDocumentsEvent.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 7 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
--------------------------------------------------------------------------------


FILE: src/Event/AbstractSearchApiItemSolariumDocumentEvent.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 28 | ERROR | Parameter $index is not described in comment
--------------------------------------------------------------------------------


FILE: src/Plugin/Field/FieldFormatter/SearchApiSolrHighlightedTextDefaultFormatter.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 39 | ERROR | Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead
--------------------------------------------------------------------------------


FILE: src/Plugin/Field/FieldFormatter/SearchApiSolrHighlightedStringFormatter.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 82 | ERROR | Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead
--------------------------------------------------------------------------------


FILE: src/Plugin/search_api/backend/SearchApiSolrBackend.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 1 LINE
--------------------------------------------------------------------------------
 2831 | ERROR | Missing parameter comment
 2831 | ERROR | Missing parameter type
--------------------------------------------------------------------------------


FILE: src/Plugin/search_api/processor/RegexReplace.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
 71 | WARNING | Unused variable $regex_replace.
--------------------------------------------------------------------------------


FILE: src/SolrBackendInterface.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
 46 | ERROR | Description for the @return value is missing
 53 | ERROR | Description for the @return value is missing
--------------------------------------------------------------------------------


FILE: src/Commands/SearchApiSolrCommands.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
 197 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead
--------------------------------------------------------------------------------

Comment about 1 year ago →
🇩🇪Germany mkalkbrenner 🇩🇪
It makes no sense to post any patches here or to work on the MR.

A lot of the suggestions are erroneous if you still follow the code checker without thinking about it. You need to open PRs on GitHub to get the changes tested.
And I recommend to do it in small chunks, to get something committed, instead of mixing small changes which make sense with breaking ones.

BTW none of my comments on GitHub has been handled.
Comment about 1 year ago →
🇷🇺Russia zniki.ru
Markus thanks a lot for explanation.
I will close my MR in this case, and will create new on on github.
Comment about 1 year ago →
🇩🇪Germany mkalkbrenner 🇩🇪
But don't get me wrong. Any help is welcome here!
Comment about 1 year ago →
System Message
zniki.ru → closed merge request !29
Comment about 1 year ago →
🇷🇺Russia zniki.ru
MR created https://github.com/mkalkbrenner/search_api_solr/pull/97

Comment about 1 year ago →

System Message

d0d073cd committed on 4.x

Issue #3328996: phpcs fix (#97)

Co-authored-by: Sahil Goyal...

Status changed to Needs review about 1 year ago11:26am 4 December 2023
Comment about 1 year ago →
🇩🇪Germany mkalkbrenner 🇩🇪
Awesome! Thanks a lot. Let's see what the d.o tests report ...

Comment about 1 year ago →

🇩🇪Germany mkalkbrenner 🇩🇪

Here're the remaining issues:
https://www.drupal.org/pift-ci-job/2818290 →

/var/www/html/modules/contrib/search_api_solr/config/optional/search_api_solr.solr_field_type.text_hu_6_0_0.yml
line 246	Expected indentation of 4 spaces but found 5 spaces. (yml/indent)
246	Irregular whitespace not allowed. (yml/no-irregular-whitespace)
/var/www/html/modules/contrib/search_api_solr/config/optional/search_api_solr.solr_field_type.text_hu_7_0_0.yml
250	Expected indentation of 4 spaces but found 5 spaces. (yml/indent)
250	Irregular whitespace not allowed. (yml/no-irregular-whitespace)
/var/www/html/modules/contrib/search_api_solr/config/optional/search_api_solr.solr_field_type.text_sk_6_0_0.yml
250	Expected indentation of 4 spaces but found 5 spaces. (yml/indent)
250	Irregular whitespace not allowed. (yml/no-irregular-whitespace)
/var/www/html/modules/contrib/search_api_solr/config/optional/search_api_solr.solr_field_type.text_sk_7_0_0.yml
254	Expected indentation of 4 spaces but found 5 spaces. (yml/indent)
254	Irregular whitespace not allowed. (yml/no-irregular-whitespace)
/var/www/html/modules/contrib/search_api_solr/drupalci.yml
4	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
6	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
9	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
10	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
11	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
12	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
13	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
14	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
15	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
16	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
17	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
20	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
21	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
22	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
23	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
24	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
31	Empty mapping values are forbidden. (yml/no-empty-mapping-value)
modules/search_api_solr_admin/css/solr_field_analysis.css
1	Don't use IDs in selectors.

Comment about 1 year ago →
System Message

mkalkbrenner → committed 4d4ca6fe on 4.x
Issue #3328996 by mkalkbrenner: Fix the issues reported by phpcs

Comment about 1 year ago →

🇩🇪Germany mkalkbrenner 🇩🇪

Last remaining issue:

modules/search_api_solr_admin/css/solr_field_analysis.css
line 1	Don't use IDs in selectors.

Status changed to Needs work about 1 year ago5:46am 5 December 2023
Comment about 1 year ago →
🇷🇺Russia zniki.ru
Last remaining issue:

This is only last for stylelint violations: https://git.drupalcode.org/project/search_api_solr/-/jobs/434026

There are 15 ERRORS AND 12 WARNINGS, that's needs to be fixed.
https://git.drupalcode.org/project/search_api_solr/-/jobs/434024

Issue summary updated.
Comment about 1 year ago →
🇩🇪Germany mkalkbrenner 🇩🇪
Status changed to Fixed about 1 year ago3:15pm 5 December 2023
Comment about 1 year ago →
🇩🇪Germany mkalkbrenner 🇩🇪
Comment about 1 year ago →
🇩🇪Germany mkalkbrenner 🇩🇪
Follow-up: 📌 Fix phpcs, phpstan, stylelint findings Active
Comment about 1 year ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

Fix the issues reported by phpcs

Merge Requests

!29Fix the issues reported by phpcs
Closed

!21Fix the issues reported by phpcs
Open

Comments & Activities

Fix the issues reported by phpcs

Merge Requests

!29Fix the issues reported by phpcsClosed

!21Fix the issues reported by phpcsOpen

Comments & Activities

!29Fix the issues reported by phpcs
Closed

!21Fix the issues reported by phpcs
Open