Coding standards

Patch for example.

@thalles thank you for contributing! I made a few changes and committed.

To understand what else needs to be fixed
https://pareview.sh/pareview/https-git.drupal.org-project-simple_sitemap...

Patch with a complete code refactoring in accordance with the current Drupal coding standards. I didn’t fix some points, as they relate to description of update hooks and interface translation. @gbyte please review after tests succeeded.

P.S. I was unable to create a new branch (for 4.x) in the current issue fork. Therefore, I am sending a patch.

@gbyte

To check standards, I use the PHP_CodeSniffer tool and the ruleset from the Coder project. There is also an online version, but it doesn't work yet. Also note that the PHP_CodeSniffer integrates with PhpStorm.

To avoid reopening this issue, please use the above tools.

I checked out the code again locally in the 4.x branch. The result is as follows:

FILE: tests/src/Functional/SimplesitemapTest.php
------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
------------------------------------------------------------------------------------
 614 | ERROR | [ ] @throws comment must be on the next line
 615 | ERROR | [x] Separate the @throws and @dataProvider sections by a blank line.
------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------


FILE: src/Logger.php
-----------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-----------------------------------------------------------------------------
 124 | WARNING | Only string literals should be passed to t() where possible
-----------------------------------------------------------------------------


FILE: src/Queue/BatchTrait.php
----------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----------------------------------------------------------------------------
 43 | WARNING | Only string literals should be passed to t() where possible
----------------------------------------------------------------------------


FILE: src/SimpleSitemapListBuilder.php
----------------------------------------------------------------------------
FOUND 0 ERRORS AND 7 WARNINGS AFFECTING 5 LINES
----------------------------------------------------------------------------
 41 | WARNING | Only string literals should be passed to t() where possible
 41 | WARNING | Only string literals should be passed to t() where possible
 42 | WARNING | Only string literals should be passed to t() where possible
 42 | WARNING | Only string literals should be passed to t() where possible
 56 | WARNING | Only string literals should be passed to t() where possible
 58 | WARNING | Only string literals should be passed to t() where possible
 59 | WARNING | Only string literals should be passed to t() where possible
----------------------------------------------------------------------------


FILE: src/Form/CustomLinksForm.php
-----------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-----------------------------------------------------------------------------
 101 | WARNING | Only string literals should be passed to t() where possible
-----------------------------------------------------------------------------


FILE: src/Form/EntitiesForm.php
---------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
---------------------------------------------------------------------------------------------------------------------------------------------
 154 | WARNING | Do not concatenate strings to translatable strings, they should be part of the t() argument and you should use placeholders
 171 | ERROR   | Concatenating translatable strings is not allowed, use placeholders instead and only one string literal
---------------------------------------------------------------------------------------------------------------------------------------------


FILE: src/Form/FormHelper.php
--------------------------------------------------------------------------------------
FOUND 16 ERRORS AND 6 WARNINGS AFFECTING 18 LINES
--------------------------------------------------------------------------------------
 390 | WARNING | [ ] Only string literals should be passed to t() where possible
 403 | ERROR   | [x] Array indentation error, expected 10 spaces but found 12
 404 | ERROR   | [x] Array indentation error, expected 14 spaces but found 12
 405 | ERROR   | [x] Array indentation error, expected 14 spaces but found 12
 405 | WARNING | [ ] Only string literals should be passed to t() where possible
 406 | ERROR   | [x] Array closing indentation error, expected 12 spaces but found 10
 407 | ERROR   | [x] Array indentation error, expected 10 spaces but found 12
 408 | ERROR   | [x] Array indentation error, expected 14 spaces but found 12
 409 | ERROR   | [x] Array indentation error, expected 14 spaces but found 12
 409 | WARNING | [ ] Only string literals should be passed to t() where possible
 410 | ERROR   | [x] Array closing indentation error, expected 12 spaces but found 10
 412 | ERROR   | [x] Array indentation error, expected 10 spaces but found 12
 413 | ERROR   | [x] Array indentation error, expected 14 spaces but found 12
 414 | ERROR   | [x] Array indentation error, expected 14 spaces but found 12
 414 | WARNING | [ ] Only string literals should be passed to t() where possible
 415 | ERROR   | [x] Array closing indentation error, expected 12 spaces but found 10
 416 | ERROR   | [x] Array indentation error, expected 10 spaces but found 12
 417 | ERROR   | [x] Array indentation error, expected 14 spaces but found 12
 418 | ERROR   | [x] Array indentation error, expected 14 spaces but found 12
 418 | WARNING | [ ] Only string literals should be passed to t() where possible
 419 | ERROR   | [x] Array closing indentation error, expected 12 spaces but found 10
 634 | WARNING | [ ] Only string literals should be passed to t() where possible
--------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 16 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------


FILE: src/Form/SettingsForm.php
-----------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-----------------------------------------------------------------------------
 165 | WARNING | Only string literals should be passed to t() where possible
-----------------------------------------------------------------------------


FILE: src/SimpleSitemapTypeListBuilder.php
----------------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
----------------------------------------------------------------------------
 31 | WARNING | Only string literals should be passed to t() where possible
 32 | WARNING | Only string literals should be passed to t() where possible
 33 | WARNING | Only string literals should be passed to t() where possible
 36 | WARNING | Only string literals should be passed to t() where possible
----------------------------------------------------------------------------


FILE: simple_sitemap.install
---------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 7 WARNINGS AFFECTING 11 LINES
---------------------------------------------------------------------------------------------------------------------
 297 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
 314 | WARNING | Line exceeds 80 characters; contains 81 characters
 315 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
 340 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
 382 | WARNING | Line exceeds 80 characters; contains 84 characters
 398 | WARNING | Line exceeds 80 characters; contains 81 characters
 434 | WARNING | Line exceeds 80 characters; contains 86 characters
 536 | WARNING | Line exceeds 80 characters; contains 86 characters
 604 | WARNING | Line exceeds 80 characters; contains 89 characters
 722 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
 846 | WARNING | Line exceeds 80 characters; contains 92 characters
---------------------------------------------------------------------------------------------------------------------


FILE: modules/simple_sitemap_engines/src/Form/SimplesitemapEnginesForm.php
-----------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-----------------------------------------------------------------------------
 124 | WARNING | Only string literals should be passed to t() where possible
-----------------------------------------------------------------------------

Interface translation problems are points related to the t() function. This can be partially solved by #3238405: Make new configuration entities translatable. I think that other points also need to be fixed.

The main points have been fixed for now.