godaddy-wordpress / primer-child-escapade

Escapade is a Primer child theme with a unique sidebar navigation.
12 stars 9 forks source link

Adding php linting #100

Closed jrtashjian closed 4 years ago

jrtashjian commented 4 years ago

Current linting report:

FILE: functions.php
----------------------------------------------------------------------
FOUND 31 ERRORS AND 48 WARNINGS AFFECTING 76 LINES
----------------------------------------------------------------------
   1 | ERROR   | [ ] There must be no blank lines before the file
     |         |     comment
     |         |     (Squiz.Commenting.FileComment.SpacingAfterOpen)
   9 | ERROR   | [ ] There must be exactly one blank line after the
     |         |     file comment
     |         |     (Squiz.Commenting.FileComment.SpacingAfterComment)
   9 | ERROR   | [ ] Missing @package tag in file comment
     |         |     (Squiz.Commenting.FileComment.MissingPackageTag)
  10 | ERROR   | [ ] Global constants defined by a theme/plugin
     |         |     should start with the theme/plugin prefix.
     |         |     Found: "PRIMER_CHILD_VERSION".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedConstantFound)
  18 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_move_elements".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
  20 | ERROR   | [x] Expected 1 space after comma in argument list;
     |         |     17 found
     |         |     (Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma)
  20 | ERROR   | [x] Expected 1 space after comma in argument list;
     |         |     14 found
     |         |     (Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma)
  21 | ERROR   | [x] Expected 1 space after comma in argument list;
     |         |     11 found
     |         |     (Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma)
  21 | ERROR   | [x] Expected 1 space after comma in argument list; 8
     |         |     found
     |         |     (Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma)
  22 | ERROR   | [x] Expected 1 space after comma in argument list;
     |         |     14 found
     |         |     (Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma)
  42 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_add_mobile_menu".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
  55 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_add_social_menu".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
  72 | ERROR   | [ ] Missing parameter comment
     |         |     (Squiz.Commenting.FunctionComment.MissingParamComment)
  76 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_custom_logo_args".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
  92 | ERROR   | [ ] Missing parameter comment
     |         |     (Squiz.Commenting.FunctionComment.MissingParamComment)
  96 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_layouts".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
 116 | ERROR   | [ ] Missing parameter comment
     |         |     (Squiz.Commenting.FunctionComment.MissingParamComment)
 120 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_fonts".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
 136 | ERROR   | [ ] Missing parameter comment
     |         |     (Squiz.Commenting.FunctionComment.MissingParamComment)
 140 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_font_types".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
 149 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 4 space(s) between "'heading_font'" and
     |         |     double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 152 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 4 space(s) between "'primary_font'" and
     |         |     double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 155 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 2 space(s) between "'secondary_font'"
     |         |     and double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 171 | ERROR   | [ ] Missing parameter comment
     |         |     (Squiz.Commenting.FunctionComment.MissingParamComment)
 175 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_colors".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
 187 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 17 space(s) between
     |         |     "'header_textcolor'" and double arrow, but found
     |         |     1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 190 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 15 space(s) between
     |         |     "'tagline_text_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 193 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 18 space(s) between "'hero_text_color'"
     |         |     and double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 196 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 18 space(s) between "'menu_text_color'"
     |         |     and double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 201 | ERROR   | [x] Array item not aligned correctly; expected 4
     |         |     spaces but found 20
     |         |     (WordPress.Arrays.ArrayIndentation.ItemNotAligned)
 202 | ERROR   | [x] Array closer not aligned correctly; expected 0
     |         |     space(s) but found 16
     |         |     (WordPress.Arrays.ArrayIndentation.CloseBraceNotAligned)
 210 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 15 space(s) between
     |         |     "'heading_text_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 213 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 15 space(s) between
     |         |     "'primary_text_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 216 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 13 space(s) between
     |         |     "'secondary_text_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 222 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 9 space(s) between
     |         |     "'footer_widget_text_color'" and double arrow,
     |         |     but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 225 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 11 space(s) between
     |         |     "'footer_menu_text_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 228 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 16 space(s) between
     |         |     "'footer_text_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 234 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 23 space(s) between "'link_color'" and
     |         |     double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 235 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 1 space(s) between "'default'" and
     |         |     double arrow, but found 2.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 236 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 5 space(s) between "'css'" and double
     |         |     arrow, but found 6.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 242 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 21 space(s) between "'button_color'"
     |         |     and double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 245 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 16 space(s) between
     |         |     "'button_text_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 246 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 1 space(s) between "'default'" and
     |         |     double arrow, but found 2.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 247 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 5 space(s) between "'css'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 256 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 17 space(s) between
     |         |     "'background_color'" and double arrow, but found
     |         |     1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 259 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 12 space(s) between
     |         |     "'hero_background_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 262 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 12 space(s) between
     |         |     "'menu_background_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 270 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 3 space(s) between
     |         |     "'footer_widget_background_color'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 273 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 10 space(s) between
     |         |     "'footer_background_color'" and double arrow,
     |         |     but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 289 | ERROR   | [ ] Missing parameter comment
     |         |     (Squiz.Commenting.FunctionComment.MissingParamComment)
 293 | ERROR   | [ ] Functions declared in the global namespace by a
     |         |     theme/plugin should start with the theme/plugin
     |         |     prefix. Found: "escapade_color_schemes".
     |         |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound)
 298 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 5 space(s) between "'blush'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 304 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 4 space(s) between "'bronze'" and
     |         |     double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 310 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 4 space(s) between "'canary'" and
     |         |     double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 316 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 6 space(s) between "'cool'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 322 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 6 space(s) between "'dark'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 324 | ERROR   | [ ] Inline comments must end in full-stops,
     |         |     exclamation marks, or question marks
     |         |     (Squiz.Commenting.InlineComment.InvalidEndChar)
 333 | ERROR   | [ ] Inline comments must end in full-stops,
     |         |     exclamation marks, or question marks
     |         |     (Squiz.Commenting.InlineComment.InvalidEndChar)
 334 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 17 space(s) between
     |         |     "'background_color'" and double arrow, but found
     |         |     15.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 335 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 12 space(s) between
     |         |     "'hero_background_color'" and double arrow, but
     |         |     found 10.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 336 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 12 space(s) between
     |         |     "'menu_background_color'" and double arrow, but
     |         |     found 10.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 337 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 3 space(s) between
     |         |     "'footer_widget_background_color'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 338 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 10 space(s) between
     |         |     "'footer_background_color'" and double arrow,
     |         |     but found 8.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 341 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 5 space(s) between "'muted'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 343 | ERROR   | [ ] Inline comments must end in full-stops,
     |         |     exclamation marks, or question marks
     |         |     (Squiz.Commenting.InlineComment.InvalidEndChar)
 344 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 15 space(s) between
     |         |     "'header_textcolor'" and double arrow, but found
     |         |     7.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 345 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 13 space(s) between
     |         |     "'tagline_text_color'" and double arrow, but
     |         |     found 5.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 346 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 16 space(s) between "'menu_text_color'"
     |         |     and double arrow, but found 8.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 347 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 13 space(s) between
     |         |     "'heading_text_color'" and double arrow, but
     |         |     found 5.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 348 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 13 space(s) between
     |         |     "'primary_text_color'" and double arrow, but
     |         |     found 5.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 349 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 11 space(s) between
     |         |     "'secondary_text_color'" and double arrow, but
     |         |     found 3.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 350 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 9 space(s) between
     |         |     "'footer_menu_text_color'" and double arrow, but
     |         |     found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 351 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 14 space(s) between
     |         |     "'footer_text_color'" and double arrow, but
     |         |     found 6.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 352 | ERROR   | [ ] Inline comments must end in full-stops,
     |         |     exclamation marks, or question marks
     |         |     (Squiz.Commenting.InlineComment.InvalidEndChar)
 353 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 21 space(s) between "'link_color'" and
     |         |     double arrow, but found 3.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 354 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 19 space(s) between "'button_color'"
     |         |     and double arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 355 | ERROR   | [ ] Inline comments must end in full-stops,
     |         |     exclamation marks, or question marks
     |         |     (Squiz.Commenting.InlineComment.InvalidEndChar)
 363 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 6 space(s) between "'plum'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
 369 | WARNING | [x] Array double arrow not aligned correctly;
     |         |     expected 6 space(s) between "'rose'" and double
     |         |     arrow, but found 1.
     |         |     (WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 55 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

FILE: header.php
----------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
----------------------------------------------------------------------
 10 | ERROR | [ ] There must be exactly one blank line after the file
    |       |     comment
    |       |     (Squiz.Commenting.FileComment.SpacingAfterComment)
 31 | ERROR | [ ] Hook names invoked by a theme/plugin should start
    |       |     with the theme/plugin prefix. Found:
    |       |     "primer_body_inside".
    |       |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound)
 33 | ERROR | [ ] All output should be run through an escaping
    |       |     function (like esc_html_e() or esc_attr_e()), found
    |       |     '_e'.
    |       |     (WordPress.Security.EscapeOutput.UnsafePrintingFunction)
 35 | ERROR | [ ] Hook names invoked by a theme/plugin should start
    |       |     with the theme/plugin prefix. Found:
    |       |     "primer_before_header".
    |       |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound)
 37 | ERROR | [x] Newline required after opening brace
    |       |     (Squiz.ControlStructures.ControlSignature.NewlineAfterOpenBrace)
 39 | ERROR | [ ] Hook names invoked by a theme/plugin should start
    |       |     with the theme/plugin prefix. Found:
    |       |     "primer_pre_hero".
    |       |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound)
 43 | ERROR | [ ] Hook names invoked by a theme/plugin should start
    |       |     with the theme/plugin prefix. Found:
    |       |     "primer_header".
    |       |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound)
 45 | ERROR | [ ] Hook names invoked by a theme/plugin should start
    |       |     with the theme/plugin prefix. Found:
    |       |     "primer_after_header".
    |       |     (WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------