📝 Added eslint-plugin-jsdoc and fixed errors #133

arimgibson · 2022-05-26T08:06:05Z

Closes #132

Added eslint-plugin-jsdoc
Configured eslint to use plugin
Changed plugin rules as needed
Fixed warnings thrown by plugin

vercel · 2022-05-26T08:06:08Z

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

Name	Status	Preview	Updated
essential-eth	✅ Ready (Inspect)	Visit Preview	May 27, 2022 at 8:39PM (UTC)

This reverts h changed files that shouldn't have been changed.

codecov · 2022-05-26T12:18:00Z

Codecov Report

Merging #133 (3d53420) into master (6126618) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #133      +/-   ##
==========================================
- Coverage   86.19%   86.17%   -0.02%     
==========================================
  Files          38       38              
  Lines         927      926       -1     
  Branches      265      265              
==========================================
- Hits          799      798       -1     
  Misses        113      113              
  Partials       15       15

Impacted Files	Coverage Δ
src/classes/Contract.ts	`100.00% <ø> (ø)`
src/classes/utils/clean-block.ts	`100.00% <ø> (ø)`
src/classes/utils/clean-log.ts	`95.23% <ø> (ø)`
src/classes/utils/clean-transaction-receipt.ts	`86.20% <ø> (ø)`
src/classes/utils/clean-transaction.ts	`100.00% <ø> (ø)`
src/classes/utils/encode-decode-transaction.ts	`93.75% <ø> (ø)`
src/classes/utils/fetchers.ts	`93.33% <ø> (ø)`
src/classes/utils/hex-to-decimal.ts	`100.00% <ø> (ø)`
src/providers/JsonRpcProvider.ts	`100.00% <ø> (ø)`
src/shared/tiny-big/helpers.ts	`97.67% <ø> (ø)`
... and 17 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6126618...3d53420. Read the comment docs.

arimgibson · 2022-05-26T17:38:59Z

@dawsbot I got lost trying to document these last ones because they deal with contracts. Leaving these last ones for you; besides those, I think this is merge ready.

C:\coding\essential-eth\src\classes\Contract.ts
   10:1  warning  Missing JSDoc @param "txnData" description  jsdoc/require-param-description
   11:1  warning  Missing JSDoc @example description          jsdoc/require-example
   35:1  warning  Missing JSDoc @example description          jsdoc/require-example
  101:1  warning  Missing JSDoc @param "object" description   jsdoc/require-param-description
  102:1  warning  Missing JSDoc @param "name" description     jsdoc/require-param-description
  103:1  warning  Missing JSDoc @param "value" description    jsdoc/require-param-description
  104:1  warning  Missing JSDoc @example description          jsdoc/require-example

C:\coding\essential-eth\src\classes\utils\encode-decode-transaction.ts
   30:1  warning  Missing JSDoc @returns declaration                  jsdoc/require-returns
   32:1  warning  Missing JSDoc @param "jsonABIArgument" description  jsdoc/require-param-description
   33:1  warning  Missing JSDoc @param "args" description             jsdoc/require-param-description
   34:1  warning  Missing JSDoc @example description                  jsdoc/require-example
  113:1  warning  Missing JSDoc @returns declaration                  jsdoc/require-returns
  115:1  warning  Missing JSDoc @param "jsonABIArgument" description  jsdoc/require-param-description
  116:1  warning  Missing JSDoc @param "nodeResponse" description     jsdoc/require-param-description
  117:1  warning  Missing JSDoc @example description                  jsdoc/require-example

dawsbot · 2022-05-27T18:40:12Z

src/classes/utils/encode-decode-transaction.ts

+ *
+ * @param jsonABIArgument
+ * @param args
+ * @example


Is this empty "@example" statement intentional? Seems like it was thrown in to skip a warning from the eslint rule, but we do want examples for everything

That'll still throw an error actually (jsdoc/require-example). The empty is added through eslint --fix using the JSDoc plugin

dawsbot · 2022-05-27T18:40:39Z

src/classes/utils/encode-decode-transaction.ts

@@ -15,6 +27,12 @@ function expandType(type: ContractTypes) {
  }
  return type;
 }
+/**
+ *
+ * @param jsonABIArgument


We don't need @param lines like this because TS automatically documents these by the function definition

#133 (comment)

Also added through eslint --fix but still throws warning until the description is added (jsdoc/require-description)

➕ Added eslint-plugin-jsdoc and ran fix

a69b197

arimgibson added dependencies Pull requests that update a dependency file Chore labels May 26, 2022

arimgibson self-assigned this May 26, 2022

arimgibson added 6 commits May 26, 2022 05:36

Revert '➕ Added eslint-plugin-jsdoc and ran fix''

f4c201f

This reverts h changed files that shouldn't have been changed.

🚨 Ran eslint fix

1c29872

🚨 First round of documentation changes

211f878

🚨 cleanBlock

324ca7e

🚨 cleanTransactionReceipt

031dee3

🚨 cleanTransaction

74a39de

vercel bot deployed to Preview May 26, 2022 12:17 View deployment

arimgibson added 5 commits May 26, 2022 06:45

🚨 Next round of documentation

f664a8a

🚨 More documentation

64a4e2d

🚨 More documentation

b076805

🚨 Some of the bytes documentation

3ab9da7

🚨 Finished documenting Bytes functions

5ff5aab

vercel bot deployed to Preview May 26, 2022 17:12 View deployment

🚨 BaseProvider doc update

40e51ca

vercel bot deployed to Preview May 26, 2022 17:38 View deployment

⬇ Rollback eslint-plugin-jsdoc to support Node 12

b5f1594

vercel bot deployed to Preview May 27, 2022 00:17 View deployment

Merge branch 'master' into feature/jsdoc

d5c4441

vercel bot deployed to Preview May 27, 2022 00:20 View deployment

dawsbot requested changes May 27, 2022

View reviewed changes

dawsbot added 2 commits May 27, 2022 13:30

Merge remote-tracking branch 'origin/master' into feature/jsdoc

cf27175

Remove eslint upgrading from pre-commit script

3d53420

dawsbot marked this pull request as ready for review May 27, 2022 20:38

vercel bot deployed to Preview May 27, 2022 20:39 View deployment

dawsbot merged commit 678ceac into master May 27, 2022

dawsbot deleted the feature/jsdoc branch May 27, 2022 20:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📝 Added eslint-plugin-jsdoc and fixed errors #133

📝 Added eslint-plugin-jsdoc and fixed errors #133

arimgibson commented May 26, 2022 •

edited by dawsbot

Loading

vercel bot commented May 26, 2022 •

edited

Loading

codecov bot commented May 26, 2022 •

edited

Loading

arimgibson commented May 26, 2022

dawsbot May 27, 2022 •

edited

Loading

arimgibson May 30, 2022

dawsbot May 27, 2022

arimgibson May 30, 2022

📝 Added eslint-plugin-jsdoc and fixed errors #133

📝 Added eslint-plugin-jsdoc and fixed errors #133

Conversation

arimgibson commented May 26, 2022 • edited by dawsbot Loading

vercel bot commented May 26, 2022 • edited Loading

codecov bot commented May 26, 2022 • edited Loading

Codecov Report

arimgibson commented May 26, 2022

dawsbot May 27, 2022 • edited Loading

Choose a reason for hiding this comment

arimgibson May 30, 2022

Choose a reason for hiding this comment

dawsbot May 27, 2022

Choose a reason for hiding this comment

arimgibson May 30, 2022

Choose a reason for hiding this comment

arimgibson commented May 26, 2022 •

edited by dawsbot

Loading

vercel bot commented May 26, 2022 •

edited

Loading

codecov bot commented May 26, 2022 •

edited

Loading

dawsbot May 27, 2022 •

edited

Loading