Known issues

[kagg-design]

Expected Behavior

There are several issues found upon commencement of repo usage with the WPForms plugins.

Current Behavior

• [x] Endless loop in ParamTagHooksSniff::countArguments. Fixed in 51d941e5bca2361ba72f9822c59476cfd903805f.
• [x] Relative path detection in PhpStorm temporary folder. Fixed in #18.
• [x] Do not scan vendor folders in plugins. Fixed in 133a6fe99f31acf64ff54139189dd6fbf7d0933a.
• [x] Fix determining the fully qualified class name (FQCN) to validate hook name. We determined the FQCN from the file path, which doesn't work at all for classes not following the PSR-4 standard. I have created the FQCN extraction from analyzed file tokens. Fixed in f7eb0778bf5ed7945c1da53cf3b47e09510ec13a.
• [x] Reduce usage of @runInSeparateProcess in tests. Fixed in 05eb4391687e1fecd0c7a7490d80785736a32961.
• [x] Validation of the text domain has some issues: when the domain is not specified, last argument of the i18n function is not a string, i18n function contains nested parenthesis. Fixed in a59d5f59e5347ec5a7ed865fbafe31e51515e030.
• [x] In hook expected names, convert class name from CamelCase to snake_case. Fixed in c60c67ba8ecc71b0bbd36fbf5d429898178a6fff.
• [x] Cannot detect the hook name when a hook is not a constant string. Fixed in ea81cafd195a72b376e0905129c956574ee1e3cb and d2300f27bf33c35af386091a63a032c601316494.
• [x] Allow the presence of comments inside the first argument (hook name). Fixed in 0f5577b1cac49748fedc68cfb5a2c03bc1ccbff9.
• [x] Adding of the multi_domains setting to the phpcs.xml blocks detection of the WordPress.Security.NonceVerification.Recommended, For instance, in wp-content/plugins/wpforms/wpforms.php:217. Fixed by a commit above.
• [x] Message phpcs: WPForms.PHP.ValidateDomain.InvalidDomain: You are using invalid domain name. Use wpforms instead of wpforms-lite appears on many files. Fixed in d973e799dc20432b243dbee55d692770ddaae170.
• [x] Message Remove unneededusestatement (WPForms.PHP.UseStatement.UnusedUseStatement) is wrong when class is used in PHPDoc only. See TestCase,php as an example. The problem was in ignoring @throws statements. Fixed in 389b5598f569ccafc4dee61ffd87e6675d92641f.
• [x] Message phpcs: WPForms.Formatting.EmptyLineBeforeReturn.RemoveEmptyLineBeforeReturnStatement: Remove empty line before return statement in xxx line. occurs when if contains a comment line and the return statement only. Fixed in 3130c0c48e7d30d2d07708650748eeb41c0fa5c5.
• [x] Endless loop in SinceTagHooksSniff.php. Fixed in e212b300b396e45dfdcaf3e0a29cdd53b29f5887.
• [x] Wrong detection of the text domain by the property in the ruleset. Fixed in 9ae857bbbadf1fb4fb21b5673ab4a66fea153b3f.
• [x] Prevent endless loop in HooksMethoidSniff.php. Fixed in a0555813132735799fed2ad1fe6609e552ebf346.
• [x] Do not use HooksMethodSniff.php when not in the class file. Fixed in e7dcf55edabf64234dbdc9257fc00e4bd41041ad.
• [x] Fix wrong @param tag counting when a hook has no arguments. Fixed in 449b1e2c2b156de6540b22df0763d48bbd60564a.
• [x] In wpforms/includes/class-frontend.php the statement apply_filters( 'wpforms_amp_pro', wpforms()->is_pro() ) requires 3 @param tags. - Fixed in 72bbd6750dc3602e072646f8b8d5c45507b31b12.
• [x] In \WPFormsSurveys\Loader::init we improperly claim WPForms.PHP.BackSlash.UseShortSyntax. Fixed in 66dd8ef8f7971007795f482dfb509fc3655889c4.
• [x] Respect /* This action/filter is documented in... / and do not count @param tags.. Fixed in 56a6c5ddabcdbfbd520127a704621a17b3e04275.
• [ ] Wrong counting of nested @param tags (screenshot)
• [ ] Improperly claim WPForms.Comments.PHPDocHooks.RequiredHookDocumentation (screenshot1, screenshot2)
• [ ] WPForms.Comments.PHPDocDefine.MissPHPDoc reported on test files, what is not expected
• [x] When @param uses [], like WP_Post[], the alignment error ParamTagHooks.InvalidAlign occurs
• [x] phpcs: WPForms.Formatting.Switch.AddEmptyLineBefore: You should add an empty line before on wp-content/plugins/wpforms/includes/admin/builder/functions.php:106 looks like incomplete message.
• [ ] Hooks can only be added in thehooksmethod on wp-content/plugins/wpforms/includes/admin/builder/class-builder.php:92 is repeated several times in CLI mode.
• [x] Incorrectly calculating hook's arguments for the apply_filters_deprecated and do_action_deprecated functions.
• [x] Shouldn't be errors related to the Hooks Documentation when a hook has a comment /** This filter(action) is documented in path/to/file */
• [x] Hooks in addons should start with wpform_addon_name. Fixed in d64997fe3582b36215b860f264dc360158b52a15.
• [x] All namespace parts consisting of two or more words in hook names should be converted to snake case and has underscore symbol between words: e.g. WPForms\LongNameSpacePart\LongClassName -> wpforms_long_name_space_part_long_class_name_
• [x] If a namespace part the same as a class name we should collapse them: e.g. WPForms\Providers\Provides -> wpforms_providers_
• [ ] Message Remove unneeded use statement (WPForms.PHP.UseStatement.UnusedUseStatement) is wrong when class is used in PHPDoc only. The problem was in ignoring @return statements.
• [x] Cannot define text domain in the same directory where phpcs.xml is located. So, <property name="wp-mail-smtp" value="." /> does not work. Fixed in 6ee0896af1dbd3e6a38f9d5e3ba6009541b59ece.
• [ ] Show an error if the i18n function doesn't have a domain at all.
• [ ] Hook names should start with FQCN + method name. Currently, we validate only by FQCN.

[slaFFik]

@kagg-design I would suggest making each individual unchecked checkbox as a separate GH issue. This way it will be easier to have relevant conversations separate plus easier to reference completed issues in commits.