Review the WordPressVIPMinimum.Hooks.PreGetPosts sniff
まだ誰も着手していません。
評価
調査の方向性
まず、WordPressVIPMinimum.Hooks.PreGetPosts sniff とその既存のテストを見つけます。エッジケース、PHPCSUtils の活用機会、modern PHP の扱い、violations、PHPDoc、関連する issues を含め、sniff に照らしてチェックリストを確認します。完了とは、関連する review 項目に対応し、coverage によって結果として得られる動作が検証されていることを意味します。
索引モデルが issue の本文から書いたものです。
説明
Review the WordPressVIPMinimum.Hooks.PreGetPosts sniff for the following in as far as relevant to that sniff:
- Code style independent sniffing / Correct handling of quirky code
Typical things to add tests for and verify correct handling of:- Nested function/closure declarations
- Nested class declarations
- Comments in unexpected places
- Variables being assigned to via
liststatements - Multiline text strings
- Text strings provided via heredoc/nowdoc
- Use of short open tags
- Using PHP close tag as end of statement
- Inline control structures (without braces)
- Code simplifications which can be made using PHPCSUtils
- Sniff stability improvements which can be made using PHPCSUtils
- Correct handling of modern PHP code
Typical things to add tests for and verify correct handling of (where applicable):- PHP 5.0 Try/catch/finally (PHP 5.5) and exceptions
- PHP 5.3 Namespaced code vs code in the global namespace
- PHP 5.3 Use import statements, incl aliasing
- PHP 5.3 Short ternaries
- PHP 5.3 Closures, incl closure use
- PHP 5.4 Short arrays
- PHP 5.5 Class name resolution using
::class - PHP 5.5 List in foreach
- PHP 5.5/7.0 Generators using yield and yield from
- PHP 5.6 Constant scalar expressions
- PHP 5.6 Importing via
use function/const - PHP 7.0 Null coalesce
- PHP 7.0 Anonymous classes
- PHP 7.0 Scalar and return type declarations
- PHP 7.0 Group use statements
- PHP 7.1 Short lists
- PHP 7.1 Keyed lists
- PHP 7.1 Multi-catch
- PHP 7.1 Nullable types
- PHP 7.3 List reference assignments
- PHP 7.4 arrow functions
- PHP 7.4 numeric literals with underscores
- PHP 7.4 null coalesce equals
- PHP 7.4 Typed properties
- Various versions: trailing comma's in function calls, group use, function declarations, closure use etc
Other:
- Review violation error vs warning
- Review violation severity
- Review violation message, consider adding a link
- Check open issues related to the sniff
- Review PHPDoc comments
Sniff basics, but changes need to be lined up for next major release:
- Inappropriate use of
publicproperties (#234) - Modular error codes (unique error code for each distinct message)
Once PHPCS/PHPCSUtils supports this:
- PHP 8.0 Constructor property promotion
- PHP 8.0 Union types
- PHP 8.0
matchexpressions - PHP 8.0 Nullsafe operator
- PHP 8.0 Named arguments
- PHP 8.0 Single token namespaced names
- 主要言語
- PHP
- スター
- 261
- フォーク
- 44
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Automattic/VIP-Coding-Standards のほかの issue
-
AlwaysReturnInFilter: isInsideIfConditonal() guards the conditions array after reading it対応中かも @tomjn が 5 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
Bug: PreGetPosts warns when the early is_main_query() return is not the first statement in its if対応中かも @tomjn が 5 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 76/100
-
Suppress filters in get_posts false positive対応中かも @tomjn が 7 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
-
Breaking Change Type: Maintenance
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
Automattic/VIP-Coding-Standards#849 · コメント 1 件 ·
Automattic/VIP-Coding-Standards の issue をすべて見る
似ている issue
-
extension/Commercial needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
crazy-goat/rabbit-stream#753 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
opensourcepos/opensourcepos#4743 ·
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
grokability/snipe-it#19786 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 3 日以内に返信