Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable valid-jsdoc eslint rule #2928

Merged
merged 1 commit into from
Aug 10, 2023
Merged

Enable valid-jsdoc eslint rule #2928

merged 1 commit into from
Aug 10, 2023

Conversation

qwerty541
Copy link
Collaborator

Related to #2913 #2920 #2923 #2924

@qwerty541 qwerty541 requested a review from rickstaa July 10, 2023 16:33
@vercel
Copy link

vercel bot commented Jul 10, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
github-readme-stats ✅ Ready (Inspect) Visit Preview Aug 10, 2023 8:14am

@codecov
Copy link

codecov bot commented Jul 10, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (c04dd42) 97.65% compared to head (c3983f9) 97.65%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #2928   +/-   ##
=======================================
  Coverage   97.65%   97.65%           
=======================================
  Files          24       24           
  Lines        5341     5341           
  Branches      465      465           
=======================================
  Hits         5216     5216           
  Misses        124      124           
  Partials        1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rickstaa
Copy link
Collaborator

I like this rule since it improves maintainability. However, I think we should merge it after all errors are fixed:

/home/ricks/development/personal/github-readme-stats/api/status/pat-info.js
   11:1  error  JSDoc syntax error                       valid-jsdoc
   39:1  error  Missing JSDoc @returns for function      valid-jsdoc
   39:1  error  Missing JSDoc for parameter 'fetcher'    valid-jsdoc
   39:1  error  Missing JSDoc for parameter 'variables'  valid-jsdoc
  118:1  error  Missing JSDoc @returns for function      valid-jsdoc
  118:1  error  Missing JSDoc for parameter '_'          valid-jsdoc
  118:1  error  Missing JSDoc for parameter 'res'        valid-jsdoc

/home/ricks/development/personal/github-readme-stats/api/status/up.js
  13:1  error  JSDoc syntax error                   valid-jsdoc
  37:1  error  Missing JSDoc return type            valid-jsdoc
  60:1  error  Missing JSDoc @returns for function  valid-jsdoc
  60:1  error  Missing JSDoc for parameter 'req'    valid-jsdoc
  60:1  error  Missing JSDoc for parameter 'res'    valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/repo-card.js
  82:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/stats-card.js
  23:1  error  JSDoc type missing brace  valid-jsdoc
  77:1  error  JSDoc syntax error        valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/top-languages-card.js
   45:1  error    Missing JSDoc return type    valid-jsdoc
   53:1  error    Missing JSDoc return type    valid-jsdoc
  395:9  warning  Expected property shorthand  object-shorthand
  664:1  error    JSDoc syntax error           valid-jsdoc
  681:1  error    JSDoc syntax error           valid-jsdoc
  703:1  error    JSDoc syntax error           valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/wakatime-card.js
   31:4   error    Use @returns instead                   valid-jsdoc
   39:1   error    JSDoc syntax error                     valid-jsdoc
   48:40  warning  'totalSize' is defined but never used  no-unused-vars
   61:1   error    JSDoc syntax error                     valid-jsdoc
   70:53  warning  'x' is defined but never used          no-unused-vars
   89:1   error    Missing JSDoc @returns for function    valid-jsdoc
  141:1   error    JSDoc syntax error                     valid-jsdoc
  159:1   error    JSDoc syntax error                     valid-jsdoc
  301:15  warning  Expected property shorthand            object-shorthand

/home/ricks/development/personal/github-readme-stats/src/common/Card.js
   61:3  error  Missing JSDoc @returns for function              valid-jsdoc
   62:6  error  Missing JSDoc parameter description for 'prop'   valid-jsdoc
   69:3  error  Missing JSDoc @returns for function              valid-jsdoc
   70:6  error  Missing JSDoc parameter description for 'value'  valid-jsdoc
   76:3  error  Missing JSDoc @returns for function              valid-jsdoc
   77:6  error  Missing JSDoc parameter description for 'value'  valid-jsdoc
   83:3  error  Missing JSDoc @returns for function              valid-jsdoc
   84:6  error  Missing JSDoc parameter description for 'value'  valid-jsdoc
   93:3  error  Missing JSDoc @returns for function              valid-jsdoc
   94:6  error  Missing JSDoc parameter description for 'text'   valid-jsdoc
  158:3  error  Missing JSDoc @returns for function              valid-jsdoc
  159:6  error  Missing JSDoc parameter description for 'body'   valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/common/retryer.js
   9:1  error  Missing JSDoc return type                               valid-jsdoc
   9:1  error  Missing JSDoc for parameter 'variables'                 valid-jsdoc
   9:1  error  Missing JSDoc for parameter 'retries'                   valid-jsdoc
  12:4  error  Expected JSDoc for 'fetcher' but found 'retryerParams'  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/common/utils.js
  325:20  error  Parsing error: Unexpected token =

/home/ricks/development/personal/github-readme-stats/src/fetchers/repo-fetcher.js
   5:1  error  JSDoc syntax error  valid-jsdoc
  56:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/stats-fetcher.js
   77:1  error  JSDoc syntax error  valid-jsdoc
   97:1  error  JSDoc syntax error  valid-jsdoc
  178:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/top-languages-fetcher.js
  11:1  error  JSDoc syntax error  valid-jsdoc
  50:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/wakatime-fetcher.js
  3:10  warning  'I18n' is defined but never used  no-unused-vars

qwerty541
qwerty541 commented Jul 11, 2023
View reviewed changes
Copy link
Collaborator Author

@qwerty541 qwerty541 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this rule since it improves maintainability. However, I think we should merge it after all errors are fixed:

/home/ricks/development/personal/github-readme-stats/api/status/pat-info.js
   11:1  error  JSDoc syntax error                       valid-jsdoc
   39:1  error  Missing JSDoc @returns for function      valid-jsdoc
   39:1  error  Missing JSDoc for parameter 'fetcher'    valid-jsdoc
   39:1  error  Missing JSDoc for parameter 'variables'  valid-jsdoc
  118:1  error  Missing JSDoc @returns for function      valid-jsdoc
  118:1  error  Missing JSDoc for parameter '_'          valid-jsdoc
  118:1  error  Missing JSDoc for parameter 'res'        valid-jsdoc

/home/ricks/development/personal/github-readme-stats/api/status/up.js
  13:1  error  JSDoc syntax error                   valid-jsdoc
  37:1  error  Missing JSDoc return type            valid-jsdoc
  60:1  error  Missing JSDoc @returns for function  valid-jsdoc
  60:1  error  Missing JSDoc for parameter 'req'    valid-jsdoc
  60:1  error  Missing JSDoc for parameter 'res'    valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/repo-card.js
  82:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/stats-card.js
  23:1  error  JSDoc type missing brace  valid-jsdoc
  77:1  error  JSDoc syntax error        valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/top-languages-card.js
   45:1  error    Missing JSDoc return type    valid-jsdoc
   53:1  error    Missing JSDoc return type    valid-jsdoc
  395:9  warning  Expected property shorthand  object-shorthand
  664:1  error    JSDoc syntax error           valid-jsdoc
  681:1  error    JSDoc syntax error           valid-jsdoc
  703:1  error    JSDoc syntax error           valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/wakatime-card.js
   31:4   error    Use @returns instead                   valid-jsdoc
   39:1   error    JSDoc syntax error                     valid-jsdoc
   48:40  warning  'totalSize' is defined but never used  no-unused-vars
   61:1   error    JSDoc syntax error                     valid-jsdoc
   70:53  warning  'x' is defined but never used          no-unused-vars
   89:1   error    Missing JSDoc @returns for function    valid-jsdoc
  141:1   error    JSDoc syntax error                     valid-jsdoc
  159:1   error    JSDoc syntax error                     valid-jsdoc
  301:15  warning  Expected property shorthand            object-shorthand

/home/ricks/development/personal/github-readme-stats/src/common/Card.js
   61:3  error  Missing JSDoc @returns for function              valid-jsdoc
   62:6  error  Missing JSDoc parameter description for 'prop'   valid-jsdoc
   69:3  error  Missing JSDoc @returns for function              valid-jsdoc
   70:6  error  Missing JSDoc parameter description for 'value'  valid-jsdoc
   76:3  error  Missing JSDoc @returns for function              valid-jsdoc
   77:6  error  Missing JSDoc parameter description for 'value'  valid-jsdoc
   83:3  error  Missing JSDoc @returns for function              valid-jsdoc
   84:6  error  Missing JSDoc parameter description for 'value'  valid-jsdoc
   93:3  error  Missing JSDoc @returns for function              valid-jsdoc
   94:6  error  Missing JSDoc parameter description for 'text'   valid-jsdoc
  158:3  error  Missing JSDoc @returns for function              valid-jsdoc
  159:6  error  Missing JSDoc parameter description for 'body'   valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/common/retryer.js
   9:1  error  Missing JSDoc return type                               valid-jsdoc
   9:1  error  Missing JSDoc for parameter 'variables'                 valid-jsdoc
   9:1  error  Missing JSDoc for parameter 'retries'                   valid-jsdoc
  12:4  error  Expected JSDoc for 'fetcher' but found 'retryerParams'  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/common/utils.js
  325:20  error  Parsing error: Unexpected token =

/home/ricks/development/personal/github-readme-stats/src/fetchers/repo-fetcher.js
   5:1  error  JSDoc syntax error  valid-jsdoc
  56:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/stats-fetcher.js
   77:1  error  JSDoc syntax error  valid-jsdoc
   97:1  error  JSDoc syntax error  valid-jsdoc
  178:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/top-languages-fetcher.js
  11:1  error  JSDoc syntax error  valid-jsdoc
  50:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/wakatime-fetcher.js
  3:10  warning  'I18n' is defined but never used  no-unused-vars

изображение

@rickstaa I have opened this pull request after running npm run lint and seeing no errors and warnings. You can check on screenshot. Also you can check eslint output on GitHub Actions https://github.com/anuraghazra/github-readme-stats/actions/runs/5510580836/jobs/10044991453?pr=2928. If there was some errors and warnings test workflow should fail. I should ask you how you managed to receive this output?

@qwerty541
Copy link
Collaborator Author

Oh i understand the problem. Out lint command should run:

npx eslint --max-warnings 0 "./src/**/*.js" "./scripts/**/*.js" "./tests/**/*.js" "./api/**/*.js" "./themes/**/*.js"

Instead of:

npx eslint --max-warnings 0 "./src/**.js" "./scripts/**.js" "./tests/**.js" "./api/**.js" "./themes/**.js"

@qwerty541
Copy link
Collaborator Author

qwerty541 commented Jul 11, 2023 •
edited
Loading

@rickstaa I have opened #2932 pull request to fix this problem. And #2930 & #2931 which should be merged before. Please check it.

@qwerty541 qwerty541 mentioned this pull request Jul 11, 2023
Merged
@rickstaa rickstaa force-pushed the eslint_enable_valid_jsdoc_rule branch from 8c8b806 to a5834c1 Compare July 19, 2023 08:08
@rickstaa
Copy link
Collaborator

@qwerty541, thanks for tackling the linting errors 🚀. There now are fewer. However, I think all should be fixed before we merge this 🤔.

/home/ricks/development/personal/github-readme-stats/api/status/pat-info.js
   11:1  error  JSDoc syntax error                       valid-jsdoc
   39:1  error  Missing JSDoc @returns for function      valid-jsdoc
   39:1  error  Missing JSDoc for parameter 'fetcher'    valid-jsdoc
   39:1  error  Missing JSDoc for parameter 'variables'  valid-jsdoc
  118:1  error  Missing JSDoc @returns for function      valid-jsdoc
  118:1  error  Missing JSDoc for parameter '_'          valid-jsdoc
  118:1  error  Missing JSDoc for parameter 'res'        valid-jsdoc

/home/ricks/development/personal/github-readme-stats/api/status/up.js
  13:1  error  JSDoc syntax error                   valid-jsdoc
  37:1  error  Missing JSDoc return type            valid-jsdoc
  60:1  error  Missing JSDoc @returns for function  valid-jsdoc
  60:1  error  Missing JSDoc for parameter 'req'    valid-jsdoc
  60:1  error  Missing JSDoc for parameter 'res'    valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/repo-card.js
  82:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/stats-card.js
  77:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/top-languages-card.js
   45:1  error  Missing JSDoc return type  valid-jsdoc
   53:1  error  Missing JSDoc return type  valid-jsdoc
  664:1  error  JSDoc syntax error         valid-jsdoc
  681:1  error  JSDoc syntax error         valid-jsdoc
  703:1  error  JSDoc syntax error         valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/cards/wakatime-card.js
   39:1  error  JSDoc syntax error                   valid-jsdoc
   60:1  error  JSDoc syntax error                   valid-jsdoc
   84:1  error  Missing JSDoc @returns for function  valid-jsdoc
  136:1  error  JSDoc syntax error                   valid-jsdoc
  154:1  error  JSDoc syntax error                   valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/common/utils.js
  152:1  error  JSDoc syntax error                                          valid-jsdoc
  169:1  error  JSDoc syntax error                                          valid-jsdoc
  194:1  error  JSDoc syntax error                                          valid-jsdoc
  344:6  error  Missing JSDoc parameter description for 'missedParams'      valid-jsdoc
  345:6  error  Missing JSDoc parameter description for 'secondaryMessage'  valid-jsdoc
  399:1  error  Missing JSDoc @returns for function                         valid-jsdoc
  399:5  error  Missing JSDoc parameter description for 'name'              valid-jsdoc
  437:1  error  Missing JSDoc return description                            valid-jsdoc
  439:4  error  Missing JSDoc parameter description for 'd1'                valid-jsdoc
  440:4  error  Missing JSDoc parameter description for 'd2'                valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/repo-fetcher.js
   5:1  error  JSDoc syntax error  valid-jsdoc
  56:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/stats-fetcher.js
   77:1  error  JSDoc syntax error  valid-jsdoc
   97:1  error  JSDoc syntax error  valid-jsdoc
  178:1  error  JSDoc syntax error  valid-jsdoc

/home/ricks/development/personal/github-readme-stats/src/fetchers/top-languages-fetcher.js
  11:1  error  JSDoc syntax error  valid-jsdoc
  50:1  error  JSDoc syntax error  valid-jsdoc

✖ 41 problems (41 errors, 0 warnings)

@qwerty541 qwerty541 mentioned this pull request Aug 10, 2023
Merged
@qwerty541 qwerty541 force-pushed the eslint_enable_valid_jsdoc_rule branch from a5834c1 to 9f2f2de Compare August 10, 2023 02:46
@rickstaa rickstaa force-pushed the eslint_enable_valid_jsdoc_rule branch from 9f2f2de to c3983f9 Compare August 10, 2023 08:14
@rickstaa rickstaa merged commit c394ea3 into master Aug 10, 2023
@rickstaa rickstaa deleted the eslint_enable_valid_jsdoc_rule branch August 10, 2023 08:16
devantler pushed a commit to devantler/github-readme-stats that referenced this pull request Sep 24, 2023
@qwerty541 @devantler
Enable valid-jsdoc eslint rule (anuraghazra#2928)
1fb73b4
ABA2396 pushed a commit to ABA2396/github-readme-stats that referenced this pull request Dec 22, 2023
@qwerty541
Enable valid-jsdoc eslint rule (anuraghazra#2928)
39d6af2
ABA2396 pushed a commit to ABA2396/github-readme-stats that referenced this pull request Dec 22, 2023
@qwerty541
Enable valid-jsdoc eslint rule (anuraghazra#2928)
83de040
setdebarr pushed a commit to setdebarr/github-readme-stats that referenced this pull request Jan 12, 2024
@qwerty541 @setdebarr
Enable valid-jsdoc eslint rule (anuraghazra#2928)
0dd3ce6
jacobbexten pushed a commit to jacobbexten/github-readme-stats that referenced this pull request Nov 6, 2024
@qwerty541 @jacobbexten
Enable valid-jsdoc eslint rule (anuraghazra#2928)
26f8f9b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rickstaa rickstaa rickstaa approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@qwerty541 @rickstaa