search

shabados / presenter

Desktop app for presenting the Shabad OS Database on projectors, TVs, and live streams
https://shabados.com
MIT License
19 stars 15 forks source link

style(frontend): shorten max line length of destructured properties in Search #584

Closed saihaj closed 4 years ago

saihaj commented 4 years ago

Summary of PR

Fixes ESLint errors that are causing build to fail.

Tests for unexpected behavior

npm run lint:frontend no errors are thrown only warnings

See Log 
> @shabados/desktop@0.0.1 lint /Users/saihaj/Desktop/shabad-os/desktop
>
> @shabados/desktop@0.0.1 lint:frontend /Users/saihaj/Desktop/shabad-os/desktop
> cd app/frontend && npm run lint
>
>
> @shabados/frontend@0.1.0 lint /Users/saihaj/Desktop/shabad-os/desktop/app/frontend
> eslint .

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Controller/Navigator.js
   39:1  warning  @param "id" does not match an existing function parameter  jsdoc/check-param-names
   39:1  warning  Missing JSDoc @returns declaration                         jsdoc/require-returns
   41:0  warning  Missing JSDoc @param "gurmukhi" type                       jsdoc/require-param-type
   42:0  warning  Missing JSDoc @param "id" type                             jsdoc/require-param-type
   43:0  warning  Missing JSDoc @param "index" type                          jsdoc/require-param-type
  105:1  warning  Missing JSDoc @returns declaration                         jsdoc/require-returns
  196:1  warning  Missing JSDoc @returns declaration                         jsdoc/require-returns

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Controller/Search.js
   90:1  warning  Expected @param names to be "gurmukhi". Got "value, input, mode"  jsdoc/check-param-names
   90:1  warning  Missing JSDoc @returns declaration                                jsdoc/require-returns
   92:0  warning  Missing JSDoc @param "value" type                                 jsdoc/require-param-type
   93:0  warning  Missing JSDoc @param "input" type                                 jsdoc/require-param-type
   94:0  warning  Missing JSDoc @param "mode" type                                  jsdoc/require-param-type
  109:1  warning  Missing JSDoc @returns declaration                                jsdoc/require-returns
  191:3  warning  @param "typeId" does not match an existing function parameter     jsdoc/check-param-names
  191:3  warning  Missing JSDoc @returns declaration                                jsdoc/require-returns
  194:0  warning  The type 'int' is undefined                                       jsdoc/no-undefined-types
  197:0  warning  The type 'Component' is undefined                                 jsdoc/no-undefined-types
  198:0  warning  The type 'int' is undefined                                       jsdoc/no-undefined-types
  200:0  warning  The type 'int' is undefined                                       jsdoc/no-undefined-types

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Controller/ToolbarButton.js
  7:1  warning  @param "icon" does not match an existing function parameter  jsdoc/check-param-names

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Controller/index.js
   48:1  warning  @param "onHover" does not match an existing function parameter        jsdoc/check-param-names
   48:1  warning  Missing JSDoc @returns declaration                                    jsdoc/require-returns
   50:0  warning  Missing JSDoc @param "title" type                                     jsdoc/require-param-type
   51:0  warning  Missing JSDoc @param "onHover" type                                   jsdoc/require-param-type
  128:1  warning  @param "renderContent" does not match an existing function parameter  jsdoc/check-param-names
  128:1  warning  Missing JSDoc @returns declaration                                    jsdoc/require-returns
  130:0  warning  Missing JSDoc @param "history" type                                   jsdoc/require-param-type
  131:0  warning  Missing JSDoc @param "renderContent" type                             jsdoc/require-param-type
  132:0  warning  Missing JSDoc @param "location" type                                  jsdoc/require-param-type
  133:0  warning  Missing JSDoc @param "onHover" type                                   jsdoc/require-param-type
  192:1  warning  Missing JSDoc @returns declaration                                    jsdoc/require-returns

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Overlay/Line.js
  13:1  warning  @param "gurmukhi" does not match an existing function parameter  jsdoc/check-param-names
  13:1  warning  Missing JSDoc @returns declaration                               jsdoc/require-returns

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Overlay/ThemeLoader.js
  9:0  warning  Missing JSDoc @param "name" type  jsdoc/require-param-type

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Presenter/Display.js
  14:1  warning  @param "lineId" does not match an existing function parameter  jsdoc/check-param-names
  14:1  warning  Missing JSDoc @returns declaration                             jsdoc/require-returns
  17:0  warning  Missing JSDoc @param "shabad" type                             jsdoc/require-param-type
  18:0  warning  Missing JSDoc @param "lineId" type                             jsdoc/require-param-type

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Presenter/Line.js
  15:1  warning  @param "gurmukhi" does not match an existing function parameter  jsdoc/check-param-names
  15:1  warning  Missing JSDoc @returns declaration                               jsdoc/require-returns

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Presenter/index.js
   74:0  warning  Missing JSDoc @param "params" type    jsdoc/require-param-type
   83:0  warning  Missing JSDoc @param "pathname" type  jsdoc/require-param-type
  105:0  warning  Missing JSDoc @param "query" type     jsdoc/require-param-type
  128:0  warning  Missing JSDoc @param "events" type    jsdoc/require-param-type

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Settings/Hotkeys.js
  15:1  warning  @param "shortcuts" does not match an existing function parameter  jsdoc/check-param-names
  15:1  warning  Missing JSDoc @returns declaration                                jsdoc/require-returns

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/Settings/Sources.js
  24:1  warning  Missing JSDoc @returns declaration  jsdoc/require-returns

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/lib/analytics.js
  15:3  warning  Missing JSDoc @returns declaration  jsdoc/require-returns
  30:5  warning  Unexpected console statement        no-console
  35:5  warning  Unexpected console statement        no-console

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/lib/controller.js
   38:0  warning  Missing JSDoc @param "event" type                              jsdoc/require-param-type
   39:0  warning  Missing JSDoc @param "payload" type                            jsdoc/require-param-type
   53:5  warning  Unexpected console statement                                   no-console
   85:5  warning  Unexpected console statement                                   no-console
   91:0  warning  Missing JSDoc @param "data" type                               jsdoc/require-param-type
  105:0  warning  Missing JSDoc @param "query" type                              jsdoc/require-param-type
  106:0  warning  Missing JSDoc @param "type" type                               jsdoc/require-param-type
  107:0  warning  Missing JSDoc @param "options" type                            jsdoc/require-param-type
  113:0  warning  Missing JSDoc @param "lineId" type                             jsdoc/require-param-type
  119:0  warning  Missing JSDoc @param "lineId" type                             jsdoc/require-param-type
  125:3  warning  @param "lineId" does not match an existing function parameter  jsdoc/check-param-names
  127:0  warning  Missing JSDoc @param "shabadId" type                           jsdoc/require-param-type
  128:0  warning  Missing JSDoc @param "lineId" type                             jsdoc/require-param-type
  205:0  warning  Missing JSDoc @param "baniId" type                             jsdoc/require-param-type
  209:3  warning  Missing JSDoc @returns declaration                             jsdoc/require-returns
  217:7  warning  Unexpected console statement                                   no-console
  231:0  warning  Missing JSDoc @param "changed" type                            jsdoc/require-param-type
  232:0  warning  Missing JSDoc @param "host" type                               jsdoc/require-param-type

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/lib/utils.js
   27:1  warning  Present JSDoc @returns declaration but not available return expression in function  jsdoc/require-returns
   44:0  warning  Missing JSDoc @param "line" type                                                    jsdoc/require-param-type
   48:1  warning  Missing JSDoc @returns declaration                                                  jsdoc/require-returns
   50:0  warning  Missing JSDoc @param "word" type                                                    jsdoc/require-param-type
   51:0  warning  Missing JSDoc @param "strip" type                                                   jsdoc/require-param-type
   64:0  warning  Missing JSDoc @param "line" type                                                    jsdoc/require-param-type
   65:0  warning  Missing JSDoc @param "strip" type                                                   jsdoc/require-param-type
   69:1  warning  Missing JSDoc @returns declaration                                                  jsdoc/require-returns
   71:0  warning  Missing JSDoc @param "line" type                                                    jsdoc/require-param-type
   72:0  warning  Missing JSDoc @param "strip" type                                                   jsdoc/require-param-type
  100:0  warning  Missing JSDoc @param "search" type                                                  jsdoc/require-param-type
  114:1  warning  @param "line" does not match an existing function parameter                         jsdoc/check-param-names
  114:1  warning  Missing JSDoc @returns declaration                                                  jsdoc/require-returns
  139:1  warning  Missing JSDoc @returns declaration                                                  jsdoc/require-returns
  323:1  warning  Missing JSDoc @returns declaration                                                  jsdoc/require-returns

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/shared/NavigationHotkeys.js
   17:1  warning  @param "lineKeys" does not match an existing function parameter  jsdoc/check-param-names
   97:0  warning  Missing JSDoc @param "name" type                                 jsdoc/require-param-type
   98:0  warning  Missing JSDoc @param "click" type                                jsdoc/require-param-type
  107:0  warning  Missing JSDoc @param "focusedIndex" type                         jsdoc/require-param-type
  108:0  warning  Missing JSDoc @param "click" type                                jsdoc/require-param-type
  128:7  warning  Missing JSDoc @returns declaration                               jsdoc/require-returns
  142:7  warning  Missing JSDoc @returns declaration                               jsdoc/require-returns
  158:0  warning  Missing JSDoc @param "name" type                                 jsdoc/require-param-type
  159:0  warning  Missing JSDoc @param "ref" type                                  jsdoc/require-param-type

/Users/saihaj/Desktop/shabad-os/desktop/app/frontend/src/shared/NavigatorHotkeys.js
   12:1  warning  Missing JSDoc @returns declaration  jsdoc/require-returns
  103:0  warning  Missing JSDoc @param "events" type  jsdoc/require-param-type

✖ 94 problems (0 errors, 94 warnings)

Time spent on PR

5 mins

Reviewers

@Harjot1Singh