Как исключить конкретное правило в пользовательском наборе правил phpcs.xml?

Question

Я ищу способ автоматизации стандартов кодирования, и я решил использовать SlevomatCodingStandard.TypeHints.TypeHintDeclaration в нашем файле phpcs.xml. К сожалению, мы столкнулись с проблемой сообщения об ошибках:

38 | ERROR | [ ] @var annotation of property | | \VC4A\ConvertUploadsToS3::$missing_local_files | | does not specify type hint for its items. 45 | ERROR | [ ] @var annotation of property | | \VC4A\ConvertUploadsToS3::$missing_s3_files does | | not specify type hint for its items. 52 | ERROR | [ ] @var annotation of property | | \VC4A\ConvertUploadsToS3::$updated_s3_links does | | not specify type hint for its items. 66 | ERROR | [ ] @var annotation of property | | \VC4A\ConvertUploadsToS3::$s3_settings does not | | specify type hint for its items. 112 | ERROR | [ ] Method \VC4A\ConvertUploadsToS3::setup_crons() | | does not have return type hint nor @return | | annotation for its return value. 149 | ERROR | [ ] @return annotation of method | | \VC4A\ConvertUploadsToS3::get_cron_actions() does | | not specify type hint for items of its traversable | | return value. 202 | ERROR | [ ] @return annotation of method | | \VC4A\ConvertUploadsToS3::get_cron_intervals() | | does not specify type hint for items of its | | traversable return value. 266 | ERROR | [ ] @param annotation of method | | \VC4A\ConvertUploadsToS3::error_reporting() does | | not specify type hint for items of its traversable | | parameter $uploads. 334 | ERROR | [ ] @param annotation of method | | \VC4A\ConvertUploadsToS3::update_s3_link() does | | not specify type hint for items of its traversable | | parameter $upload. 336 | ERROR | [x] Method \VC4A\ConvertUploadsToS3::update_s3_link() | | does not have void return type hint.

Я хочу добавить строгие типы возвращаемых данных только для методов, но для DocBlocks, которые мы используем WordPress-Docs стандарты.

Есть ли способ отключить остальные ошибки, кроме последней?

Что я пробовал, так это:

<rule ref="SlevomatCodingStandard.TypeHints.TypeHintDeclaration"> <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint"/> <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.enableEachParameterAndReturnInspection"/> <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.normalizedTraversableTypeHints"/> <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.normalizedUsefulAnnotations"/> </rule>

Видимо, это не имеет никакого эффекта. Какие-либо предложения? Или какой может быть правильный способ добавить только это конкретное правило?

Или это можно сделать иначе? Просто добавить определенное правило в набор правил без изменения кодовой базы?

Answer 1

Очевидно, я должен был использовать постоянные значения вместо имен членов класса:

<!-- Strict type return for methods --> <rule ref="SlevomatCodingStandard.TypeHints.TypeHintDeclaration"> <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableParameterTypeHintSpecification"/> <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversablePropertyTypeHintSpecification"/> <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableReturnTypeHintSpecification"/> </rule>

Источник: https://github.com/slevomat/coding-standard/issues/570