Fix the issues reported by PHPCS

This project will only accept issues found by running automated scanners with the following configuration on a current Drupal core install.

composer run phpcs -- -ps modules/locale_deploy/
vendor/bin/phpstan analyse  -c core/phpstan.neon.dist modules/locale_deploy

If you do want to make changes according to automated scan then the issue will only be accepted if it comes with an MR and the work done already. It will be rejected if the changes make the code harder to read. For example, line length enforced by PHPCS will not be observed by this project.

Wrt to the MR filed here:

• all the array declaration changes will not be accepted.
• The unnecessary param documentation will not be accepted.

1. +++ b/src/Commands/LocaleDeployCommands.php
   @@ -122,6 +132,9 @@ class LocaleDeployCommands extends DrushCommands implements SiteAliasManagerAwar
   +  /**
   +   * {@inheritdoc}
   +   */
   

   This is not inheriting anything. It's okay to have a private method without a doc block.

2. +++ b/tests/src/Build/CustomTranslationsTest.php
   @@ -119,7 +119,9 @@ EOT;
   -   * @param $custom_setup_file
   +   * {@inheritdoc}
   

   This is not inheriting anything.

3. +++ b/tests/src/Functional/LocaleDeployTest.php
   @@ -22,6 +22,8 @@ class LocaleDeployTest extends BrowserTestBase {
      /**
   +   * {@inheritdoc}
   +   *
       * @see locale_deploy_form_locale_translate_settings_alter()
       */
      public function testFormAlter(): void {
   
   @@ -34,6 +36,8 @@ class LocaleDeployTest extends BrowserTestBase {
      /**
   +   * {@inheritdoc}
   +   *
       * @see locale_deploy_requirements()
       */
      public function testRequirements(): void {
   

   Theses are not inheriting anything and the docblocks here + method names are perfect already.

Thanks Alex for brief description.

Providing patch with fixes if it works for you.

The last submitted patch, 4: phpcs-issue-fixes-3355077-4.patch, failed testing. View results →

Preethy_ray → made their first commit to this issue’s fork.

Hi,
Hi I reviewed patch #6, and there are still remaining issues reported by phpcs shown below:

FILE:/locale_deploy/src/Commands/LocaleDeployCommands.php
------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
------------------------------------------------------------------------------------------------------------------------
 164 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and
     |         | $this->t() instead
 165 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and
     |         | $this->t() instead
------------------------------------------------------------------------------------------------------------------------


FILE: /locale_deploy/locale_deploy.module
------------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AND 1 WARNING AFFECTING 4 LINES
------------------------------------------------------------------------------------------------------------------------
 15 | WARNING | Global constants should not be used, move it to a class or interface
 24 | ERROR   | All functions defined in a module file must be prefixed with the module's name, found
    |         | "locale_form_locale_translate_settings_alter" but expected
    |         | "locale_deploy_locale_form_locale_translate_settings_alter"
 39 | ERROR   | All functions defined in a module file must be prefixed with the module's name, found
    |         | "locale_locale_translation_projects_alter" but expected
    |         | "locale_deploy_locale_locale_translation_projects_alter"
 56 | ERROR   | All functions defined in a module file must be prefixed with the module's name, found
    |         | "locale_module_implements_alter" but expected "locale_deploy_locale_module_implements_alter"
------------------------------------------------------------------------------------------------------------------------

Hi , i have fixed these remaining issues. please review

Hi,
Patch #10 is applied cleanly, but one warning was found.
Thank you!!

FILE: .../locale_deploy/locale_deploy.module
----------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----------------------------------------------------------------------------
 15 | WARNING | Global constants should not be used, move it to a class or
    |         | interface
----------------------------------------------------------------------------

This project is using gitlabci if the PHPCS errors are not reported there then they are not errors.