localgovdrupal / localgov_microsites_group

LocalGov Drupal Microsites Group integration
1 stars 2 forks source link

Coding standards, including "The text '@deprecated ' does not match the standard format" #451

Open finnlewis opened 7 months ago

finnlewis commented 7 months ago

See https://github.com/localgovdrupal/localgov_microsites_project/actions/runs/8435507654/job/23101095828?pr=42#step:4:41


FILE: ...les/contrib/localgov_microsites_group/src/DomainGroupResolverInterface.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 1 LINE
--------------------------------------------------------------------------------
 11 | ERROR | The text '@deprecated ' does not match the standard format:
    |       | @deprecated in %deprecation-version% and is removed from
    |       | %removal-version%. %extra-info%.
 11 | ERROR | Each @deprecated tag must have a @see tag immediately following
    |       | it
--------------------------------------------------------------------------------

FILE: ...les/contrib/localgov_microsites_group/src/Form/DomainGroupSettingsForm.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 10 | ERROR | [x] Use statements should be sorted alphabetically. The first
    |       |     wrong one is
    |       |     Drupal\localgov_microsites_group\Plugin\DomainGroupSettingsManager.
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: .../modules/contrib/localgov_microsites_group/src/Form/MicrositeDomainAdd.php
--------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
--------------------------------------------------------------------------------
  53 | ERROR | [x] Inline comments must end in full-stops, exclamation marks,
     |       |     question marks, colons, or closing parentheses
  64 | ERROR | [x] Inline comments must start with a capital letter
 198 | ERROR | [x] Expected 1 blank line after function; 2 found
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...es/contrib/localgov_microsites_group/src/EventSubscriber/SiteAdminMode.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AND 1 WARNING AFFECTING 3 LINES
--------------------------------------------------------------------------------
  8 | WARNING | [x] Unused use statement
 20 | ERROR   | [x] Additional blank lines found at end of doc comment
 22 | ERROR   | [x] Expected 1 blank line after function; 2 found
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...web/modules/contrib/localgov_microsites_group/src/DomainFromGroupTrait.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
  7 | ERROR | [x] There must be one blank line after the last USE statement; 2
    |       |     found;
 25 | ERROR | [x] Missing function doc comment
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...ontrib/localgov_microsites_group/src/Plugin/DomainGroupSettingsManager.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 6 | ERROR | [x] Use statements should be sorted alphabetically. The first
   |       |     wrong one is Drupal\Core\Cache\CacheBackendInterface.
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...osites_group/src/Plugin/Group/RelationHandler/ContentTypeAccessControl.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 10 | ERROR | [x] There must be one blank line after the last USE statement; 2
    |       |     found;
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...ov_microsites_group/src/Plugin/DomainGroupSettings/ContentTypeSettings.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 13 | ERROR | [x] Use statements should be sorted alphabetically. The first
    |       |     wrong one is Drupal\group\Access\GroupAccessResult.
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...localgov_microsites_group/src/Plugin/DomainGroupSettings/ThemeSettings.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AND 2 WARNINGS AFFECTING 3 LINES
--------------------------------------------------------------------------------
 15 | WARNING | [x] Unused use statement
 16 | WARNING | [x] Unused use statement
 19 | ERROR   | [x] Use statements should be sorted alphabetically. The first
    |         |     wrong one is Drupal\group\Access\GroupAccessResult.
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: .../localgov_microsites_group/src/Plugin/DomainGroupSettings/SiteSettings.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AND 6 WARNINGS AFFECTING 8 LINES
--------------------------------------------------------------------------------
   7 | ERROR   | [x] Use statements should be sorted alphabetically. The first
     |         |     wrong one is Drupal\Core\Config\ConfigFactoryInterface.
   9 | WARNING | [x] Unused use statement
  13 | WARNING | [x] Unused use statement
  14 | WARNING | [x] Unused use statement
  15 | WARNING | [x] Unused use statement
  17 | WARNING | [x] Unused use statement
 219 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks,
     |         |     question marks, colons, or closing parentheses
 2[41](https://github.com/localgovdrupal/localgov_microsites_project/actions/runs/8435507654/job/23101095828?pr=42#step:4:42) | WARNING | [x] A comma should follow the last multiline array item.
     |         |     Found: 'page.404'
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 8 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...calgov_microsites_group/src/Plugin/DomainGroupSettings/MicrositeDomain.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AND 6 WARNINGS AFFECTING 6 LINES
--------------------------------------------------------------------------------
  5 | WARNING | [x] Unused use statement
  8 | WARNING | [x] Unused use statement
  8 | ERROR   | [x] Use statements should be sorted alphabetically. The first
    |         |     wrong one is Drupal\Core\Config\ConfigFactoryInterface.
  9 | WARNING | [x] Unused use statement
 10 | WARNING | [x] Unused use statement
 19 | WARNING | [x] Unused use statement
 20 | WARNING | [x] Unused use statement
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...trib/localgov_microsites_group/src/Plugin/DomainGroupSettingsInterface.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
 30 | ERROR | Parameter $account is not described in comment
 35 | ERROR | Missing parameter name
--------------------------------------------------------------------------------

FILE: ...localgov_microsites_group/src/Plugin/search_api/processor/EntityAccess.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 1 LINE
--------------------------------------------------------------------------------
 162 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 1
 162 | ERROR | [x] Closing brace indented incorrectly; expected 2 spaces, found
     |       |     1
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...ntrib/localgov_microsites_group/src/ContextProvider/DomainGroupContext.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 1 LINE
--------------------------------------------------------------------------------
 11 | ERROR | The text '@deprecated Use
    |       | \Drupal\group_context_domain\Context\GroupFromDomainContext.'
    |       | does not match the standard format: @deprecated in
    |       | %deprecation-version% and is removed from %removal-version%.
    |       | %extra-info%.
 11 | ERROR | Each @deprecated tag must have a @see tag immediately following
    |       | it
--------------------------------------------------------------------------------

FILE: ...ml/web/modules/contrib/localgov_microsites_group/src/ContentTypeHelper.php
--------------------------------------------------------------------------------
FOUND 5 ERRORS AND 2 WARNINGS AFFECTING 5 LINES
--------------------------------------------------------------------------------
 17 | ERROR   | Parameter $entityTypeManager is not described in comment
 17 | ERROR   | Parameter $moduleHandler is not described in comment
 17 | ERROR   | Parameter $relationPluginManager is not described in comment
 20 | ERROR   | Doc comment for parameter $entity_type_manager does not match
    |         | actual variable name $relationPluginManager
 22 | ERROR   | Doc comment for parameter $module_handler does not match actual
    |         | variable name $relationPluginManager
 34 | WARNING | Unused bound variable $group.
 99 | WARNING | Unused bound variable $group.
--------------------------------------------------------------------------------

FILE: .../web/modules/contrib/localgov_microsites_group/src/DomainGroupResolver.php
--------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
--------------------------------------------------------------------------------
 13 | ERROR | [x] Use statements should be sorted alphabetically. The first
    |       |     wrong one is Drupal\group\Entity\GroupInterface.
 19 | ERROR | [ ] The text '@deprecated ' does not match the standard format:
    |       |     @deprecated in %deprecation-version% and is removed from
    |       |     %removal-version%. %extra-info%.
 19 | ERROR | [ ] Each @deprecated tag must have a @see tag immediately
    |       |     following it
 [42](https://github.com/localgovdrupal/localgov_microsites_project/actions/runs/8435507654/job/23101095828?pr=42#step:4:43) | ERROR | [ ] Parameter $entity_repository is not described in comment
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------