As of Drupal 8 all JS needs to follow our JavaScript coding standards. For this we use ESLint to check most of our standards.
Here is the summary of running ESLint on this module JS:
✖ 6 problems (6 errors, 0 warnings)

Attached is the full list of errors found by ESLint.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

rteijeiro’s picture

FileSize
36.87 KB

Sorry, forgot a few files. There is still a rule remaining. Not sure if we can remove the console.log statement:

admin_devel/admin_devel.js
  36:8  error  Unexpected console statement  no-console

✖ 1 problem (1 error, 0 warnings)

The last submitted patch, fix-eslint-errors.patch, failed testing.

Grimreaper’s picture

Hello,

Thanks for the patch. I also wander how we can handle the console.log, as it is for debug purpose maybe we can leave it.

I add warnings for missing @param and @returns

modules/admin_menu/admin_devel/admin_devel.js
  36:8  error  Unexpected console statement  no-console

modules/admin_menu/admin_menu.js
  114:2  warning  Missing JSDoc parameter type for 'hash'              valid-jsdoc
  114:2  warning  Missing JSDoc parameter type for 'onSuccess'         valid-jsdoc
  114:2  warning  Expected JSDoc for 'settings' but found 'onSuccess'  valid-jsdoc
  114:2  warning  Missing JSDoc @returns for function                  valid-jsdoc
  148:2  warning  Missing JSDoc @returns for function                  valid-jsdoc
  169:2  warning  Missing JSDoc for parameter 'context'                valid-jsdoc
  169:2  warning  Missing JSDoc for parameter '$adminMenu'             valid-jsdoc
  169:2  warning  Missing JSDoc for parameter 'settings'               valid-jsdoc
  181:2  warning  Missing JSDoc for parameter 'settings'               valid-jsdoc
  181:2  warning  Missing JSDoc for parameter '$adminMenu'             valid-jsdoc
  181:2  warning  Missing JSDoc for parameter 'context'                valid-jsdoc
  191:2  warning  Missing JSDoc for parameter 'settings'               valid-jsdoc
  191:2  warning  Missing JSDoc for parameter '$adminMenu'             valid-jsdoc
  191:2  warning  Missing JSDoc for parameter 'context'                valid-jsdoc
  206:2  warning  Missing JSDoc for parameter 'context'                valid-jsdoc
  206:2  warning  Missing JSDoc for parameter 'settings'               valid-jsdoc
  206:2  warning  Missing JSDoc for parameter '$adminMenu'             valid-jsdoc
  217:2  warning  Missing JSDoc for parameter 'context'                valid-jsdoc
  217:2  warning  Missing JSDoc for parameter 'settings'               valid-jsdoc
  217:2  warning  Missing JSDoc for parameter '$adminMenu'             valid-jsdoc
  228:2  warning  Missing JSDoc for parameter 'context'                valid-jsdoc
  228:2  warning  Missing JSDoc for parameter '$adminMenu'             valid-jsdoc
  228:2  warning  Missing JSDoc for parameter 'settings'               valid-jsdoc
  256:2  warning  Missing JSDoc for parameter 'settings'               valid-jsdoc
  256:2  warning  Missing JSDoc for parameter 'context'                valid-jsdoc
  256:2  warning  Missing JSDoc for parameter '$adminMenu'             valid-jsdoc
  301:4  warning  Missing JSDoc @returns for function                  valid-jsdoc
  301:4  warning  Missing JSDoc for parameter '$links'                 valid-jsdoc
  320:4  warning  Missing JSDoc for parameter 'needle'                 valid-jsdoc
  320:4  warning  Missing JSDoc @returns for function                  valid-jsdoc
  320:4  warning  Missing JSDoc for parameter 'links'                  valid-jsdoc
  331:4  warning  Missing JSDoc for parameter 'matches'                valid-jsdoc
  331:4  warning  Missing JSDoc @returns for function                  valid-jsdoc
  354:4  warning  Missing JSDoc for parameter 'e'                      valid-jsdoc                                                                                                                                                                                             
  363:4  warning  Missing JSDoc for parameter 'e'                      valid-jsdoc                                                                                                                                                                                             
  363:4  warning  Missing JSDoc for parameter 'link'                   valid-jsdoc                                                                                                                                                                                             
  372:4  warning  Missing JSDoc for parameter 'e'                      valid-jsdoc                                                                                                                                                                                             
  372:4  warning  Missing JSDoc for parameter 'link'                   valid-jsdoc                                                                                                                                                                                             
                                                                                                                                                                                                                                                                               
modules/admin_menu/admin_menu_toolbar/admin_menu_toolbar.js                                                                                                                                                                                                                    
  13:2  warning  Missing JSDoc for parameter 'context'     valid-jsdoc                                                                                                                                                                                                         
  13:2  warning  Missing JSDoc for parameter 'settings'    valid-jsdoc                                                                                                                                                                                                         
  13:2  warning  Missing JSDoc for parameter '$adminMenu'  valid-jsdoc                                                                                                                                                                                                         
  24:2  warning  Missing JSDoc for parameter 'context'     valid-jsdoc                                                                                                                                                                                                         
  24:2  warning  Missing JSDoc for parameter 'settings'    valid-jsdoc                                                                                                                                                                                                         
  24:2  warning  Missing JSDoc for parameter '$adminMenu'  valid-jsdoc                                                                                                                                                                                                         
                                                                                                                                                                                                                                                                               
✖ 45 problems (1 error, 44 warnings)   

I fixed them in my patch. But I wonder if I am right in the type and description.

Thanks for the review.

HongPong’s picture

Title: Administration Menu ESLint errors » Administration Menu Javascript ESLint errors
thalles’s picture

Category: Task » Support request
Issue tags: -JavaScript +JavaScript

This module has been deprecated for Drupal 8.
For Drupal 8: the Admin Toolbar provides an experience similar to admin_menu with the core toolbar.

thalles’s picture

Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.